Class Audio
Class Audio
Implements
Inherited Members
Namespace: MediaBrowser.Controller.Entities.Audio
Assembly: MediaBrowser.Controller.dll
Syntax
public class Audio : BaseItem, IHasLookupInfo<ItemLookupInfo>, IHasAlbumArtist, IHasProviderIds, IHasAlbum, IHasMusicAlbum, IHasArtist, IHasMusicGenres, IHasLookupInfo<SongInfo>, IHasMediaSourcesConstructors
Audio()
Declaration
public Audio()Properties
AlbumArtistItems
Gets or sets the artists.
Declaration
[IgnoreDataMember]
public LinkedItemInfo[] AlbumArtistItems { get; set; }Property Value
| Type | Description |
|---|---|
| LinkedItemInfo[] | The artists. |
AlbumArtists
Declaration
[IgnoreDataMember]
public string[] AlbumArtists { get; set; }Property Value
| Type | Description |
|---|---|
| System.String[] |
ArtistItems
Gets or sets the artists.
Declaration
[IgnoreDataMember]
public LinkedItemInfo[] ArtistItems { get; set; }Property Value
| Type | Description |
|---|---|
| LinkedItemInfo[] | The artists. |
Artists
Declaration
[IgnoreDataMember]
public string[] Artists { get; set; }Property Value
| Type | Description |
|---|---|
| System.String[] |
Composers
Gets or sets the composers.
Declaration
[IgnoreDataMember]
public LinkedItemInfo[] Composers { get; set; }Property Value
| Type | Description |
|---|---|
| LinkedItemInfo[] | The composers. |
ForceDefaultAspectRatio
Declaration
[IgnoreDataMember]
public override bool ForceDefaultAspectRatio { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
ImageDisplayParentId
Declaration
[IgnoreDataMember]
public override long ImageDisplayParentId { get; }Property Value
| Type | Description |
|---|---|
| System.Int64 |
Overrides
IsMedia
Declaration
[IgnoreDataMember]
public override bool IsMedia { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
LatestItemsContainerId
Declaration
[IgnoreDataMember]
public override long LatestItemsContainerId { get; }Property Value
| Type | Description |
|---|---|
| System.Int64 |
Overrides
MediaType
Gets the type of the media.
Declaration
[IgnoreDataMember]
public override string MediaType { get; }Property Value
| Type | Description |
|---|---|
| System.String | The type of the media. |
Overrides
SupportsExternalTransfer
Declaration
[IgnoreDataMember]
public override bool SupportsExternalTransfer { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
SupportsGenres
Declaration
[IgnoreDataMember]
public override bool SupportsGenres { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
SupportsInheritedParentImages
Declaration
[IgnoreDataMember]
public override bool SupportsInheritedParentImages { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
SupportsOwnedItems
Declaration
[IgnoreDataMember]
public override bool SupportsOwnedItems { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
SupportsPeople
Declaration
[IgnoreDataMember]
public override bool SupportsPeople { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Overrides
Methods
CanDownload()
Declaration
public override bool CanDownload()Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
GetAlbumArtistFolder(LibraryOptions)
Declaration
public string GetAlbumArtistFolder(LibraryOptions libraryOptions)Parameters
| Type | Name | Description |
|---|---|---|
| LibraryOptions | libraryOptions |
Returns
| Type | Description |
|---|---|
| System.String |
GetAlbumFolder(LibraryOptions)
Declaration
public string GetAlbumFolder(LibraryOptions libraryOptions)Parameters
| Type | Name | Description |
|---|---|---|
| LibraryOptions | libraryOptions |
Returns
| Type | Description |
|---|---|
| System.String |
GetAllItemsForMediaSources(User, Boolean)
Declaration
protected override List<Tuple<BaseItem, MediaSourceType>> GetAllItemsForMediaSources(User user, bool enableAlternateMediaSources)Parameters
| Type | Name | Description |
|---|---|---|
| User | user | |
| System.Boolean | enableAlternateMediaSources |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<System.Tuple<BaseItem, MediaSourceType>> |
Overrides
GetDefaultPrimaryImageAspectRatio()
Declaration
public override double GetDefaultPrimaryImageAspectRatio()Returns
| Type | Description |
|---|---|
| System.Double |
Overrides
GetLookupInfo(LibraryOptions)
Declaration
public SongInfo GetLookupInfo(LibraryOptions libraryOptions)Parameters
| Type | Name | Description |
|---|---|---|
| LibraryOptions | libraryOptions |
Returns
| Type | Description |
|---|---|
| SongInfo |
GetMediaStreams(MediaStreamType)
Declaration
public List<MediaStream> GetMediaStreams(MediaStreamType type)Parameters
| Type | Name | Description |
|---|---|---|
| MediaStreamType | type |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<MediaStream> |
GetSupportsPositionTicksResume(LibraryOptions)
Declaration
public override bool GetSupportsPositionTicksResume(LibraryOptions libraryOptions)Parameters
| Type | Name | Description |
|---|---|---|
| LibraryOptions | libraryOptions |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
GetUserDataKeyInternal(IDataContext)
Declaration
protected override string GetUserDataKeyInternal(IDataContext dataContext)Parameters
| Type | Name | Description |
|---|---|---|
| IDataContext | dataContext |
Returns
| Type | Description |
|---|---|
| System.String |
Overrides
SupportsPlayedStatus()
Declaration
public override bool SupportsPlayedStatus()Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
UpdateHideFromResume(User, UserItemData, BaseItem[], Boolean)
Declaration
public override void UpdateHideFromResume(User user, UserItemData userData, BaseItem[] collectionFolders, bool hide)Parameters
| Type | Name | Description |
|---|---|---|
| User | user | |
| UserItemData | userData | |
| BaseItem[] | collectionFolders | |
| System.Boolean | hide |