Interface IAimpPlaylist

Playlist interface. Implements the IAimpPlaylistListener

Inherited Members
Namespace: AIMP.SDK.Playlist
Assembly: AIMP.SDK.dll
Syntax
public interface IAimpPlaylist : IAimpPlaylistListener

Properties

Duration

Gets the total duration, in seconds.

Declaration
double Duration { get; }

FocusedGroup

Gets or sets the focused group.

Declaration
IAimpPlaylistGroup FocusedGroup { get; set; }

FocusedItem

Gets or sets the focused object. Object should be IAimpPlaylistItem or IAimpPlaylistGroup.

Declaration
IAimpPlaylistItem FocusedItem { get; set; }

FocusIndex

Gets or sets the index of focused playlist item. Index can be equals to -1, if no one item is focused. Use the AIMP_PLAYLIST_PROPID_FOCUSED_OBJECT property to access to focused group.

Declaration
int FocusIndex { get; set; }

FormattingLine1Template

Gets or sets the formatting template for the first line.

Changing the value is available only if value of the GroupingOverridden parameter set as true.

Declaration
string FormattingLine1Template { get; set; }

FormattingLine2Template

Gets or sets the formatting template for the second line.

Changing the value is available only if value of the GroupingOverridden parameter set as true.

Declaration
string FormattingLine2Template { get; set; }

FormattingOverride

Gets or sets a value indicating whether [formating override].

Declaration
bool FormattingOverride { get; set; }

Grouping

Gets or sets a value indicating whether this IAimpPlaylist is grouping.

Changing the value is available only if value of the GroupingOverridden parameter set as true.

Declaration
bool Grouping { get; set; }

GroupingAutomerg

Enables the auto merge for grouping.

Changing the value is available only if value of the GroupingOverridden parameter set as true.

Declaration
bool GroupingAutomerg { get; set; }

GroupingOverridden

Gets or sets a value indicating whether [grouping overridden].

Declaration
bool GroupingOverridden { get; set; }

GroupingTemplate

Gets or sets the grouping template.

Changing the value is available only if value of the GroupingOverridden parameter set as true.

Declaration
string GroupingTemplate { get; set; }

Id

Gets the playlist identifier.

Declaration
string Id { get; }

Name

Gets or sets the playlist name.

Declaration
string Name { get; set; }

PlaybackCursor

Gets or sets the playback cursor. Can be equals to -1, if playable item was removed or playlist never played.

Declaration
int PlaybackCursor { get; set; }

PlayingIndex

Gets or sets the index of the playing.

Declaration
int PlayingIndex { get; set; }

PreImage

Gets or sets the preimage factory.

Declaration
IAimpPlaylistPreimage PreImage { get; set; }

ReadOnly

Gets or sets a value indicating playlist is read only..

Declaration
bool ReadOnly { get; set; }

Size

Gets the total size, in bytes.

Declaration
double Size { get; }

ViewAbsoluteNumbers

Gets or sets a value indicating whether [view absolute numbers].

Declaration
bool ViewAbsoluteNumbers { get; set; }

ViewDuration

Gets or sets a value indicating the track duration visibility.

Changing the value is available only if value of the GroupingOverridden parameter set as true.

Declaration
bool ViewDuration { get; set; }

ViewExpandButtons

Gets or sets a value indicating whether [view expand buttons].

Changing the value is available only if value of the GroupingOverridden parameter set as true.

Declaration
bool ViewExpandButtons { get; set; }

ViewMarks

Gets or sets a value indicating the marks visibility.

Changing the value is available only if value of the GroupingOverridden parameter set as true.

Declaration
bool ViewMarks { get; set; }

ViewNumbers

Gets or sets a value indicating the tracks number visibility.

Changing the value is available only if value of the GroupingOverridden parameter set as true.

Declaration
bool ViewNumbers { get; set; }

ViewOverride

Gets or sets a value indicating whether [view override].

Declaration
bool ViewOverride { get; set; }

ViewSecondLine

Gets or sets a value indicating whether [view second line].

Changing the value is available only if value of the GroupingOverridden parameter set as true.

Declaration
bool ViewSecondLine { get; set; }

ViewSwitches

Gets or sets a value indicating whether [view switches].

Changing the value is available only if value of the GroupingOverridden parameter set as true.

Declaration
bool ViewSwitches { get; set; }

Methods

Add(IAimpFileInfo, PlaylistFlags, PlaylistFilePosition)

Adds the specified file by URL.

Declaration
AimpActionResult Add(IAimpFileInfo fileInfo, PlaylistFlags flags, PlaylistFilePosition filePosition)
Parameters
Type Name Description
IAimpFileInfo fileInfo

The file information.
PlaylistFlags flags

The PlaylistFlags.
PlaylistFilePosition filePosition

The file position PlaylistFilePosition.

Add(String, PlaylistFlags, PlaylistFilePosition)

Adds the specified file by URL.

Declaration
AimpActionResult Add(string fileUrl, PlaylistFlags flags, PlaylistFilePosition filePosition)
Parameters
Type Name Description
System.String fileUrl

The file URL.
PlaylistFlags flags

The PlaylistFlags.
PlaylistFilePosition filePosition

The file position PlaylistFilePosition.

