Interface IPlaylistCollectionBase
A collection of IPlaylistCollectionItemBases and the properties and methods for using and manipulating them.
Inherited Members
Namespace: StrixMusic.Sdk.BaseModels
Assembly: StrixMusic.Sdk.dll
Syntax
public interface IPlaylistCollectionBase : IPlaylistCollectionItemBase, IPlayableCollectionItem, IPlayableBase, IImageCollectionBase, IUrlCollectionBase, ICollectionBase, ICollectionItemBase
Properties
| Improve this Doc View SourceIsPausePlaylistCollectionAsyncAvailable
If true, PausePlaylistCollectionAsync(CancellationToken) can be used.
Declaration
bool IsPausePlaylistCollectionAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsPlayPlaylistCollectionAsyncAvailable
If true, PlayPlaylistCollectionAsync(CancellationToken) can be used.
Declaration
bool IsPlayPlaylistCollectionAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
TotalPlaylistItemsCount
The total number of available Playlists.
Declaration
int TotalPlaylistItemsCount { get; }
Property Value
Type | Description |
---|---|
int |
Methods
| Improve this Doc View SourceIsAddPlaylistItemAvailableAsync(int, CancellationToken)
Checks if the backend supports adding an IPlaylistCollectionItemBase at a specific index.
Declaration
Task<bool> IsAddPlaylistItemAvailableAsync(int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | index | |
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task<bool> | A Task representing the asynchronous operation. If value is true, a new IPlaylistCollectionItemBase can be added. |
IsRemovePlaylistItemAvailableAsync(int, CancellationToken)
Checks if the backend supports removing an IPlaylistCollectionItemBase at a specific index.
Declaration
Task<bool> IsRemovePlaylistItemAvailableAsync(int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | index | |
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task<bool> | A Task representing the asynchronous operation. If value is true, the IPlaylistCollectionItemBase can be removed. |
PausePlaylistCollectionAsync(CancellationToken)
Attempts to pause the Playlist collection.
Declaration
Task PausePlaylistCollectionAsync(CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
PlayPlaylistCollectionAsync(CancellationToken)
Attempts to play the Playlist collection, or resumes playback if already playing.
Declaration
Task PlayPlaylistCollectionAsync(CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
RemovePlaylistItemAsync(int, CancellationToken)
Removes the playlist from the collection on the backend.
Declaration
Task RemovePlaylistItemAsync(int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | index | The index of the playlist to remove. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
Events
| Improve this Doc View SourceIsPausePlaylistCollectionAsyncAvailableChanged
Raised when IsPausePlaylistCollectionAsyncAvailable changes.
Declaration
event EventHandler<bool>? IsPausePlaylistCollectionAsyncAvailableChanged
Event Type
Type | Description |
---|---|
EventHandler<bool> |
IsPlayPlaylistCollectionAsyncAvailableChanged
Raised when IsPlayPlaylistCollectionAsyncAvailable changes.
Declaration
event EventHandler<bool>? IsPlayPlaylistCollectionAsyncAvailableChanged
Event Type
Type | Description |
---|---|
EventHandler<bool> |
PlaylistItemsCountChanged
Fires when the merged TotalPlaylistItemsCount changes.
Declaration
event EventHandler<int>? PlaylistItemsCountChanged
Event Type
Type | Description |
---|---|
EventHandler<int> |