public class MusicAlbum : Folder, IHasLookupInfo<ItemLookupInfo>, IItemByName, IHasFolderGrouping, IHasAlbumArtist, IHasProviderIds, IHasArtist, IHasMusicGenres, IHasLookupInfo<AlbumInfo>

Constructors

MusicAlbum()

Declaration

public MusicAlbum()

Properties

AlbumArtist

Declaration

[IgnoreDataMember]
public string AlbumArtist { get; }

Property Value

Type	Description
System.String

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

BaseItem.ForceDefaultAspectRatio

IsDisplayedAsFolder

Declaration

[IgnoreDataMember]
public override bool IsDisplayedAsFolder { get; }

Property Value

Type	Description
System.Boolean

Overrides

Folder.IsDisplayedAsFolder

IsFolder

Declaration

[IgnoreDataMember]
public override bool IsFolder { get; }

Property Value

Type	Description
System.Boolean

Overrides

Folder.IsFolder

MarkDirectlyAsPlayed

Declaration

[IgnoreDataMember]
protected override bool MarkDirectlyAsPlayed { get; }

Property Value

Type	Description
System.Boolean

Overrides

Folder.MarkDirectlyAsPlayed

RecursiveChildCountEqualsChildCount

Declaration

[IgnoreDataMember]
public override bool RecursiveChildCountEqualsChildCount { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.RecursiveChildCountEqualsChildCount

SupportsAncestors

Declaration

[IgnoreDataMember]
public override bool SupportsAncestors { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.SupportsAncestors

SupportsCumulativeRunTimeTicks

Declaration

[IgnoreDataMember]
public override bool SupportsCumulativeRunTimeTicks { get; }

Property Value

Type	Description
System.Boolean

Overrides

Folder.SupportsCumulativeRunTimeTicks

SupportsGenres

Declaration

[IgnoreDataMember]
public override bool SupportsGenres { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.SupportsGenres

SupportsInheritedParentImages

Declaration

[IgnoreDataMember]
public override bool SupportsInheritedParentImages { get; }

Property Value

Type	Description
System.Boolean

Overrides

Folder.SupportsInheritedParentImages

SupportsPeople

Declaration

[IgnoreDataMember]
public override bool SupportsPeople { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.SupportsPeople

SupportsResetMetadata

Declaration

[IgnoreDataMember]
public override bool SupportsResetMetadata { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.SupportsResetMetadata

ValidatesChildren

Declaration

[IgnoreDataMember]
protected override bool ValidatesChildren { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.ValidatesChildren

Methods

AllowEditingField(MetadataFields)

Declaration

public override bool AllowEditingField(MetadataFields field)

Parameters

Type	Name	Description
MetadataFields	field

Returns

Type	Description
System.Boolean

Overrides

BaseItem.AllowEditingField(MetadataFields)

CanDelete()

Declaration

public override bool CanDelete()

Returns

Type	Description
System.Boolean

Overrides

Folder.CanDelete()

GetAlbumFolderFromMediaPath(String)

Declaration

public static string GetAlbumFolderFromMediaPath(string mediaPath)

Parameters

Type	Name	Description
System.String	mediaPath

Returns

Type	Description
System.String

GetDefaultPrimaryImageAspectRatio()

Declaration

public override double GetDefaultPrimaryImageAspectRatio()

Returns

Type	Description
System.Double

Overrides

BaseItem.GetDefaultPrimaryImageAspectRatio()

GetDeletePaths(Boolean, BaseItem[])

Declaration

public override List<FileSystemMetadata> GetDeletePaths(bool mediaFilesOnly, BaseItem[] collectionFolders)

Parameters

Type	Name	Description
System.Boolean	mediaFilesOnly
BaseItem[]	collectionFolders

Returns

Type	Description
System.Collections.Generic.List<FileSystemMetadata>

Overrides

BaseItem.GetDeletePaths(Boolean, BaseItem[])

GetInternalMetadataPath(String)

Declaration

protected override string GetInternalMetadataPath(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Returns

Type	Description
System.String

Overrides

BaseItem.GetInternalMetadataPath(String)

GetItemIdsInternal(InternalItemsQuery, IDataContext)

Declaration

protected override long[] GetItemIdsInternal(InternalItemsQuery query, IDataContext dataContext)

Parameters

Type	Name	Description
InternalItemsQuery	query
IDataContext	dataContext

Returns

Type	Description
System.Int64[]

Overrides

Folder.GetItemIdsInternal(InternalItemsQuery, IDataContext)

GetItemsInternal(InternalItemsQuery, IDataContext)

Declaration

protected override QueryResult<BaseItem> GetItemsInternal(InternalItemsQuery query, IDataContext dataContext)

Parameters

Type	Name	Description
InternalItemsQuery	query
IDataContext	dataContext

Returns

Type	Description
QueryResult<BaseItem>

Overrides

Folder.GetItemsInternal(InternalItemsQuery, IDataContext)

GetLookupInfo(LibraryOptions)

Declaration

public AlbumInfo GetLookupInfo(LibraryOptions libraryOptions)

Parameters

Type	Name	Description
LibraryOptions	libraryOptions

Returns

Type	Description
AlbumInfo

GetMediaContainingFolderPath(LibraryOptions)

Declaration

public override string GetMediaContainingFolderPath(LibraryOptions libraryOptions)

Parameters

Type	Name	Description
LibraryOptions	libraryOptions

Returns

Type	Description
System.String

Overrides

BaseItem.GetMediaContainingFolderPath(LibraryOptions)

GetSupportsPositionTicksResume(LibraryOptions)

Declaration

public override bool GetSupportsPositionTicksResume(LibraryOptions libraryOptions)

Parameters

Type	Name	Description
LibraryOptions	libraryOptions

Returns

Type	Description
System.Boolean

Overrides

BaseItem.GetSupportsPositionTicksResume(LibraryOptions)

GetTaggedItems(InternalItemsQuery)

Declaration

public long[] GetTaggedItems(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
System.Int64[]

GetTaggedItems(InternalItemsQuery, IDataContext)

Declaration

public long[] GetTaggedItems(InternalItemsQuery query, IDataContext dataContext)

Parameters

Type	Name	Description
InternalItemsQuery	query
IDataContext	dataContext

Returns

Type	Description
System.Int64[]

GetTaggedItemsResult(InternalItemsQuery)

Declaration

public QueryResult<BaseItem> GetTaggedItemsResult(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
QueryResult<BaseItem>

GetTaggedItemsResult(InternalItemsQuery, IDataContext)

Declaration

public QueryResult<BaseItem> GetTaggedItemsResult(InternalItemsQuery query, IDataContext dataContext)

Parameters

Type	Name	Description
InternalItemsQuery	query
IDataContext	dataContext

Returns

Type	Description
QueryResult<BaseItem>

GetUserDataKeyInternal(IDataContext)

Declaration

protected override string GetUserDataKeyInternal(IDataContext dataContext)

Parameters

Type	Name	Description
IDataContext	dataContext

Returns

Type	Description
System.String

Overrides

BaseItem.GetUserDataKeyInternal(IDataContext)

SupportsPlayedStatus()

Declaration

public override bool SupportsPlayedStatus()

Returns

Type	Description
System.Boolean