Interface ITrackBase
Represents an audio stream with metadata that belongs to an ITrackCollectionBase.
Inherited Members
Namespace: StrixMusic.Sdk.BaseModels
Assembly: StrixMusic.Sdk.dll
Syntax
public interface ITrackBase : IArtistCollectionBase, IPlayableCollectionBase, IArtistCollectionItemBase, IPlayableCollectionItem, IPlayableBase, IImageCollectionBase, IUrlCollectionBase, ICollectionItemBase, IGenreCollectionBase, ICollectionBase
Properties
| Improve this Doc View SourceDiscNumber
The disc number (usually 1 unless the album consists of more than one disc).
Declaration
int? DiscNumber { get; }
Property Value
Type | Description |
---|---|
int? |
IsChangeAlbumAsyncAvailable
If true, changing albums is supported.
Declaration
bool IsChangeAlbumAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsChangeIsExplicitAsyncAvailable
If true, ChangeIsExplicitAsync(bool, CancellationToken) is supported.
Declaration
bool IsChangeIsExplicitAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsChangeLanguageAsyncAvailable
If true, ChangeLanguageAsync(CultureInfo, CancellationToken) is supported.
Declaration
bool IsChangeLanguageAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsChangeLyricsAsyncAvailable
If true, changing lyrics is supported.
Declaration
bool IsChangeLyricsAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsChangeTrackNumberAsyncAvailable
If true, ChangeTrackNumberAsync(int?, CancellationToken) is supported.
Declaration
bool IsChangeTrackNumberAsyncAvailable { get; }
Property Value
Type | Description |
---|---|
bool |
IsExplicit
If this track contains explicit language.
Declaration
bool IsExplicit { get; }
Property Value
Type | Description |
---|---|
bool |
Language
The language for this track.
Declaration
CultureInfo? Language { get; }
Property Value
Type | Description |
---|---|
CultureInfo |
Remarks
If track has no spoken words (instrumental), value is InvariantCulture. If unknown, value is null.
TrackNumber
Position in the album.
Declaration
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
TrackType Type { get; }
Property Value
Type | Description |
---|---|
TrackType |
Methods
| Improve this Doc View SourceChangeIsExplicitAsync(bool, CancellationToken)
Changes the IsExplicit for this track.
Declaration
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
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. |
ChangeTrackNumberAsync(int?, CancellationToken)
Changes the TrackNumber on this track.
Declaration
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. |
Events
| Improve this Doc View SourceIsExplicitChanged
Fires when the IsExplicit metadata changes.
Declaration
event EventHandler<bool>? IsExplicitChanged
Event Type
Type | Description |
---|---|
EventHandler<bool> |
LanguageChanged
Fires when the Language metadata changes.
Declaration
event EventHandler<CultureInfo?>? LanguageChanged
Event Type
Type | Description |
---|---|
EventHandler<CultureInfo> |
TrackNumberChanged
Fires when the TrackNumber metadata changes.
Declaration
event EventHandler<int?>? TrackNumberChanged
Event Type
Type | Description |
---|---|
EventHandler<int?> |