AddList(IList<IAimpFileInfo>, PlaylistFlags, PlaylistFilePosition)

Adds the list.

Declaration
AimpActionResult AddList(IList<IAimpFileInfo> fileUrlList, PlaylistFlags flags, PlaylistFilePosition filePosition)
Parameters
Type Name Description
System.Collections.Generic.IList<IAimpFileInfo> fileUrlList

The file URL list.
PlaylistFlags flags

The PlaylistFlags.
PlaylistFilePosition filePosition

The file position PlaylistFilePosition.

AddList(IList<String>, PlaylistFlags, PlaylistFilePosition)

Adds the list.

Declaration
AimpActionResult AddList(IList<string> fileUrlList, PlaylistFlags flags, PlaylistFilePosition filePosition)
Parameters
Type Name Description
System.Collections.Generic.IList<System.String> fileUrlList

The file URL list.
PlaylistFlags flags

The PlaylistFlags.
PlaylistFilePosition filePosition

The file position PlaylistFilePosition.

BeginUpdate()

Method blocks all notifications until EndUpdate is called. This method is recommended to usage if you will change few options of playlist at one time.

Declaration
AimpActionResult BeginUpdate()

Close(PlaylistCloseFlag)

Closes the playlist.

Declaration
AimpActionResult Close(PlaylistCloseFlag closeFlag)
Parameters
Type Name Description
PlaylistCloseFlag closeFlag

The close flag PlaylistCloseFlag.

Delete(IAimpPlaylistItem)

Deletes the specified item.

Declaration
AimpActionResult Delete(IAimpPlaylistItem item)
Parameters
Type Name Description
IAimpPlaylistItem item

The playlist item.

Delete(PlaylistDeleteFlags, Object, Func<IAimpPlaylistItem, Object, Boolean>)

Deletes the specified delete flags.

Declaration
AimpActionResult Delete(PlaylistDeleteFlags deleteFlags, object customFilterData, Func<IAimpPlaylistItem, object, bool> filterFunc)
Parameters
Type Name Description
PlaylistDeleteFlags deleteFlags

The delete flags PlaylistDeleteFlags.
System.Object customFilterData

Some additional data that will be passed to the filter function.
System.Func<IAimpPlaylistItem, System.Object, System.Boolean> filterFunc

The filter function. Should return true to delete item.

Delete(Int32)

Deletes the item by specified index.

Declaration
AimpActionResult Delete(int index)
Parameters
Type Name Description
System.Int32 index

The index.

DeleteAll()

Deletes all items.

Declaration
AimpActionResult DeleteAll()

EndUpdate()

Method unblocks all notifications. Refer to the BeginUpdate.

Declaration
AimpActionResult EndUpdate()

GetFiles(PlaylistGetFilesFlag)

Gets the list of files.

Declaration
AimpActionResult<IList<string>> GetFiles(PlaylistGetFilesFlag filesFlag)
Parameters
Type Name Description
PlaylistGetFilesFlag filesFlag

The files flag.

GetGroup(Int32)

Gets the group.

Declaration
AimpActionResult<IAimpPlaylistGroup> GetGroup(int index)
Parameters
Type Name Description
System.Int32 index

The index.

GetGroupCount()

Gets the group count.

Declaration
int GetGroupCount()

GetItem(Int32)

Gets the item.

Declaration
AimpActionResult<IAimpPlaylistItem> GetItem(int index)
Parameters
Type Name Description
System.Int32 index

The index.

GetItemCount()

Gets the item count.

Declaration
int GetItemCount()

MergeGroup(IAimpPlaylistGroup)

Merges one or all groups with same names.

Declaration
AimpActionResult MergeGroup(IAimpPlaylistGroup playlistGroup)
Parameters
Type Name Description
IAimpPlaylistGroup playlistGroup

Group to merge. All groups will be merged If group is not set (parameter is equals null).

ReloadFromPreimage()

Reloads from preimage.

Declaration
AimpActionResult ReloadFromPreimage()

ReloadInfo(Boolean)

Reloads information about items (running in separate thread).

Declaration
AimpActionResult ReloadInfo(bool fullReload)
Parameters
Type Name Description
System.Boolean fullReload

if set to true [full reload].

Sort(PlaylistSort)

Sorts the playlist by specified sort order.

Declaration
AimpActionResult Sort(PlaylistSort sort)
Parameters
Type Name Description
PlaylistSort sort

The sort.

Sort(Object, Func<IAimpPlaylistItem, IAimpPlaylistItem, Object, PlaylistSortComapreResult>)

Sorts the playlist by the specified compare function.

Declaration
AimpActionResult Sort(object customCompareData, Func<IAimpPlaylistItem, IAimpPlaylistItem, object, PlaylistSortComapreResult> compareFunc)
Parameters
Type Name Description
System.Object customCompareData

The custom data for compare function.
System.Func<IAimpPlaylistItem, IAimpPlaylistItem, System.Object, PlaylistSortComapreResult> compareFunc

The compare function.

Sort(String)

Sorts the playlist items by specified template.

Declaration
AimpActionResult Sort(string template)
Parameters
Type Name Description
System.String template

The template. Refer to IAimpServiceFileInfoFormatter.

See Also