Interface IArtistCollectionBase
A collection of IArtistCollectionItemBases and the properties and methods for using and manipulating them.
Inherited Members
Namespace: StrixMusic.Sdk.BaseModels
Assembly: StrixMusic.Sdk.dll
Syntax
public interface IArtistCollectionBase : IPlayableCollectionBase, IArtistCollectionItemBase, IPlayableCollectionItem, IPlayableBase, IImageCollectionBase, IUrlCollectionBase, ICollectionBase, ICollectionItemBase
Properties
| Improve this Doc View SourceIsPauseArtistCollectionAsyncAvailable
If true, PauseArtistCollectionAsync(CancellationToken) can be used.
Declaration
bool IsPauseArtistCollectionAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsPlayArtistCollectionAsyncAvailable
If true, PlayArtistCollectionAsync(CancellationToken) can be used.
Declaration
bool IsPlayArtistCollectionAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
TotalArtistItemsCount
The total number of available Artists.
Declaration
int TotalArtistItemsCount { get; }
Property Value
Type | Description |
---|---|
int |
Methods
| Improve this Doc View SourceIsAddArtistItemAvailableAsync(int, CancellationToken)
Checks if the backend supports adding an IArtistCollectionItemBase at a specific index.
Declaration
Task<bool> IsAddArtistItemAvailableAsync(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 IArtistCollectionItemBase can be added. |
IsRemoveArtistItemAvailableAsync(int, CancellationToken)
Checks if the backend supports removing an IArtist at a specific index.
Declaration
Task<bool> IsRemoveArtistItemAvailableAsync(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 IArtistCollectionItemBase can be removed. |
PauseArtistCollectionAsync(CancellationToken)
Attempts to pause the Artist collection.
Declaration
Task PauseArtistCollectionAsync(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. |
PlayArtistCollectionAsync(CancellationToken)
Attempts to play the Artist collection, or resumes playback if already playing.
Declaration
Task PlayArtistCollectionAsync(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. |
RemoveArtistItemAsync(int, CancellationToken)
Removes the artist from the collection on the backend.
Declaration
Task RemoveArtistItemAsync(int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | index | The index of the artist 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 SourceArtistItemsCountChanged
Fires when the merged TotalArtistItemsCount changes.
Declaration
event EventHandler<int>? ArtistItemsCountChanged
Event Type
Type | Description |
---|---|
EventHandler<int> |
IsPauseArtistCollectionAsyncAvailableChanged
Raised when IsPauseArtistCollectionAsyncAvailable changes.
Declaration
event EventHandler<bool>? IsPauseArtistCollectionAsyncAvailableChanged
Event Type
Type | Description |
---|---|
EventHandler<bool> |
IsPlayArtistCollectionAsyncAvailableChanged
Raised when IsPlayArtistCollectionAsyncAvailable changes.
Declaration
event EventHandler<bool>? IsPlayArtistCollectionAsyncAvailableChanged
Event Type
Type | Description |
---|---|
EventHandler<bool> |