Class TrackPluginWrapper
Wraps an instance of ITrack with the provided plugins.
Implements
Inherited Members
Namespace: StrixMusic.Sdk.PluginModels
Assembly: StrixMusic.Sdk.dll
Syntax
public class TrackPluginWrapper : ITrack, ITrackBase, IArtistCollection, IArtistCollectionBase, IPlayableCollectionBase, IArtistCollectionItem, IArtistCollectionItemBase, IPlayableCollectionItem, ICollectionItemBase, IMerged<ICoreArtistCollectionItem>, IEquatable<ICoreArtistCollectionItem>, IMerged<ICoreArtistCollection>, IEquatable<ICoreArtistCollection>, IGenreCollection, IGenreCollectionBase, IMerged<ICoreGenreCollection>, IEquatable<ICoreGenreCollection>, IPlayable, IPlayableBase, IDownloadable, IImageCollection, IImageCollectionBase, IMerged<ICoreImageCollection>, IEquatable<ICoreImageCollection>, IUrlCollection, IUrlCollectionBase, ICollectionBase, IMerged<ICoreUrlCollection>, IEquatable<ICoreUrlCollection>, IAppModel, IMerged<ICoreTrack>, IEquatable<ICoreTrack>, IMerged, IPluginWrapper
Properties
| Improve this Doc View SourceActivePlugins
All plugins that were imported and activated for this instance.
Declaration
public SdkModelPlugin ActivePlugins { get; }
Property Value
Type | Description |
---|---|
SdkModelPlugin |
Remarks
Once built, the returned instance will have plugins applied on top of the <xref href="StrixMusic.Sdk.AdapterModels.IMergedMutable%601" data-throw-if-not-resolved="false"></xref> instance.
If no plugins override functionality when accessing a member, the provided <xref href="StrixMusic.Sdk.AdapterModels.IMergedMutable%601" data-throw-if-not-resolved="false"></xref> will be used instead.
See SdkModelPlugin for more info.
See Also
| Improve this Doc View SourceAddedAt
The date this item was added to a collection. If unknown, value is null.
Declaration
public DateTime? AddedAt { get; }
Property Value
Type | Description |
---|---|
DateTime? |
Remarks
This property has no counterpart "changed" events or supporting properties. Since the item must be added to a collection for the data to change, a new instance with updated data would be used.
Album
An IAlbum object that this track belongs to.
Declaration
public IAlbum? Album { get; }
Property Value
Type | Description |
---|---|
IAlbum |
Description
Provides comments about the item. This may contain markdown content.
Declaration
public string? Description { get; }
Property Value
Type | Description |
---|---|
string |
DiscNumber
The disc number (usually 1 unless the album consists of more than one disc).
Declaration
public int? DiscNumber { get; }
Property Value
Type | Description |
---|---|
int? |
DownloadInfo
Information about downloading this item.
Declaration
public DownloadInfo DownloadInfo { get; }
Property Value
Type | Description |
---|---|
DownloadInfo |
Duration
How long the playable item takes to complete playback.
Declaration
public TimeSpan Duration { get; }
Property Value
Type | Description |
---|---|
TimeSpan |
Remarks
If not applicable, use Zero.
Id
The ID of the playable item.
Declaration
public string Id { get; }
Property Value
Type | Description |
---|---|
string |
IsChangeAlbumAsyncAvailable
If true, changing albums is supported.
Declaration
public bool IsChangeAlbumAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsChangeDescriptionAsyncAvailable
If true, ChangeDescriptionAsync(string?, CancellationToken) can be used.
Declaration
public bool IsChangeDescriptionAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsChangeDurationAsyncAvailable
If true, ChangeDurationAsync(TimeSpan, CancellationToken) can be used.
Declaration
public bool IsChangeDurationAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsChangeIsExplicitAsyncAvailable
If true, ChangeIsExplicitAsync(bool, CancellationToken) is supported.
Declaration
public bool IsChangeIsExplicitAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsChangeLanguageAsyncAvailable
If true, ChangeLanguageAsync(CultureInfo, CancellationToken) is supported.
Declaration
public bool IsChangeLanguageAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsChangeLyricsAsyncAvailable
If true, changing lyrics is supported.
Declaration
public bool IsChangeLyricsAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsChangeNameAsyncAvailable
If true, ChangeNameAsync(string, CancellationToken) can be used.
Declaration
public bool IsChangeNameAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsChangeTrackNumberAsyncAvailable
If true, ChangeTrackNumberAsync(int?, CancellationToken) is supported.
Declaration
public bool IsChangeTrackNumberAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsExplicit
If this track contains explicit language.
Declaration
public bool IsExplicit { get; }
Property Value
Type | Description |
---|---|
bool |
IsPauseArtistCollectionAsyncAvailable
If true, PauseArtistCollectionAsync(CancellationToken) can be used.
Declaration
public bool IsPauseArtistCollectionAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsPlayArtistCollectionAsyncAvailable
If true, PlayArtistCollectionAsync(CancellationToken) can be used.
Declaration
public bool IsPlayArtistCollectionAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
Language
The language for this track.
Declaration
public CultureInfo? Language { get; }
Property Value
Type | Description |
---|---|
CultureInfo |
Remarks
If track has no spoken words (instrumental), value is InvariantCulture. If unknown, value is null.
LastPlayed
The last time the item was played. If never played or unknown, value is null.
Declaration
public DateTime? LastPlayed { get; }
Property Value
Type | Description |
---|---|
DateTime? |
Lyrics
The lyrics for this track.
Declaration
public ILyrics? Lyrics { get; }
Property Value
Type | Description |
---|---|
ILyrics |
Name
Name of the playable item.
Declaration
public string Name { get; }
Property Value
Type | Description |
---|---|
string |
PlaybackState
Current playback state.
Declaration
public PlaybackState PlaybackState { get; }
Property Value
Type | Description |
---|---|
PlaybackState |
RelatedItems
An IPlayableCollectionGroup of items related to this item.
Declaration
public IPlayableCollectionGroup? RelatedItems { get; }
Property Value
Type | Description |
---|---|
IPlayableCollectionGroup |
Sources
The sources that make up this merged item.
Declaration
public IReadOnlyList<ICoreGenreCollection> Sources { get; }
Property Value
Type | Description |
---|---|
IReadOnlyList<ICoreGenreCollection> |
TotalArtistItemsCount
The total number of available Artists.
Declaration
public int TotalArtistItemsCount { get; }
Property Value
Type | Description |
---|---|
int |
TotalGenreCount
The total number of genres in this collection.
Declaration
public int TotalGenreCount { get; }
Property Value
Type | Description |
---|---|
int |
TotalImageCount
The total number of images in the collection.
Declaration
public int TotalImageCount { get; }
Property Value
Type | Description |
---|---|
int |
TotalUrlCount
The total number of urls in this collection.
Declaration
public int TotalUrlCount { get; }
Property Value
Type | Description |
---|---|
int |
TrackNumber
Position in the album.
Declaration
public int? TrackNumber { get; }
Property Value
Type | Description |
---|---|
int? |
Remarks
If an album has several discs, the track number is the number on the specified disc.
Type
Used to identify what kind of content an audio stream contains.
Declaration
public TrackType Type { get; }
Property Value
Type | Description |
---|---|
TrackType |
Methods
| Improve this Doc View SourceAddArtistItemAsync(IArtistCollectionItem, int, CancellationToken)
Adds an IArtist or IArtistCollection to this artist collection.
Declaration
public Task AddArtistItemAsync(IArtistCollectionItem artistItem, int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
IArtistCollectionItem | artistItem | The artistItem to add. |
int | index | the position to insert the artistItem 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. |
AddGenreAsync(IGenre, int, CancellationToken)
Adds a new genre to the collection.
Declaration
public Task AddGenreAsync(IGenre genre, int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
IGenre | genre | The genre to insert. |
int | index | the position to insert the genre 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. |
AddImageAsync(IImage, int, CancellationToken)
Adds a new image to the collection.
Declaration
public Task AddImageAsync(IImage image, int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
IImage | image | The image to add. |
int | index | the position to insert the image 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. |
AddUrlAsync(IUrl, int, CancellationToken)
Adds a new url to the collection.
Declaration
public Task AddUrlAsync(IUrl url, int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
IUrl | url | The url to insert. |
int | index | the position to insert the url 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. |
ChangeAlbumAsync(IAlbum?, CancellationToken)
Changes the album for this track.
Declaration
public Task ChangeAlbumAsync(IAlbum? album, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
IAlbum | album | The new album. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
ChangeDescriptionAsync(string?, CancellationToken)
Changes the Description for this item.
Declaration
public Task ChangeDescriptionAsync(string? description, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | description | The new description for this playable item. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
ChangeDurationAsync(TimeSpan, CancellationToken)
Changes the Duration for this item.
Declaration
public Task ChangeDurationAsync(TimeSpan duration, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
TimeSpan | duration | The new duration for this playable item. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
ChangeIsExplicitAsync(bool, CancellationToken)
Changes the IsExplicit for this track.
Declaration
public Task ChangeIsExplicitAsync(bool isExplicit, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
bool | isExplicit | The new value. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
ChangeLanguageAsync(CultureInfo, CancellationToken)
Changes the Language for this track.
Declaration
public Task ChangeLanguageAsync(CultureInfo language, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
CultureInfo | language | The new language for this track. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
ChangeLyricsAsync(ILyrics?, CancellationToken)
Changes the Lyrics for this track.
Declaration
public Task ChangeLyricsAsync(ILyrics? lyrics, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ILyrics | lyrics | The new lyrics data. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
ChangeNameAsync(string, CancellationToken)
Changes the Name of this playable item.
Declaration
public Task ChangeNameAsync(string name, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | name | The new name to use. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
ChangeTrackNumberAsync(int?, CancellationToken)
Changes the TrackNumber on this track.
Declaration
public Task ChangeTrackNumberAsync(int? trackNumber, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int? | trackNumber | The new track number. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
Equals(ICoreArtistCollection?)
Declaration
public bool Equals(ICoreArtistCollection? other)
Parameters
Type | Name | Description |
---|---|---|
ICoreArtistCollection | other |
Returns
Type | Description |
---|---|
bool |
Equals(ICoreArtistCollectionItem?)
Declaration
public bool Equals(ICoreArtistCollectionItem? other)
Parameters
Type | Name | Description |
---|---|---|
ICoreArtistCollectionItem | other |
Returns
Type | Description |
---|---|
bool |
Equals(ICoreGenreCollection?)
Declaration
public bool Equals(ICoreGenreCollection? other)
Parameters
Type | Name | Description |
---|---|---|
ICoreGenreCollection | other |
Returns
Type | Description |
---|---|
bool |
Equals(ICoreImageCollection?)
Declaration
public bool Equals(ICoreImageCollection? other)
Parameters
Type | Name | Description |
---|---|---|
ICoreImageCollection | other |
Returns
Type | Description |
---|---|
bool |
Equals(ICoreTrack?)
Declaration
public bool Equals(ICoreTrack? other)
Parameters
Type | Name | Description |
---|---|---|
ICoreTrack | other |
Returns
Type | Description |
---|---|
bool |
Equals(ICoreUrlCollection?)
Declaration
public bool Equals(ICoreUrlCollection? other)
Parameters
Type | Name | Description |
---|---|---|
ICoreUrlCollection | other |
Returns
Type | Description |
---|---|
bool |
GetArtistItemsAsync(int, int, CancellationToken)
Gets a requested number of IArtists starting at the given offset.
Declaration
public IAsyncEnumerable<IArtistCollectionItem> GetArtistItemsAsync(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<IArtistCollectionItem> | The requested range of items. |
GetGenresAsync(int, int, CancellationToken)
Gets a requested number of IGenreBases starting at the given offset.
Declaration
public IAsyncEnumerable<IGenre> GetGenresAsync(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<IGenre> | The requested range of items. |
GetImagesAsync(int, int, CancellationToken)
Gets a requested number of IImageBases starting at the given offset.
Declaration
public IAsyncEnumerable<IImage> GetImagesAsync(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<IImage> | The requested range of items. |
GetUrlsAsync(int, int, CancellationToken)
Gets a requested number of IUrlBases starting at the given offset.
Declaration
public IAsyncEnumerable<IUrl> GetUrlsAsync(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<IUrl> | The requested range of items. |
IsAddArtistItemAvailableAsync(int, CancellationToken)
Checks if the backend supports adding an IArtistCollectionItemBase at a specific index.
Declaration
public 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. |
IsAddGenreAvailableAsync(int, CancellationToken)
Checks if adding a genre to the collection at at the given index
is supported.
Declaration
public Task<bool> IsAddGenreAvailableAsync(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 item can be added to the collection. |
IsAddImageAvailableAsync(int, CancellationToken)
Checks if adding a IImageBase to the collection at at the given index
is supported.
Declaration
public Task<bool> IsAddImageAvailableAsync(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 IImageBase can be added. |
IsAddUrlAvailableAsync(int, CancellationToken)
Checks if adding a url to the collection at at the given index
is supported.
Declaration
public Task<bool> IsAddUrlAvailableAsync(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 item can be added to the collection. |
IsRemoveArtistItemAvailableAsync(int, CancellationToken)
Checks if the backend supports removing an IArtist at a specific index.
Declaration
public 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. |
IsRemoveGenreAvailableAsync(int, CancellationToken)
Checks if removing a genre to the collection at at the given index
is supported.
Declaration
public Task<bool> IsRemoveGenreAvailableAsync(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 item can be removed from the collection.. |
IsRemoveImageAvailableAsync(int, CancellationToken)
Checks if removing a IImageBase to the collection at at the given index
is supported.
Declaration
public Task<bool> IsRemoveImageAvailableAsync(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 IImageBase can be removed. |
IsRemoveUrlAvailableAsync(int, CancellationToken)
Checks if removing a url to the collection at at the given index
is supported.
Declaration
public Task<bool> IsRemoveUrlAvailableAsync(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 item can be removed from the collection.. |
PauseArtistCollectionAsync(CancellationToken)
Attempts to pause the Artist collection.
Declaration
public 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(IArtistCollectionItem, CancellationToken)
Attempts to play a specific item in the artistItem collection. Restarts playback if already playing.
Declaration
public Task PlayArtistCollectionAsync(IArtistCollectionItem artistItem, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
IArtistCollectionItem | artistItem | An item from the collection where playback begins. |
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
public 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
public 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. |
RemoveGenreAsync(int, CancellationToken)
Removes a genre from the collection.
Declaration
public Task RemoveGenreAsync(int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | index | the position remove the genre from. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
RemoveImageAsync(int, CancellationToken)
Removes the image from the collection on the backend.
Declaration
public Task RemoveImageAsync(int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | index | The index of the image 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. |
RemoveUrlAsync(int, CancellationToken)
Removes a url from the collection.
Declaration
public Task RemoveUrlAsync(int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | index | the position remove the url from. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
StartDownloadOperationAsync(DownloadOperation, CancellationToken)
Begins a download operation for this playable item.
Declaration
public Task StartDownloadOperationAsync(DownloadOperation operation, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
DownloadOperation | operation | |
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task | A Task that represents the asynchronous operation. |
Events
| Improve this Doc View SourceAlbumChanged
Fires when the Album metadata changes.
Declaration
public event EventHandler<IAlbum?>? AlbumChanged
Event Type
Type | Description |
---|---|
EventHandler<IAlbum> |
ArtistItemsChanged
Fires when the items in the backend are changed by something external.
Declaration
public event CollectionChangedEventHandler<IArtistCollectionItem>? ArtistItemsChanged
Event Type
Type | Description |
---|---|
CollectionChangedEventHandler<IArtistCollectionItem> |
ArtistItemsCountChanged
Fires when the merged TotalArtistItemsCount changes.
Declaration
public event EventHandler<int>? ArtistItemsCountChanged
Event Type
Type | Description |
---|---|
EventHandler<int> |
DescriptionChanged
Raised when Description changes.
Declaration
public event EventHandler<string?>? DescriptionChanged
Event Type
Type | Description |
---|---|
EventHandler<string> |
DownloadInfoChanged
Raised when DownloadInfo is updated.
Declaration
public event EventHandler<DownloadInfo>? DownloadInfoChanged
Event Type
Type | Description |
---|---|
EventHandler<DownloadInfo> |
DurationChanged
Raised when Duration changes;
Declaration
public event EventHandler<TimeSpan>? DurationChanged
Event Type
Type | Description |
---|---|
EventHandler<TimeSpan> |
GenresChanged
Fires when the genres are changed.
Declaration
public event CollectionChangedEventHandler<IGenre>? GenresChanged
Event Type
Type | Description |
---|---|
CollectionChangedEventHandler<IGenre> |
GenresCountChanged
Fires when the merged number of genres in the collection changes.
Declaration
public event EventHandler<int>? GenresCountChanged
Event Type
Type | Description |
---|---|
EventHandler<int> |
ImagesChanged
Fires when the items are changed.
Declaration
public event CollectionChangedEventHandler<IImage>? ImagesChanged
Event Type
Type | Description |
---|---|
CollectionChangedEventHandler<IImage> |
ImagesCountChanged
Fires when the merged number of images in the collection changes.
Declaration
public event EventHandler<int>? ImagesCountChanged
Event Type
Type | Description |
---|---|
EventHandler<int> |
IsChangeDescriptionAsyncAvailableChanged
Raised when IsChangeDescriptionAsyncAvailable changes.
Declaration
public event EventHandler<bool>? IsChangeDescriptionAsyncAvailableChanged
Event Type
Type | Description |
---|---|
EventHandler<bool> |
IsChangeDurationAsyncAvailableChanged
Raised when IsChangeDurationAsyncAvailable changes.
Declaration
public event EventHandler<bool>? IsChangeDurationAsyncAvailableChanged
Event Type
Type | Description |
---|---|
EventHandler<bool> |
IsChangeNameAsyncAvailableChanged
Raised when IsChangeNameAsyncAvailable changes.
Declaration
public event EventHandler<bool>? IsChangeNameAsyncAvailableChanged
Event Type
Type | Description |
---|---|
EventHandler<bool> |
IsExplicitChanged
Fires when the IsExplicit metadata changes.
Declaration
public event EventHandler<bool>? IsExplicitChanged
Event Type
Type | Description |
---|---|
EventHandler<bool> |
IsPauseArtistCollectionAsyncAvailableChanged
Raised when IsPauseArtistCollectionAsyncAvailable changes.
Declaration
public event EventHandler<bool>? IsPauseArtistCollectionAsyncAvailableChanged
Event Type
Type | Description |
---|---|
EventHandler<bool> |
IsPlayArtistCollectionAsyncAvailableChanged
Raised when IsPlayArtistCollectionAsyncAvailable changes.
Declaration
public event EventHandler<bool>? IsPlayArtistCollectionAsyncAvailableChanged
Event Type
Type | Description |
---|---|
EventHandler<bool> |
LanguageChanged
Fires when the Language metadata changes.
Declaration
public event EventHandler<CultureInfo?>? LanguageChanged
Event Type
Type | Description |
---|---|
EventHandler<CultureInfo> |
LastPlayedChanged
Raised when LastPlayed changes.
Declaration
public event EventHandler<DateTime?>? LastPlayedChanged
Event Type
Type | Description |
---|---|
EventHandler<DateTime?> |
LyricsChanged
Fires when the Lyrics metadata changes.
Declaration
public event EventHandler<ILyrics?>? LyricsChanged
Event Type
Type | Description |
---|---|
EventHandler<ILyrics> |
NameChanged
Raised when Name changes.
Declaration
public event EventHandler<string>? NameChanged
Event Type
Type | Description |
---|---|
EventHandler<string> |
PlaybackStateChanged
Raised when PlaybackState changes.
Declaration
public event EventHandler<PlaybackState>? PlaybackStateChanged
Event Type
Type | Description |
---|---|
EventHandler<PlaybackState> |
SourcesChanged
Raised when any of the sources have changed.
Declaration
public event EventHandler? SourcesChanged
Event Type
Type | Description |
---|---|
EventHandler |
TrackNumberChanged
Fires when the TrackNumber metadata changes.
Declaration
public event EventHandler<int?>? TrackNumberChanged
Event Type
Type | Description |
---|---|
EventHandler<int?> |
UrlsChanged
Fires when the urls are changed.
Declaration
public event CollectionChangedEventHandler<IUrl>? UrlsChanged
Event Type
Type | Description |
---|---|
CollectionChangedEventHandler<IUrl> |
UrlsCountChanged
Fires when the merged number of urls in the collection changes.
Declaration
public event EventHandler<int>? UrlsCountChanged
Event Type
Type | Description |
---|---|
EventHandler<int> |