Interface IPlaylistCollection
A collection of IPlaylistCollectionItems and the properties and methods for using and manipulating them.
Inherited Members
Namespace: StrixMusic.Sdk.AppModels
Assembly: StrixMusic.Sdk.dll
Syntax
public interface IPlaylistCollection : IPlaylistCollectionBase, IPlaylistCollectionItem, IPlaylistCollectionItemBase, IPlayableCollectionItem, ICollectionItemBase, IMerged<ICorePlaylistCollectionItem>, IEquatable<ICorePlaylistCollectionItem>, IPlayable, IPlayableBase, IDownloadable, IImageCollection, IImageCollectionBase, IMerged<ICoreImageCollection>, IEquatable<ICoreImageCollection>, IUrlCollection, IUrlCollectionBase, ICollectionBase, IMerged<ICoreUrlCollection>, IEquatable<ICoreUrlCollection>, IAppModel, IMerged<ICorePlaylistCollection>, IEquatable<ICorePlaylistCollection>, IMerged
Remarks
Instances of this class may contain data merged from one or more sources.
Methods
| Improve this Doc View SourceAddPlaylistItemAsync(IPlaylistCollectionItem, int, CancellationToken)
Adds an IPlaylist or IPlaylistCollection to this playlist collection.
Declaration
Task AddPlaylistItemAsync(IPlaylistCollectionItem playlistItem, int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
IPlaylistCollectionItem | playlistItem | The playlistItem to add. |
int | index | the position to insert the playlistItem at. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
GetPlaylistItemsAsync(int, int, CancellationToken)
Gets a requested number of IPlaylistCollectionItemBases starting at the given offset.
Declaration
IAsyncEnumerable<IPlaylistCollectionItem> GetPlaylistItemsAsync(int limit, int offset, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | limit | The max number of items to return. |
int | offset | Get items starting at this index. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
IAsyncEnumerable<IPlaylistCollectionItem> | The requested range of items. |
PlayPlaylistCollectionAsync(IPlaylistCollectionItem, CancellationToken)
Attempts to play a specific item in the playlistItem collection. Restarts playback if already playing.
Declaration
Task PlayPlaylistCollectionAsync(IPlaylistCollectionItem playlistItem, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
IPlaylistCollectionItem | playlistItem | |
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
Events
| Improve this Doc View SourcePlaylistItemsChanged
Fires when the items in the backend are changed by something external.
Declaration
event CollectionChangedEventHandler<IPlaylistCollectionItem>? PlaylistItemsChanged
Event Type
Type | Description |
---|---|
CollectionChangedEventHandler<IPlaylistCollectionItem> |