Class MusicArtist

Class MusicArtist

Inheritance
System.Object
BaseItem
Folder
MusicArtist
Inherited Members
Namespace: MediaBrowser.Controller.Entities.Audio
Assembly: MediaBrowser.Controller.dll
Syntax
public sealed class MusicArtist : Folder, IHasProviderIds, IHasLookupInfo<ItemLookupInfo>, IItemByName, IHasFolderGrouping, IHasMusicGenres, IHasLookupInfo<ArtistInfo>

Properties

ContainingFolderPath

Returns the folder containing the item. If the item is a folder, it returns the folder itself

Declaration
[IgnoreDataMember]
public override string ContainingFolderPath { get; }
Property Value
Type Description
System.String

The containing folder path.
Overrides

ForceDefaultAspectRatio

Declaration
[IgnoreDataMember]
public override bool ForceDefaultAspectRatio { get; }
Property Value
Type Description
System.Boolean
Overrides

IsDisplayedAsFolder

Declaration
[IgnoreDataMember]
public override bool IsDisplayedAsFolder { get; }
Property Value
Type Description
System.Boolean
Overrides

IsFolder

Declaration
[IgnoreDataMember]
public override bool IsFolder { get; }
Property Value
Type Description
System.Boolean
Overrides

SupportsAncestors

Declaration
[IgnoreDataMember]
public override bool SupportsAncestors { get; }
Property Value
Type Description
System.Boolean
Overrides

SupportsCumulativeRunTimeTicks

Declaration
[IgnoreDataMember]
public override bool SupportsCumulativeRunTimeTicks { get; }
Property Value
Type Description
System.Boolean
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

SupportsPeople

Declaration
[IgnoreDataMember]
public override bool SupportsPeople { get; }
Property Value
Type Description
System.Boolean
Overrides

SupportsResetMetadata

Declaration
[IgnoreDataMember]
public override bool SupportsResetMetadata { get; }
Property Value
Type Description
System.Boolean
Overrides

UpdateChildrenOnLockStateChange

Declaration
[IgnoreDataMember]
public override bool UpdateChildrenOnLockStateChange { get; }
Property Value
Type Description
System.Boolean
Overrides

ValidatesChildren

Declaration
[IgnoreDataMember]
protected override bool ValidatesChildren { get; }
Property Value
Type Description
System.Boolean
Overrides

Methods

AllowEditingField(MetadataFields)

Declaration
public override bool AllowEditingField(MetadataFields field)
Parameters
Type Name Description
MetadataFields field
Returns
Type Description
System.Boolean
Overrides

CanDelete()

Declaration
public override bool CanDelete()
Returns
Type Description
System.Boolean
Overrides

GetArtistFolderFromMediaPath(String, String)

Declaration
public static string GetArtistFolderFromMediaPath(string mediaPath, string artistName)
Parameters
Type Name Description
System.String mediaPath
System.String artistName
Returns
Type Description
System.String

GetDefaultPrimaryImageAspectRatio()

Declaration
public override double GetDefaultPrimaryImageAspectRatio()
Returns
Type Description
System.Double
Overrides

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

GetInternalMetadataPath(String)

Declaration
protected override string GetInternalMetadataPath(string basePath)
Parameters
Type Name Description
System.String basePath
Returns
Type Description
System.String
Overrides

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

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

GetLookupInfo(LibraryOptions)

Declaration
public ArtistInfo GetLookupInfo(LibraryOptions libraryOptions)
Parameters
Type Name Description
LibraryOptions libraryOptions
Returns
Type Description
ArtistInfo

GetMediaContainingFolderPath(LibraryOptions)

Declaration
public override string GetMediaContainingFolderPath(LibraryOptions libraryOptions)
Parameters
Type Name Description
LibraryOptions libraryOptions
Returns
Type Description
System.String
Overrides

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

Implements

Extension Methods