Class BaseItem

Class BaseItem

Inheritance

System.Object

BaseItem

Audio

MusicGenre

Book

Folder

Game

GameGenre

Genre

Person

Photo

Studio

Tag

User

Video

LiveTvChannel

LiveTvProgram

LiveTVSeries

Implements

IHasProviderIds

IHasLookupInfo<ItemLookupInfo>

Namespace: MediaBrowser.Controller.Entities

Assembly: MediaBrowser.Controller.dll

Syntax

public abstract class BaseItem : IHasProviderIds, IHasLookupInfo<ItemLookupInfo>

Fields

DisplayExtraTypes

Declaration

public static ExtraType[] DisplayExtraTypes

Field Value

Type	Description
ExtraType[]

ExtrasSubFolders

Declaration

public static readonly Dictionary<string, ExtraType?> ExtrasSubFolders

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Nullable<ExtraType>>

MediaSourceIdPrefix

Declaration

public static string MediaSourceIdPrefix

Field Value

Type	Description
System.String

SupportedImageExtensions

The supported image extensions

Declaration

public static readonly string[] SupportedImageExtensions

Field Value

Type	Description
System.String[]

ThemeSongFilename

Declaration

public static ReadOnlyMemory<char> ThemeSongFilename

Field Value

Type	Description
System.ReadOnlyMemory<System.Char>

ThemeSongsFolderName

Declaration

public static ReadOnlyMemory<char> ThemeSongsFolderName

Field Value

Type	Description
System.ReadOnlyMemory<System.Char>

ThemeVideosFolderName

Declaration

public static ReadOnlyMemory<char> ThemeVideosFolderName

Field Value

Type	Description
System.ReadOnlyMemory<System.Char>

TrailerFolderName

The trailer folder name

Declaration

public static ReadOnlyMemory<char> TrailerFolderName

Field Value

Type	Description
System.ReadOnlyMemory<System.Char>

Properties

AdditionalPartCount

Internal use only

Declaration

[IgnoreDataMember]
public int? AdditionalPartCount { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Album

Gets or sets the album.

Declaration

[IgnoreDataMember]
public string Album { get; set; }

Property Value

Type	Description
System.String	The album.

AlbumId

Declaration

[IgnoreDataMember]
public long AlbumId { get; }

Property Value

Type	Description
System.Int64

AlbumItem

Gets or sets the artists.

Declaration

[IgnoreDataMember]
public LinkedItemInfo AlbumItem { get; set; }

Property Value

Type	Description
LinkedItemInfo	The artists.

AllowRecursiveCounts

Declaration

[IgnoreDataMember]
public virtual bool AllowRecursiveCounts { get; }

Property Value

Type	Description
System.Boolean

ApplicationHost

Declaration

public static IServerApplicationHost ApplicationHost { get; set; }

Property Value

Type	Description
IServerApplicationHost

AudioStreamIndex

Declaration

[IgnoreDataMember]
public int? AudioStreamIndex { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

ChannelManager

Declaration

public static IChannelManager ChannelManager { get; set; }

Property Value

Type	Description
IChannelManager

ChildCount

Internal use only

Declaration

[IgnoreDataMember]
public int? ChildCount { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

CollectionFolders

Declaration

[IgnoreDataMember]
public Folder[] CollectionFolders { get; set; }

Property Value

Type	Description
Folder[]

Collections

Gets or sets the collections.

Declaration

[IgnoreDataMember]
public LinkedItemInfo[] Collections { get; set; }

Property Value

Type	Description
LinkedItemInfo[]	The collections.

CommunityRating

Gets or sets the community rating.

Declaration

[IgnoreDataMember]
public float? CommunityRating { get; set; }

Property Value

Type	Description
System.Nullable<System.Single>	The community rating.

ConfigurationManager

Declaration

public static IServerConfigurationManager ConfigurationManager { get; set; }

Property Value

Type	Description
IServerConfigurationManager

Container

Declaration

[IgnoreDataMember]
public string Container { get; set; }

Property Value

Type	Description
System.String

ContainingFolderPath

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

Declaration

[IgnoreDataMember]
public virtual string ContainingFolderPath { get; }

Property Value

Type	Description
System.String

CriticRating

Gets or sets the critic rating.

Declaration

[IgnoreDataMember]
public float? CriticRating { get; set; }

Property Value

Type	Description
System.Nullable<System.Single>	The critic rating.

CustomRating

Gets or sets the custom rating.

Declaration

[IgnoreDataMember]
public string CustomRating { get; set; }

Property Value

Type	Description
System.String	The custom rating.

CustomRatingForComparison

Declaration

[IgnoreDataMember]
public ReadOnlySpan<char> CustomRatingForComparison { get; }

Property Value

Type	Description
System.ReadOnlySpan<System.Char>

DateCreated

Gets or sets the date created.

Declaration

public DateTimeOffset DateCreated { get; set; }

Property Value

Type	Description
System.DateTimeOffset	The date created.

DateLastRefreshed

Declaration

[IgnoreDataMember]
public DateTimeOffset DateLastRefreshed { get; set; }

Property Value

Type	Description
System.DateTimeOffset

DateLastSaved

Declaration

[IgnoreDataMember]
public DateTimeOffset DateLastSaved { get; set; }

Property Value

Type	Description
System.DateTimeOffset

DateModified

Gets or sets the date modified.

Declaration

[IgnoreDataMember]
public DateTimeOffset DateModified { get; set; }

Property Value

Type	Description
System.DateTimeOffset	The date modified.

DisplayParent

Declaration

[IgnoreDataMember]
public BaseItem DisplayParent { get; }

Property Value

Type	Description
BaseItem

DisplayParentId

Declaration

[IgnoreDataMember]
public virtual long DisplayParentId { get; }

Property Value

Type	Description
System.Int64

DisplayPreferencesId

Return the id that should be used to key display prefs for this item. Default is based on the type for everything except actual generic folders.

Declaration

[IgnoreDataMember]
public virtual Guid DisplayPreferencesId { get; }

Property Value

Type	Description
System.Guid	The display prefs id.

EnableAlphaNumericSorting

Declaration

[IgnoreDataMember]
public virtual bool EnableAlphaNumericSorting { get; }

Property Value

Type	Description
System.Boolean

EnableInternalIdsExternally

Declaration

[IgnoreDataMember]
public virtual bool EnableInternalIdsExternally { get; }

Property Value

Type	Description
System.Boolean

EnableRememberingTrackSelections

Declaration

[IgnoreDataMember]
public virtual bool EnableRememberingTrackSelections { get; }

Property Value

Type	Description
System.Boolean

EndDate

Gets or sets the end date.

Declaration

[IgnoreDataMember]
public DateTimeOffset? EndDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>	The end date.

ExternalId

If this content came from an external service, the id of the content on that service

Declaration

[IgnoreDataMember]
public string ExternalId { get; set; }

Property Value

Type	Description
System.String

ExtraType

Declaration

[IgnoreDataMember]
public ExtraType? ExtraType { get; set; }

Property Value

Type	Description
System.Nullable<ExtraType>

FeatureManager

Declaration

public static IFeatureManager FeatureManager { get; set; }

Property Value

Type	Description
IFeatureManager

FileName

Declaration

[IgnoreDataMember]
public virtual string FileName { get; }

Property Value

Type	Description
System.String

FileNameWithoutExtension

Declaration

[IgnoreDataMember]
public virtual string FileNameWithoutExtension { get; }

Property Value

Type	Description
System.String

FileSystem

Declaration

public static IFileSystem FileSystem { get; set; }

Property Value

Type	Description
IFileSystem

ForceDefaultAspectRatio

Declaration

[IgnoreDataMember]
public virtual bool ForceDefaultAspectRatio { get; }

Property Value

Type	Description
System.Boolean

GenreItems

Gets or sets the genres.

Declaration

[IgnoreDataMember]
public LinkedItemInfo[] GenreItems { get; set; }

Property Value

Type	Description
LinkedItemInfo[]	The genres.

Genres

Declaration

[IgnoreDataMember]
public string[] Genres { get; set; }

Property Value

Type	Description
System.String[]

HasPathProtocol

Declaration

[IgnoreDataMember]
public bool HasPathProtocol { get; }

Property Value

Type	Description
System.Boolean

Height

Declaration

[IgnoreDataMember]
public int Height { get; set; }

Property Value

Type	Description
System.Int32

Id

Gets or sets the id.

Declaration

[IgnoreDataMember]
public Guid Id { get; set; }

Property Value

Type	Description
System.Guid	The id.

ImageDisplayParentId

Declaration

[IgnoreDataMember]
public virtual long ImageDisplayParentId { get; }

Property Value

Type	Description
System.Int64

ImageInfos

Declaration

[IgnoreDataMember]
public virtual ItemImageInfo[] ImageInfos { get; set; }

Property Value

Type	Description
ItemImageInfo[]

ImportedCollections

Declaration

public LinkedItemInfo[] ImportedCollections { get; set; }

Property Value

Type	Description
LinkedItemInfo[]

IndexNumber

If the item is part of a series, this is it's number in the series. This could be episode number, album track number, etc.

Declaration

[IgnoreDataMember]
public int? IndexNumber { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The index number.

InternalAlbumId

Declaration

[IgnoreDataMember]
public long InternalAlbumId { get; set; }

Property Value

Type	Description
System.Int64

InternalId

Declaration

[IgnoreDataMember]
public long InternalId { get; set; }

Property Value

Type	Description
System.Int64

IsCompleteMedia

Declaration

[IgnoreDataMember]
public bool IsCompleteMedia { get; }

Property Value

Type	Description
System.Boolean

IsDisplayedAsFolder

Declaration

[IgnoreDataMember]
public virtual bool IsDisplayedAsFolder { get; }

Property Value

Type	Description
System.Boolean

IsFavorite

Declaration

[IgnoreDataMember]
public bool IsFavorite { get; set; }

Property Value

Type	Description
System.Boolean

IsFileProtocol

Declaration

[IgnoreDataMember]
public bool IsFileProtocol { get; }

Property Value

Type	Description
System.Boolean

IsFolder

Gets a value indicating whether this instance is folder.

Declaration

[IgnoreDataMember]
[Obsolete("Check is Folder by type or IsDisplayedAsFolder, depending on your use case.")]
public virtual bool IsFolder { get; }

Property Value

Type	Description
System.Boolean	true if this instance is folder; otherwise, false.

IsHD

Declaration

[IgnoreDataMember]
public bool IsHD { get; }

Property Value

Type	Description
System.Boolean

IsHidden

Declaration

[IgnoreDataMember]
public virtual bool IsHidden { get; }

Property Value

Type	Description
System.Boolean

IsInMixedFolder

Gets a value indicating whether this instance is in mixed folder.

Declaration

[IgnoreDataMember]
public bool IsInMixedFolder { get; set; }

Property Value

Type	Description
System.Boolean	true if this instance is in mixed folder; otherwise, false.

IsLocked

Declaration

[IgnoreDataMember]
public bool IsLocked { get; set; }

Property Value

Type	Description
System.Boolean

IsMedia

Declaration

[IgnoreDataMember]
public virtual bool IsMedia { get; }

Property Value

Type	Description
System.Boolean

IsNameParsedFromFolder

Internal use only

Declaration

public bool IsNameParsedFromFolder { get; set; }

Property Value

Type	Description
System.Boolean

IsPlaceHolder

Declaration

[IgnoreDataMember]
public bool IsPlaceHolder { get; }

Property Value

Type	Description
System.Boolean

IsPublic

Declaration

[IgnoreDataMember]
public bool IsPublic { get; set; }

Property Value

Type	Description
System.Boolean

IsResolvedToFolder

Declaration

[IgnoreDataMember]
public virtual bool IsResolvedToFolder { get; }

Property Value

Type	Description
System.Boolean

IsSecondaryMergedItemInSameFolder

Internal use only

Declaration

[IgnoreDataMember]
public bool IsSecondaryMergedItemInSameFolder { get; set; }

Property Value

Type	Description
System.Boolean

IsShortcut

Declaration

[IgnoreDataMember]
public bool IsShortcut { get; }

Property Value

Type	Description
System.Boolean

IsThemeMedia

Declaration

[IgnoreDataMember]
public bool IsThemeMedia { get; }

Property Value

Type	Description
System.Boolean

IsTopParent

Declaration

[IgnoreDataMember]
public virtual bool IsTopParent { get; }

Property Value

Type	Description
System.Boolean

IsUnaired

Declaration

[IgnoreDataMember]
public bool IsUnaired { get; }

Property Value

Type	Description
System.Boolean

IsVirtualItem

Declaration

[IgnoreDataMember]
public bool IsVirtualItem { get; set; }

Property Value

Type	Description
System.Boolean

ItemRepository

Declaration

public static IItemRepository ItemRepository { get; set; }

Property Value

Type	Description
IItemRepository

LastPlayedDate

Declaration

[IgnoreDataMember]
public DateTimeOffset? LastPlayedDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>

LatestItemsContainerId

Declaration

[IgnoreDataMember]
public virtual long LatestItemsContainerId { get; }

Property Value

Type	Description
System.Int64

LibraryManager

Declaration

public static ILibraryManager LibraryManager { get; set; }

Property Value

Type	Description
ILibraryManager

LibraryOptions

Declaration

[IgnoreDataMember]
public LibraryOptions LibraryOptions { get; set; }

Property Value

Type	Description
LibraryOptions

ListItemEntryId

Declaration

[IgnoreDataMember]
public long ListItemEntryId { get; set; }

Property Value

Type	Description
System.Int64

LiveTvManager

Declaration

public static ILiveTvManager LiveTvManager { get; set; }

Property Value

Type	Description
ILiveTvManager

LocalizationManager

Declaration

public static ILocalizationManager LocalizationManager { get; set; }

Property Value

Type	Description
ILocalizationManager

LocalTrailerCount

Internal use only

Declaration

[IgnoreDataMember]
public int? LocalTrailerCount { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

LocalTrailerIds

Declaration

[IgnoreDataMember]
public Guid[] LocalTrailerIds { get; }

Property Value

Type	Description
System.Guid[]

LocationType

Gets or sets the type of the location.

Declaration

[IgnoreDataMember]
public virtual LocationType LocationType { get; }

Property Value

Type	Description
LocationType	The type of the location.

LockedFields

Gets or sets the locked fields.

Declaration

[IgnoreDataMember]
public MetadataFields[] LockedFields { get; set; }

Property Value

Type	Description
MetadataFields[]	The locked fields.

Logger

The logger

Declaration

public static ILogger Logger { get; set; }

Property Value

Type	Description
ILogger

MediaContainer

Declaration

[IgnoreDataMember]
public MediaContainers? MediaContainer { get; }

Property Value

Type	Description
System.Nullable<MediaContainers>

MediaSourceManager

Declaration

public static IMediaSourceManager MediaSourceManager { get; set; }

Property Value

Type	Description
IMediaSourceManager

MediaStreams

Internal use only

Declaration

[IgnoreDataMember]
public List<MediaStream> MediaStreams { get; set; }

Property Value

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

MediaType

Gets the type of the media.

Declaration

[IgnoreDataMember]
public virtual string MediaType { get; }

Property Value

Type	Description
System.String	The type of the media.

Name

Gets or sets the name.

Declaration

[IgnoreDataMember]
public virtual string Name { get; set; }

Property Value

Type	Description
System.String	The name.

NetworkManager

Declaration

public static INetworkManager NetworkManager { get; set; }

Property Value

Type	Description
INetworkManager

OfficialRating

Gets or sets the official rating.

Declaration

[IgnoreDataMember]
public string OfficialRating { get; set; }

Property Value

Type	Description
System.String	The official rating.

OfficialRatingForComparison

Declaration

[IgnoreDataMember]
public ReadOnlySpan<char> OfficialRatingForComparison { get; }

Property Value

Type	Description
System.ReadOnlySpan<System.Char>

OriginalParsedName

Internal use only

Declaration

public string OriginalParsedName { get; set; }

Property Value

Type	Description
System.String

OriginalTitle

Declaration

[IgnoreDataMember]
public string OriginalTitle { get; set; }

Property Value

Type	Description
System.String

Overview

Gets or sets the overview.

Declaration

[IgnoreDataMember]
public string Overview { get; set; }

Property Value

Type	Description
System.String	The overview.

OwnsFolder

Internal use only

Declaration

[IgnoreDataMember]
public bool OwnsFolder { get; set; }

Property Value

Type	Description
System.Boolean

Parent

Gets or sets the parent.

Declaration

[IgnoreDataMember]
public Folder Parent { get; set; }

Property Value

Type	Description
Folder	The parent.

ParentId

Declaration

[IgnoreDataMember]
public long ParentId { get; set; }

Property Value

Type	Description
System.Int64

ParentIndexNumber

For an episode this could be the season number, or for a song this could be the disc number.

Declaration

[IgnoreDataMember]
public int? ParentIndexNumber { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The parent index number.

Path

Gets or sets the path.

Declaration

[IgnoreDataMember]
public virtual string Path { get; set; }

Property Value

Type	Description
System.String	The path.

PathProtocol

Declaration

[IgnoreDataMember]
public MediaProtocol? PathProtocol { get; }

Property Value

Type	Description
System.Nullable<MediaProtocol>

PlaybackPositionTicks

Declaration

[IgnoreDataMember]
public long PlaybackPositionTicks { get; set; }

Property Value

Type	Description
System.Int64

PlayCount

Declaration

[IgnoreDataMember]
public int PlayCount { get; set; }

Property Value

Type	Description
System.Int32

Played

Declaration

[IgnoreDataMember]
public bool Played { get; set; }

Property Value

Type	Description
System.Boolean

PlayedPercentage

Declaration

public double? PlayedPercentage { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

PreferredMetadataCountryCode

Declaration

[IgnoreDataMember]
public string PreferredMetadataCountryCode { get; set; }

Property Value

Type	Description
System.String

PreferredMetadataLanguage

Declaration

[IgnoreDataMember]
public string PreferredMetadataLanguage { get; set; }

Property Value

Type	Description
System.String

Prefix

Declaration

[IgnoreDataMember]
public string Prefix { get; set; }

Property Value

Type	Description
System.String

PremiereDate

When the item first debuted. For movies this could be premiere date, episodes would be first aired

Declaration

[IgnoreDataMember]
public DateTimeOffset? PremiereDate { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTimeOffset>	The premiere date.

PresentationUniqueKey

Declaration

[IgnoreDataMember]
public string PresentationUniqueKey { get; set; }

Property Value

Type	Description
System.String

PrimaryImagePath

This is just a helper for convenience

Declaration

[IgnoreDataMember]
public string PrimaryImagePath { get; }

Property Value

Type	Description
System.String	The primary image path.

ProductionLocations

Declaration

[IgnoreDataMember]
public string[] ProductionLocations { get; set; }

Property Value

Type	Description
System.String[]

ProductionYear

Gets or sets the production year.

Declaration

[IgnoreDataMember]
public int? ProductionYear { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The production year.

ProviderIds

Gets or sets the provider ids.

Declaration

[IgnoreDataMember]
public ProviderIdDictionary ProviderIds { get; set; }

Property Value

Type	Description
ProviderIdDictionary	The provider ids.

ProviderManager

Declaration

public static IProviderManager ProviderManager { get; set; }

Property Value

Type	Description
IProviderManager

RecursiveChildCountEqualsChildCount

Declaration

public virtual bool RecursiveChildCountEqualsChildCount { get; }

Property Value

Type	Description
System.Boolean

RecursiveItemCount

Internal use only

Declaration

[IgnoreDataMember]
public int? RecursiveItemCount { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

RemoteTrailers

Declaration

[IgnoreDataMember]
public string[] RemoteTrailers { get; set; }

Property Value

Type	Description
System.String[]

ResolvedExtras

Internal use only

Declaration

[IgnoreDataMember]
public List<BaseItem> ResolvedExtras { get; set; }

Property Value

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

RunTimeTicks

Gets or sets the run time ticks.

Declaration

[IgnoreDataMember]
public long? RunTimeTicks { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>	The run time ticks.

SeriesId

Declaration

[IgnoreDataMember]
public long SeriesId { get; set; }

Property Value

Type	Description
System.Int64

SeriesPresentationUniqueKey

Declaration

[IgnoreDataMember]
public string SeriesPresentationUniqueKey { get; set; }

Property Value

Type	Description
System.String

ShareLevel

Declaration

[IgnoreDataMember]
public UserItemShareLevel? ShareLevel { get; set; }

Property Value

Type	Description
System.Nullable<UserItemShareLevel>

Size

Declaration

[IgnoreDataMember]
public long Size { get; set; }

Property Value

Type	Description
System.Int64

SortName

Gets the name of the sort.

Declaration

[IgnoreDataMember]
public string SortName { get; set; }

Property Value

Type	Description
System.String	The name of the sort.

SpecialFeatureCount

Internal use only

Declaration

[IgnoreDataMember]
public int? SpecialFeatureCount { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

StudioItems

Gets or sets the studios.

Declaration

[IgnoreDataMember]
public LinkedItemInfo[] StudioItems { get; set; }

Property Value

Type	Description
LinkedItemInfo[]	The studios.

Studios

Declaration

[IgnoreDataMember]
public string[] Studios { get; set; }

Property Value

Type	Description
System.String[]

SubtitleStreamIndex

Declaration

[IgnoreDataMember]
public int? SubtitleStreamIndex { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

SupportsAdditionalParts

Declaration

[IgnoreDataMember]
public virtual bool SupportsAdditionalParts { get; }

Property Value

Type	Description
System.Boolean

SupportsAncestors

Declaration

[IgnoreDataMember]
public virtual bool SupportsAncestors { get; }

Property Value

Type	Description
System.Boolean

SupportsCollections

Declaration

[IgnoreDataMember]
public virtual bool SupportsCollections { get; }

Property Value

Type	Description
System.Boolean

SupportsEditingAlbum

Declaration

[IgnoreDataMember]
public virtual bool SupportsEditingAlbum { get; }

Property Value

Type	Description
System.Boolean

SupportsExternalTransfer

Declaration

[IgnoreDataMember]
public virtual bool SupportsExternalTransfer { get; }

Property Value

Type	Description
System.Boolean

SupportsExtras

Declaration

[IgnoreDataMember]
public virtual bool SupportsExtras { get; }

Property Value

Type	Description
System.Boolean

SupportsGenres

Declaration

[IgnoreDataMember]
public virtual bool SupportsGenres { get; }

Property Value

Type	Description
System.Boolean

SupportsInheritedParentImages

Declaration

[IgnoreDataMember]
public virtual bool SupportsInheritedParentImages { get; }

Property Value

Type	Description
System.Boolean

SupportsLocalTrailers

Declaration

[IgnoreDataMember]
public virtual bool SupportsLocalTrailers { get; }

Property Value

Type	Description
System.Boolean

SupportsOwnedItems

Declaration

[IgnoreDataMember]
public virtual bool SupportsOwnedItems { get; }

Property Value

Type	Description
System.Boolean

SupportsPeople

Declaration

[IgnoreDataMember]
public virtual bool SupportsPeople { get; }

Property Value

Type	Description
System.Boolean

SupportsRemoteImageDownloading

Declaration

[IgnoreDataMember]
public virtual bool SupportsRemoteImageDownloading { get; }

Property Value

Type	Description
System.Boolean

SupportsResetMetadata

Declaration

[IgnoreDataMember]
public virtual bool SupportsResetMetadata { get; }

Property Value

Type	Description
System.Boolean

SupportsStudios

Declaration

[IgnoreDataMember]
public virtual bool SupportsStudios { get; }

Property Value

Type	Description
System.Boolean

SupportsTags

Declaration

[IgnoreDataMember]
public virtual bool SupportsTags { get; }

Property Value

Type	Description
System.Boolean

SupportsThemeMedia

Declaration

[IgnoreDataMember]
public virtual bool SupportsThemeMedia { get; }

Property Value

Type	Description
System.Boolean

SupportsUserData

Declaration

[IgnoreDataMember]
public virtual bool SupportsUserData { get; }

Property Value

Type	Description
System.Boolean

SyncStatus

Declaration

[IgnoreDataMember]
public SyncJobItemStatus? SyncStatus { get; set; }

Property Value

Type	Description
System.Nullable<SyncJobItemStatus>

TagItems

Gets or sets the tags.

Declaration

[IgnoreDataMember]
public LinkedItemInfo[] TagItems { get; set; }

Property Value

Type	Description
LinkedItemInfo[]	The tags.

Tagline

Declaration

[IgnoreDataMember]
public string Tagline { get; set; }

Property Value

Type	Description
System.String

Tags

Declaration

[IgnoreDataMember]
public string[] Tags { get; set; }

Property Value

Type	Description
System.String[]

ThemeSongIds

Declaration

[IgnoreDataMember]
public Guid[] ThemeSongIds { get; }

Property Value

Type	Description
System.Guid[]

ThemeVideoIds

Declaration

[IgnoreDataMember]
public Guid[] ThemeVideoIds { get; }

Property Value

Type	Description
System.Guid[]

TotalBitrate

Declaration

[IgnoreDataMember]
public int TotalBitrate { get; set; }

Property Value

Type	Description
System.Int32

UnplayedItemCount

Declaration

[IgnoreDataMember]
public int? UnplayedItemCount { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

UserDataKey

Declaration

[IgnoreDataMember]
public string UserDataKey { get; set; }

Property Value

Type	Description
System.String

UserDataManager

Declaration

public static IUserDataManager UserDataManager { get; set; }

Property Value

Type	Description
IUserDataManager

UserDataSet

Declaration

[IgnoreDataMember]
public bool UserDataSet { get; set; }

Property Value

Type	Description
System.Boolean

UserManager

Declaration

public static IUserManager UserManager { get; set; }

Property Value

Type	Description
IUserManager

UserRating

Declaration

[IgnoreDataMember]
public double? UserRating { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

ValidatesChildren

Declaration

[IgnoreDataMember]
protected virtual bool ValidatesChildren { get; }

Property Value

Type	Description
System.Boolean

Width

Declaration

[IgnoreDataMember]
public int Width { get; set; }

Property Value

Type	Description
System.Int32

Methods

AddCollection(BoxSet)

Declaration

public bool AddCollection(BoxSet newEntry)

Parameters

Type	Name	Description
BoxSet	newEntry

Returns

Type	Description
System.Boolean

AddCollection(LinkedItemInfo)

Declaration

public void AddCollection(LinkedItemInfo newEntry)

Parameters

Type	Name	Description
LinkedItemInfo	newEntry

AddCollection(String)

Declaration

public LinkedItemInfo AddCollection(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
LinkedItemInfo

AddCollectionInfo(LinkedItemInfo)

Declaration

public bool AddCollectionInfo(LinkedItemInfo newEntry)

Parameters

Type	Name	Description
LinkedItemInfo	newEntry

Returns

Type	Description
System.Boolean

AddGenre(String)

Adds a genre to the item

Declaration

public void AddGenre(string name)

Parameters

Type	Name	Description
System.String	name	The name.

Exceptions

Type	Condition
System.ArgumentNullException

AddImage(FileSystemMetadata, ImageType)

Declaration

public void AddImage(FileSystemMetadata file, ImageType type)

Parameters

Type	Name	Description
FileSystemMetadata	file
ImageType	type

AddImages(ImageType, List<FileSystemMetadata>, Boolean)

Adds the images.

Declaration

public bool AddImages(ImageType imageType, List<FileSystemMetadata> images, bool deleteMissingImages)

Parameters

Type	Name	Description
ImageType	imageType
System.Collections.Generic.List<FileSystemMetadata>	images
System.Boolean	deleteMissingImages

Returns

Type	Description
System.Boolean

AddImportedCollections(LinkedItemInfo[])

Declaration

public void AddImportedCollections(LinkedItemInfo[] collections)

Parameters

Type	Name	Description
LinkedItemInfo[]	collections

AddLinkedItem(LinkedItemInfo[], LinkedItemInfo)

Declaration

public static LinkedItemInfo[] AddLinkedItem(LinkedItemInfo[] items, LinkedItemInfo newEntry)

Parameters

Type	Name	Description
LinkedItemInfo[]	items
LinkedItemInfo	newEntry

Returns

Type	Description
LinkedItemInfo[]

AddLinkedItem(LinkedItemInfo[], LinkedItemInfo, out LinkedItemInfo, out Boolean)

Declaration

public static LinkedItemInfo[] AddLinkedItem(LinkedItemInfo[] items, LinkedItemInfo newEntry, out LinkedItemInfo addedOrUpdatedItem, out bool listChanged)

Parameters

Type	Name	Description
LinkedItemInfo[]	items
LinkedItemInfo	newEntry
LinkedItemInfo	addedOrUpdatedItem
System.Boolean	listChanged

Returns

Type	Description
LinkedItemInfo[]

AddLinkedItem(LinkedItemInfo[], String)

Declaration

public static LinkedItemInfo[] AddLinkedItem(LinkedItemInfo[] items, string name)

Parameters

Type	Name	Description
LinkedItemInfo[]	items
System.String	name

Returns

Type	Description
LinkedItemInfo[]

AddLinkedItem(LinkedItemInfo[], String, out LinkedItemInfo, out Boolean)

Declaration

public static LinkedItemInfo[] AddLinkedItem(LinkedItemInfo[] items, string name, out LinkedItemInfo addedOrUpdatedItem, out bool listChanged)

Parameters

Type	Name	Description
LinkedItemInfo[]	items
System.String	name
LinkedItemInfo	addedOrUpdatedItem
System.Boolean	listChanged

Returns

Type	Description
LinkedItemInfo[]

AddProviderIdsToName(String, String[])

Declaration

protected string AddProviderIdsToName(string name, string[] providerIds)

Parameters

Type	Name	Description
System.String	name
System.String[]	providerIds

Returns

Type	Description
System.String

AddStudio(String)

Adds a studio to the item

Declaration

public void AddStudio(string name)

Parameters

Type	Name	Description
System.String	name	The name.

Exceptions

Type	Condition
System.ArgumentNullException

AfterMetadataRefresh()

Declaration

public void AfterMetadataRefresh()

AllowEditingField(MetadataFields)

Declaration

public virtual bool AllowEditingField(MetadataFields field)

Parameters

Type	Name	Description
MetadataFields	field

Returns

Type	Description
System.Boolean

AllowsMultipleImages(ImageType)

Declaration

public bool AllowsMultipleImages(ImageType type)

Parameters

Type	Name	Description
ImageType	type

Returns

Type	Description
System.Boolean

AssertHasMinimumShareLevel(User, UserItemShareLevel)

Declaration

public void AssertHasMinimumShareLevel(User user, UserItemShareLevel shareLevel)

Parameters

Type	Name	Description
User	user
UserItemShareLevel	shareLevel

BeforeMetadataRefresh(Boolean)

This is called before any metadata refresh and returns true or false indicating if changes were made

Declaration

public virtual bool BeforeMetadataRefresh(bool replaceAllMetdata)

Parameters

Type	Name	Description
System.Boolean	replaceAllMetdata

Returns

Type	Description
System.Boolean

CanDelete()

Declaration

public virtual bool CanDelete()

Returns

Type	Description
System.Boolean

CanDelete(User, Folder[])

Declaration

public bool CanDelete(User user, Folder[] collectionFolders)

Parameters

Type	Name	Description
User	user
Folder[]	collectionFolders

Returns

Type	Description
System.Boolean

CanDelete(User, UserItemShareLevel, Folder[])

Declaration

public bool CanDelete(User user, UserItemShareLevel shareLevel, Folder[] collectionFolders)

Parameters

Type	Name	Description
User	user
UserItemShareLevel	shareLevel
Folder[]	collectionFolders

Returns

Type	Description
System.Boolean

CanDownload()

Declaration

public virtual bool CanDownload()

Returns

Type	Description
System.Boolean

CanDownload(User)

Declaration

public bool CanDownload(User user)

Parameters

Type	Name	Description
User	user

Returns

Type	Description
System.Boolean

CanDownloadAsFolder()

Declaration

protected virtual bool CanDownloadAsFolder()

Returns

Type	Description
System.Boolean

CanDownloadAsSingleMedia()

Declaration

protected virtual bool CanDownloadAsSingleMedia()

Returns

Type	Description
System.Boolean

CanLeaveSharedContent(User, UserItemShareLevel)

Declaration

public virtual bool CanLeaveSharedContent(User user, UserItemShareLevel shareLevel)

Parameters

Type	Name	Description
User	user
UserItemShareLevel	shareLevel

Returns

Type	Description
System.Boolean

CanMakePrivate(User)

Declaration

public bool CanMakePrivate(User user)

Parameters

Type	Name	Description
User	user

Returns

Type	Description
System.Boolean

CanMakePrivate(UserItemShareLevel)

Declaration

public bool CanMakePrivate(UserItemShareLevel shareLevel)

Parameters

Type	Name	Description
UserItemShareLevel	shareLevel

Returns

Type	Description
System.Boolean

CanMakePublic(User)

Declaration

public bool CanMakePublic(User user)

Parameters

Type	Name	Description
User	user

Returns

Type	Description
System.Boolean

CanMakePublic(UserItemShareLevel)

Declaration

public bool CanMakePublic(UserItemShareLevel shareLevel)

Parameters

Type	Name	Description
UserItemShareLevel	shareLevel

Returns

Type	Description
System.Boolean

CanManageAccess(User, UserItemShareLevel)

Declaration

public virtual bool CanManageAccess(User user, UserItemShareLevel shareLevel)

Parameters

Type	Name	Description
User	user
UserItemShareLevel	shareLevel

Returns

Type	Description
System.Boolean

ContainsTag(String)

Declaration

public bool ContainsTag(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Boolean

CreatePresentationUniqueKey(BaseItem[], LibraryOptions, IDataContext)

Declaration

public virtual string CreatePresentationUniqueKey(BaseItem[] collectionFolders, LibraryOptions libraryOptions, IDataContext dataContext)

Parameters

Type	Name	Description
BaseItem[]	collectionFolders
LibraryOptions	libraryOptions
IDataContext	dataContext

Returns

Type	Description
System.String

CreatePresentationUniqueKey(IDataContext)

Declaration

public string CreatePresentationUniqueKey(IDataContext dataContext)

Parameters

Type	Name	Description
IDataContext	dataContext

Returns

Type	Description
System.String

CreateSortName()

Creates the name of the sort.

Declaration

protected virtual ReadOnlySpan<char> CreateSortName()

Returns

Type	Description
System.ReadOnlySpan<System.Char>	System.String.

CreateSortName(ReadOnlySpan<Char>)

Declaration

protected ReadOnlySpan<char> CreateSortName(ReadOnlySpan<char> text)

Parameters

Type	Name	Description
System.ReadOnlySpan<System.Char>	text

Returns

Type	Description
System.ReadOnlySpan<System.Char>

DeleteImage(ImageType, Int32)

Deletes the image.

Declaration

public void DeleteImage(ImageType type, int index)

Parameters

Type	Name	Description
ImageType	type	The type.
System.Int32	index	The index.

EnableImageCaching(LibraryOptions)

Declaration

public virtual bool EnableImageCaching(LibraryOptions libraryOptions)

Parameters

Type	Name	Description
LibraryOptions	libraryOptions

Returns

Type	Description
System.Boolean

EnsureTaggedItemsLoaded()

Declaration

public void EnsureTaggedItemsLoaded()

EnsureTaggedItemsLoaded(IDataContext)

Declaration

public void EnsureTaggedItemsLoaded(IDataContext dataContext)

Parameters

Type	Name	Description
IDataContext	dataContext

FillItemLinks(List<(ItemLinkType, String, Int64)>)

Declaration

public virtual void FillItemLinks(List<(ItemLinkType, string, long)> itemLinks)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.ValueTuple<ItemLinkType, System.String, System.Int64>>	itemLinks

FillUserDataDtoValues(UserItemDataDto, User, DtoOptions, LibraryOptions)

Declaration

public virtual void FillUserDataDtoValues(UserItemDataDto dto, User user, DtoOptions options, LibraryOptions libraryOptions)

Parameters

Type	Name	Description
UserItemDataDto	dto
User	user
DtoOptions	options
LibraryOptions	libraryOptions

FillUserDataValues(User, DtoOptions, LibraryOptions, IDataContext)

Declaration

public virtual void FillUserDataValues(User user, DtoOptions options, LibraryOptions libraryOptions, IDataContext dataContext)

Parameters

Type	Name	Description
User	user
DtoOptions	options
LibraryOptions	libraryOptions
IDataContext	dataContext

FindParent<T>()

Finds a parent of a given type

Declaration

public T FindParent<T>()
    where T : BaseItem

Returns

Type	Description
T	``0.

Type Parameters

Name	Description
T

FindParent<T>(IDataContext)

Declaration

public T FindParent<T>(IDataContext dataContext)
    where T : BaseItem

Parameters

Type	Name	Description
IDataContext	dataContext

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetAdditionalPartIds()

Declaration

public long[] GetAdditionalPartIds()

Returns

Type	Description
System.Int64[]

GetAdditionalParts(DtoOptions, User)

Declaration

public BaseItem[] GetAdditionalParts(DtoOptions options, User user)

Parameters

Type	Name	Description
DtoOptions	options
User	user

Returns

Type	Description
BaseItem[]

GetAlbumItem(IDataContext)

Declaration

protected LinkedItemInfo GetAlbumItem(IDataContext dataContext)

Parameters

Type	Name	Description
IDataContext	dataContext

Returns

Type	Description
LinkedItemInfo

GetAllItemsForMediaSources(User, Boolean)

Declaration

protected virtual 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>>

GetAllKnownCollections()

Declaration

public List<LinkedItemInfo> GetAllKnownCollections()

Returns

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

GetApiImageUrl(ItemImageInfo, Int32, ApiImageOptions, String)

Declaration

public string GetApiImageUrl(ItemImageInfo imageInfo, int imageIndex, ApiImageOptions options, string serverUrl)

Parameters

Type	Name	Description
ItemImageInfo	imageInfo
System.Int32	imageIndex
ApiImageOptions	options
System.String	serverUrl

Returns

Type	Description
System.String

GetCachedParent()

Declaration

public BaseItem GetCachedParent()

Returns

Type	Description
BaseItem

GetChildCount(User, IDataContext)

Declaration

public virtual int GetChildCount(User user, IDataContext dataContext)

Parameters

Type	Name	Description
User	user
IDataContext	dataContext

Returns

Type	Description
System.Int32

GetChildrenForValidation()

Declaration

protected virtual BaseItem[] GetChildrenForValidation()

Returns

Type	Description
BaseItem[]

GetChildrenForValidationSorted()

Declaration

public BaseItem[] GetChildrenForValidationSorted()

Returns

Type	Description
BaseItem[]

GetClientId()

Declaration

public string GetClientId()

Returns

Type	Description
System.String

GetClientTypeName()

Declaration

public virtual string GetClientTypeName()

Returns

Type	Description
System.String

GetDefaultMediaSourceId()

Declaration

public string GetDefaultMediaSourceId()

Returns

Type	Description
System.String

GetDefaultPresentationUniqueKey()

Declaration

protected string GetDefaultPresentationUniqueKey()

Returns

Type	Description
System.String

GetDefaultPrimaryImageAspectRatio()

Declaration

public virtual double GetDefaultPrimaryImageAspectRatio()

Returns

Type	Description
System.Double

GetDeletePaths(Boolean, BaseItem[])

Gets the file system path to delete when the item is to be deleted

Declaration

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

Parameters

Type	Name	Description
System.Boolean	mediaFilesOnly
BaseItem[]	collectionFolders

Returns

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

GetDisplayExtraIds()

Declaration

public long[] GetDisplayExtraIds()

Returns

Type	Description
System.Int64[]

GetDisplayOrderIntValue()

Declaration

public virtual int? GetDisplayOrderIntValue()

Returns

Type	Description
System.Nullable<System.Int32>

GetEtag(User)

Declaration

public string GetEtag(User user)

Parameters

Type	Name	Description
User	user

Returns

Type	Description
System.String

GetEtagValues(User)

Declaration

protected virtual List<string> GetEtagValues(User user)

Parameters

Type	Name	Description
User	user

Returns

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

GetExtraGuids(ExtraType[])

Declaration

public Guid[] GetExtraGuids(ExtraType[] extraTypes)

Parameters

Type	Name	Description
ExtraType[]	extraTypes

Returns

Type	Description
System.Guid[]

GetExtraIds(ExtraType[])

Declaration

public long[] GetExtraIds(ExtraType[] extraTypes)

Parameters

Type	Name	Description
ExtraType[]	extraTypes

Returns

Type	Description
System.Int64[]

GetExtras(ExtraType[])

Declaration

public BaseItem[] GetExtras(ExtraType[] extraTypes)

Parameters

Type	Name	Description
ExtraType[]	extraTypes

Returns

Type	Description
BaseItem[]

GetExtras(ExtraType[], DtoOptions)

Declaration

public BaseItem[] GetExtras(ExtraType[] extraTypes, DtoOptions options)

Parameters

Type	Name	Description
ExtraType[]	extraTypes
DtoOptions	options

Returns

Type	Description
BaseItem[]

GetExtras(Int64, ExtraType[], DtoOptions)

Declaration

public static BaseItem[] GetExtras(long internalId, ExtraType[] extraTypes, DtoOptions options)

Parameters

Type	Name	Description
System.Int64	internalId
ExtraType[]	extraTypes
DtoOptions	options

Returns

Type	Description
BaseItem[]

GetExtras(Int64, String, ExtraType[], DtoOptions)

Declaration

public BaseItem[] GetExtras(long internalId, string presentationUniqueKey, ExtraType[] extraTypes, DtoOptions options)

Parameters

Type	Name	Description
System.Int64	internalId
System.String	presentationUniqueKey
ExtraType[]	extraTypes
DtoOptions	options

Returns

Type	Description
BaseItem[]

GetExtraTypes(ExtraType[])

Declaration

public ExtraType[] GetExtraTypes(ExtraType[] extraTypes)

Parameters

Type	Name	Description
ExtraType[]	extraTypes

Returns

Type	Description
ExtraType[]

GetFileSystemChildren(IDirectoryService)

Declaration

public virtual FileSystemMetadata[] GetFileSystemChildren(IDirectoryService directoryService)

Parameters

Type	Name	Description
IDirectoryService	directoryService

Returns

Type	Description
FileSystemMetadata[]

GetIdsForAncestorIdsQuery(User, IDataContext)

Declaration

public virtual long[] GetIdsForAncestorIdsQuery(User user, IDataContext dataContext)

Parameters

Type	Name	Description
User	user
IDataContext	dataContext

Returns

Type	Description
System.Int64[]

GetImageInfo(ImageType, Int32)

Gets the image information.

Declaration

public ItemImageInfo GetImageInfo(ImageType imageType, int imageIndex)

Parameters

Type	Name	Description
ImageType	imageType	Type of the image.
System.Int32	imageIndex	Index of the image.

Returns

Type	Description
ItemImageInfo	ItemImageInfo.

GetImagePath(ImageType, Int32)

Gets the image path.

Declaration

public string GetImagePath(ImageType imageType, int imageIndex)

Parameters

Type	Name	Description
ImageType	imageType	Type of the image.
System.Int32	imageIndex	Index of the image.

Returns

Type	Description
System.String	System.String.

Exceptions

Type	Condition
System.InvalidOperationException
System.ArgumentNullException	item

GetImages(ImageType)

Declaration

public IEnumerable<ItemImageInfo> GetImages(ImageType imageType)

Parameters

Type	Name	Description
ImageType	imageType

Returns

Type	Description
System.Collections.Generic.IEnumerable<ItemImageInfo>

GetImportedCollections()

Declaration

public LinkedItemInfo[] GetImportedCollections()

Returns

Type	Description
LinkedItemInfo[]

GetInheritedParentalRatingValue()

Only used by plugins at this point

Declaration

public int? GetInheritedParentalRatingValue()

Returns

Type	Description
System.Nullable<System.Int32>

GetInternalMetadataPath()

Declaration

public string GetInternalMetadataPath()

Returns

Type	Description
System.String

GetInternalMetadataPath(Guid, String)

Declaration

protected static string GetInternalMetadataPath(Guid itemId, string basePath)

Parameters

Type	Name	Description
System.Guid	itemId
System.String	basePath

Returns

Type	Description
System.String

GetInternalMetadataPath(String)

Declaration

protected virtual string GetInternalMetadataPath(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Returns

Type	Description
System.String

GetItemLookupInfo<T>(LibraryOptions)

Declaration

protected T GetItemLookupInfo<T>(LibraryOptions libraryOptions)
    where T : ItemLookupInfo, new()

Parameters

Type	Name	Description
LibraryOptions	libraryOptions

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetItemsForAncestorIdsQuery(User, IDataContext)

Declaration

public virtual BaseItem[] GetItemsForAncestorIdsQuery(User user, IDataContext dataContext)

Parameters

Type	Name	Description
User	user
IDataContext	dataContext

Returns

Type	Description
BaseItem[]

GetLocalApiImageUrl(ItemImageInfo, Int32, ApiImageOptions, CancellationToken)

Declaration

public async Task<string> GetLocalApiImageUrl(ItemImageInfo imageInfo, int imageIndex, ApiImageOptions options, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ItemImageInfo	imageInfo
System.Int32	imageIndex
ApiImageOptions	options
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

GetMappedPath(String, Nullable<MediaProtocol>, LibraryOptions)

Declaration

protected static string GetMappedPath(string path, MediaProtocol? protocol, LibraryOptions libraryOptions)

Parameters

Type	Name	Description
System.String	path
System.Nullable<MediaProtocol>	protocol
LibraryOptions	libraryOptions

Returns

Type	Description
System.String

GetMediaContainingFolderPath(LibraryOptions)

Declaration

public virtual string GetMediaContainingFolderPath(LibraryOptions libraryOptions)

Parameters

Type	Name	Description
LibraryOptions	libraryOptions

Returns

Type	Description
System.String

GetMediaSources(User, Boolean, Boolean, Boolean, LibraryOptions)

Declaration

public virtual List<MediaSourceInfo> GetMediaSources(User user, bool enableAlternateMediaSources, bool enablePathSubstitution, bool fillChapters, LibraryOptions libraryOptions)

Parameters

Type	Name	Description
User	user
System.Boolean	enableAlternateMediaSources
System.Boolean	enablePathSubstitution
System.Boolean	fillChapters
LibraryOptions	libraryOptions

Returns

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

GetMediaSources(Boolean, Boolean, LibraryOptions)

GetMediaSources This overload is for CoverArt

Declaration

public virtual List<MediaSourceInfo> GetMediaSources(bool enableAlternateMediaSources, bool enablePathSubstitution, LibraryOptions libraryOptions)

Parameters

Type	Name	Description
System.Boolean	enableAlternateMediaSources
System.Boolean	enablePathSubstitution
LibraryOptions	libraryOptions

Returns

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

GetMediaStreams()

Declaration

public virtual List<MediaStream> GetMediaStreams()

Returns

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

GetNameForMetadataLookup()

Declaration

protected virtual string GetNameForMetadataLookup()

Returns

Type	Description
System.String

GetNonCachedChildren(IDirectoryService, LibraryOptions)

Get the children of this folder from the actual file system

Declaration

protected virtual List<BaseItem> GetNonCachedChildren(IDirectoryService directoryService, LibraryOptions libraryOptions)

Parameters

Type	Name	Description
IDirectoryService	directoryService
LibraryOptions	libraryOptions

Returns

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

GetParent()

Declaration

public BaseItem GetParent()

Returns

Type	Description
BaseItem

GetParent(IDataContext)

Declaration

public BaseItem GetParent(IDataContext dataContext)

Parameters

Type	Name	Description
IDataContext	dataContext

Returns

Type	Description
BaseItem

GetParentalRatingValue()

Declaration

public int? GetParentalRatingValue()

Returns

Type	Description
System.Nullable<System.Int32>

GetParents()

Declaration

public IEnumerable<BaseItem> GetParents()

Returns

Type	Description
System.Collections.Generic.IEnumerable<BaseItem>

GetParents(IDataContext)

Declaration

public IEnumerable<BaseItem> GetParents(IDataContext dataContext)

Parameters

Type	Name	Description
IDataContext	dataContext

Returns

Type	Description
System.Collections.Generic.IEnumerable<BaseItem>

GetPreferredImageLanguage(LibraryOptions)

Declaration

public string GetPreferredImageLanguage(LibraryOptions libraryOptions)

Parameters

Type	Name	Description
LibraryOptions	libraryOptions

Returns

Type	Description
System.String

GetPreferredMetadataCountryCode()

Declaration

public string GetPreferredMetadataCountryCode()

Returns

Type	Description
System.String

GetPreferredMetadataCountryCode(LibraryOptions)

Gets the preferred metadata language.

Declaration

public string GetPreferredMetadataCountryCode(LibraryOptions libraryOptions)

Parameters

Type	Name	Description
LibraryOptions	libraryOptions

Returns

Type	Description
System.String	System.String.

GetPreferredMetadataLanguage()

Declaration

public string GetPreferredMetadataLanguage()

Returns

Type	Description
System.String

GetPreferredMetadataLanguage(LibraryOptions)

Gets the preferred metadata language.

Declaration

public string GetPreferredMetadataLanguage(LibraryOptions libraryOptions)

Parameters

Type	Name	Description
LibraryOptions	libraryOptions

Returns

Type	Description
System.String	System.String.

GetPreferredMetadataLanguage(LibraryOptions, IDataContext)

Declaration

public string GetPreferredMetadataLanguage(LibraryOptions libraryOptions, IDataContext dataContext)

Parameters

Type	Name	Description
LibraryOptions	libraryOptions
IDataContext	dataContext

Returns

Type	Description
System.String

GetPresentationUniqueKey()

Declaration

public string GetPresentationUniqueKey()

Returns

Type	Description
System.String

GetPresentationUniqueKey(BaseItem[], LibraryOptions, IDataContext)

Declaration

public string GetPresentationUniqueKey(BaseItem[] collectionFolders, LibraryOptions libraryOptions, IDataContext dataContext)

Parameters

Type	Name	Description
BaseItem[]	collectionFolders
LibraryOptions	libraryOptions
IDataContext	dataContext

Returns

Type	Description
System.String

GetRecursiveChildCount(User, IDataContext)

Declaration

public virtual int GetRecursiveChildCount(User user, IDataContext dataContext)

Parameters

Type	Name	Description
User	user
IDataContext	dataContext

Returns

Type	Description
System.Int32

GetRefreshProgress()

Declaration

public virtual double? GetRefreshProgress()

Returns

Type	Description
System.Nullable<System.Double>

GetRelatedUrls()

Declaration

public virtual List<ExternalUrl> GetRelatedUrls()

Returns

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

GetRemoteApiImageUrl(ItemImageInfo, Int32, ApiImageOptions)

Declaration

public string GetRemoteApiImageUrl(ItemImageInfo imageInfo, int imageIndex, ApiImageOptions options)

Parameters

Type	Name	Description
ItemImageInfo	imageInfo
System.Int32	imageIndex
ApiImageOptions	options

Returns

Type	Description
System.String

GetRunTimeTicksForPlayState()

Declaration

public virtual long GetRunTimeTicksForPlayState()

Returns

Type	Description
System.Int64

GetShareLevel(User)

Declaration

public UserItemShareLevel GetShareLevel(User user)

Parameters

Type	Name	Description
User	user

Returns

Type	Description
UserItemShareLevel

GetStandaloneDisplayName()

Declaration

public virtual string GetStandaloneDisplayName()

Returns

Type	Description
System.String

GetSupportedItemLinkTypes()

Declaration

public virtual List<ItemLinkType> GetSupportedItemLinkTypes()

Returns

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

GetSupportsPositionTicksResume(LibraryOptions)

Declaration

public virtual bool GetSupportsPositionTicksResume(LibraryOptions libraryOptions)

Parameters

Type	Name	Description
LibraryOptions	libraryOptions

Returns

Type	Description
System.Boolean

GetThemeSongs(DtoOptions)

Declaration

public BaseItem[] GetThemeSongs(DtoOptions options)

Parameters

Type	Name	Description
DtoOptions	options

Returns

Type	Description
BaseItem[]

GetThemeVideos(DtoOptions)

Declaration

public BaseItem[] GetThemeVideos(DtoOptions options)

Parameters

Type	Name	Description
DtoOptions	options

Returns

Type	Description
BaseItem[]

GetTopParent()

Declaration

public BaseItem GetTopParent()

Returns

Type	Description
BaseItem

GetUniquelyIdentifiableProviderIds()

Declaration

public ProviderIdDictionary GetUniquelyIdentifiableProviderIds()

Returns

Type	Description
ProviderIdDictionary

GetUserDataKey(IDataContext)

Declaration

public string GetUserDataKey(IDataContext dataContext)

Parameters

Type	Name	Description
IDataContext	dataContext

Returns

Type	Description
System.String

GetUserDataKeyInternal(IDataContext)

Declaration

protected virtual string GetUserDataKeyInternal(IDataContext dataContext)

Parameters

Type	Name	Description
IDataContext	dataContext

Returns

Type	Description
System.String

HasDateChanged(DateTimeOffset, DateTimeOffset)

Declaration

public static bool HasDateChanged(DateTimeOffset date, DateTimeOffset newValue)

Parameters

Type	Name	Description
System.DateTimeOffset	date
System.DateTimeOffset	newValue

Returns

Type	Description
System.Boolean

HasDateChanged(Nullable<DateTimeOffset>, DateTimeOffset)

Declaration

public static bool HasDateChanged(DateTimeOffset? date, DateTimeOffset newValue)

Parameters

Type	Name	Description
System.Nullable<System.DateTimeOffset>	date
System.DateTimeOffset	newValue

Returns

Type	Description
System.Boolean

HasDateChanged(Nullable<DateTimeOffset>, Nullable<DateTimeOffset>)

Declaration

public static bool HasDateChanged(DateTimeOffset? date, DateTimeOffset? newValue)

Parameters

Type	Name	Description
System.Nullable<System.DateTimeOffset>	date
System.Nullable<System.DateTimeOffset>	newValue

Returns

Type	Description
System.Boolean

HasDateModifiedChanged(DateTimeOffset)

Declaration

public bool HasDateModifiedChanged(DateTimeOffset newValue)

Parameters

Type	Name	Description
System.DateTimeOffset	newValue

Returns

Type	Description
System.Boolean

HasImage(ImageType, Int32)

Gets an image

Declaration

public bool HasImage(ImageType type, int imageIndex)

Parameters

Type	Name	Description
ImageType	type	The type.
System.Int32	imageIndex	Index of the image.

Returns

Type	Description
System.Boolean	true if the specified type has image; otherwise, false.

Exceptions

Type	Condition
System.ArgumentException	Backdrops should be accessed using Item.Backdrops

HasPlaceholderMatadata()

Declaration

public virtual bool HasPlaceholderMatadata()

Returns

Type	Description
System.Boolean

IsActiveRecording()

Declaration

public virtual bool IsActiveRecording()

Returns

Type	Description
System.Boolean

IsAuthorizedToDelete(User, UserItemShareLevel, Folder[])

Declaration

public virtual bool IsAuthorizedToDelete(User user, UserItemShareLevel shareLevel, Folder[] collectionFolders)

Parameters

Type	Name	Description
User	user
UserItemShareLevel	shareLevel
Folder[]	collectionFolders

Returns

Type	Description
System.Boolean

IsAuthorizedToDownload(User)

Declaration

public virtual bool IsAuthorizedToDownload(User user)

Parameters

Type	Name	Description
User	user

Returns

Type	Description
System.Boolean

IsFavoriteOrLiked(User)

Declaration

public bool IsFavoriteOrLiked(User user)

Parameters

Type	Name	Description
User	user

Returns

Type	Description
System.Boolean

IsFieldLocked(MetadataFields)

Declaration

public bool IsFieldLocked(MetadataFields field)

Parameters

Type	Name	Description
MetadataFields	field

Returns

Type	Description
System.Boolean

IsFileShortcut(String)

Declaration

public static bool IsFileShortcut(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
System.Boolean

IsGreaterThanDateLastSaved(DateTimeOffset)

Declaration

public bool IsGreaterThanDateLastSaved(DateTimeOffset newValue)

Parameters

Type	Name	Description
System.DateTimeOffset	newValue

Returns

Type	Description
System.Boolean

IsImageFetcherEnabled(LibraryOptions, String)

Declaration

public bool IsImageFetcherEnabled(LibraryOptions libraryOptions, string name)

Parameters

Type	Name	Description
LibraryOptions	libraryOptions
System.String	name

Returns

Type	Description
System.Boolean

IsLocalMetadataReaderEnabled(LibraryOptions, String)

Declaration

public virtual bool IsLocalMetadataReaderEnabled(LibraryOptions libraryOptions, string name)

Parameters

Type	Name	Description
LibraryOptions	libraryOptions
System.String	name

Returns

Type	Description
System.Boolean

IsMetadataFetcherEnabled(LibraryOptions, String)

Declaration

public bool IsMetadataFetcherEnabled(LibraryOptions libraryOptions, string name)

Parameters

Type	Name	Description
LibraryOptions	libraryOptions
System.String	name

Returns

Type	Description
System.Boolean

IsPathProtocol(MediaProtocol)

Declaration

public bool IsPathProtocol(MediaProtocol protocol)

Parameters

Type	Name	Description
MediaProtocol	protocol

Returns

Type	Description
System.Boolean

IsPlayed(User)

Declaration

public virtual bool IsPlayed(User user)

Parameters

Type	Name	Description
User	user

Returns

Type	Description
System.Boolean

IsSaveLocalImagesEnabled(LibraryOptions)

Declaration

public virtual bool IsSaveLocalImagesEnabled(LibraryOptions libraryOptions)

Parameters

Type	Name	Description
LibraryOptions	libraryOptions

Returns

Type	Description
System.Boolean

IsUnplayed(User)

Declaration

public virtual bool IsUnplayed(User user)

Parameters

Type	Name	Description
User	user

Returns

Type	Description
System.Boolean

IsVisible(User)

Determines if this folder should be visible to a given user. Default is just parental allowed. Can be overridden for more functionality.

Declaration

public virtual bool IsVisible(User user)

Parameters

Type	Name	Description
User	user	The user.

Returns

Type	Description
System.Boolean	true if the specified user is visible; otherwise, false.

Exceptions

Type	Condition
System.ArgumentNullException	user

IsVisibleStandalone(User)

Declaration

public bool IsVisibleStandalone(User user)

Parameters

Type	Name	Description
User	user

Returns

Type	Description
System.Boolean

MarkPlayed(User, BaseItem[], Nullable<DateTimeOffset>, Boolean)

Marks the played.

Declaration

public virtual void MarkPlayed(User user, BaseItem[] collectionFolders, DateTimeOffset? datePlayed, bool resetPosition)

Parameters

Type	Name	Description
User	user
BaseItem[]	collectionFolders
System.Nullable<System.DateTimeOffset>	datePlayed
System.Boolean	resetPosition

MarkPlayed(User, Nullable<DateTimeOffset>, Boolean)

Declaration

public void MarkPlayed(User user, DateTimeOffset? datePlayed, bool resetPosition)

Parameters

Type	Name	Description
User	user
System.Nullable<System.DateTimeOffset>	datePlayed
System.Boolean	resetPosition

MarkTaggedItemsLoaded()

Declaration

public void MarkTaggedItemsLoaded()

MarkUnplayed(User)

Marks the unplayed.

Declaration

public virtual void MarkUnplayed(User user)

Parameters

Type	Name	Description
User	user	The user.

Exceptions

Type	Condition
System.ArgumentNullException

MoveFiles(String[], String[])

Declaration

public void MoveFiles(string[] list1, string[] list2)

Parameters

Type	Name	Description
System.String[]	list1
System.String[]	list2

RefreshMetadata(BaseItem[], LibraryOptions, CancellationToken)

Declaration

public Task RefreshMetadata(BaseItem[] collectionFolders, LibraryOptions libraryOptions, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BaseItem[]	collectionFolders
LibraryOptions	libraryOptions
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

RefreshMetadata(MetadataRefreshOptions, BaseItem[], LibraryOptions, CancellationToken)

Declaration

public async Task<ItemUpdateType> RefreshMetadata(MetadataRefreshOptions options, BaseItem[] collectionFolders, LibraryOptions libraryOptions, CancellationToken cancellationToken)

Parameters

Type	Name	Description
MetadataRefreshOptions	options
BaseItem[]	collectionFolders
LibraryOptions	libraryOptions
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<ItemUpdateType>

RefreshMetadata(MetadataRefreshOptions, CancellationToken)

Overrides the base implementation to refresh metadata for local trailers

Declaration

public Task<ItemUpdateType> RefreshMetadata(MetadataRefreshOptions options, CancellationToken cancellationToken)

Parameters

Type	Name	Description
MetadataRefreshOptions	options	The options.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<ItemUpdateType>	true if a provider reports we changed

RefreshMetadata(CancellationToken)

Declaration

public Task RefreshMetadata(CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

RemoveCollection(Int64)

Declaration

public bool RemoveCollection(long collectionId)

Parameters

Type	Name	Description
System.Int64	collectionId

Returns

Type	Description
System.Boolean

RemoveImage(ItemImageInfo)

Declaration

public void RemoveImage(ItemImageInfo image)

Parameters

Type	Name	Description
ItemImageInfo	image

RemoveImage(ImageType, String)

Declaration

public void RemoveImage(ImageType type, string path)

Parameters

Type	Name	Description
ImageType	type
System.String	path

RemoveImages(List<ItemImageInfo>)

Declaration

public void RemoveImages(List<ItemImageInfo> deletedImages)

Parameters

Type	Name	Description
System.Collections.Generic.List<ItemImageInfo>	deletedImages

RemoveLinkedItem(LinkedItemInfo[], LinkedItemInfo)

Declaration

public static LinkedItemInfo[] RemoveLinkedItem(LinkedItemInfo[] items, LinkedItemInfo itemToRemove)

Parameters

Type	Name	Description
LinkedItemInfo[]	items
LinkedItemInfo	itemToRemove

Returns

Type	Description
LinkedItemInfo[]

RemoveLinkedItem(LinkedItemInfo[], String)

Declaration

public static LinkedItemInfo[] RemoveLinkedItem(LinkedItemInfo[] items, string name)

Parameters

Type	Name	Description
LinkedItemInfo[]	items
System.String	name

Returns

Type	Description
LinkedItemInfo[]

ReorderImage(ImageType, Int32, Int32)

Declaration

public void ReorderImage(ImageType type, int originalIndex, int newIndex)

Parameters

Type	Name	Description
ImageType	type
System.Int32	originalIndex
System.Int32	newIndex

ResetMetadata()

Declaration

public void ResetMetadata()

ResetMetadataInternal()

Declaration

protected virtual void ResetMetadataInternal()

SetAlbumItem(BaseItem)

Declaration

public void SetAlbumItem(BaseItem item)

Parameters

Type	Name	Description
BaseItem	item

SetCachedParent(BaseItem)

Declaration

public void SetCachedParent(BaseItem parent)

Parameters

Type	Name	Description
BaseItem	parent

SetCollections(IEnumerable<String>)

Declaration

public void SetCollections(IEnumerable<string> names)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	names

SetDisplayOrder(String)

Declaration

public virtual void SetDisplayOrder(string value)

Parameters

Type	Name	Description
System.String	value

SetGenres(IEnumerable<String>)

Declaration

public void SetGenres(IEnumerable<string> names)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	names

SetImage(ItemImageInfo, Int32)

Declaration

public void SetImage(ItemImageInfo image, int index)

Parameters

Type	Name	Description
ItemImageInfo	image
System.Int32	index

SetImage(ItemImageInfo, Int32, Boolean)

Declaration

public void SetImage(ItemImageInfo image, int index, bool deleteExistingImage)

Parameters

Type	Name	Description
ItemImageInfo	image
System.Int32	index
System.Boolean	deleteExistingImage

SetParent(BaseItem)

Declaration

public void SetParent(BaseItem parent)

Parameters

Type	Name	Description
BaseItem	parent

SetSeriesItem(BaseItem)

Declaration

public void SetSeriesItem(BaseItem item)

Parameters

Type	Name	Description
BaseItem	item

SetSortNameDirect(String)

An optimization to avoid processing a value that's already been processed

Declaration

public void SetSortNameDirect(string sortName)

Parameters

Type	Name	Description
System.String	sortName

SetStudios(IEnumerable<String>)

Declaration

public void SetStudios(IEnumerable<string> names)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	names

SetTagItemsDirect(LinkedItemInfo[])

Declaration

public void SetTagItemsDirect(LinkedItemInfo[] items)

Parameters

Type	Name	Description
LinkedItemInfo[]	items

SetTags(IEnumerable<String>)

Declaration

public void SetTags(IEnumerable<string> names)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	names

SortChildrenForValidation(BaseItem[])

Declaration

protected virtual BaseItem[] SortChildrenForValidation(BaseItem[] children)

Parameters

Type	Name	Description
BaseItem[]	children

Returns

Type	Description
BaseItem[]

SupportsMakePublicOrPrivate()

Declaration

public virtual bool SupportsMakePublicOrPrivate()

Returns

Type	Description
System.Boolean

SupportsManageAccess()

Declaration

public virtual bool SupportsManageAccess()

Returns

Type	Description
System.Boolean

SupportsPlayedStatus()

Declaration

public virtual bool SupportsPlayedStatus()

Returns

Type	Description
System.Boolean

ToLinkedItemInfo()

Declaration

public LinkedItemInfo ToLinkedItemInfo()

Returns

Type	Description
LinkedItemInfo

ToString()

Returns a System.String that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents this instance.

Overrides

System.Object.ToString()

TriggerOnRefreshComplete()

Declaration

protected virtual void TriggerOnRefreshComplete()

TriggerOnRefreshStart()

Declaration

protected virtual void TriggerOnRefreshStart()

UpdateHideFromResume(User, UserItemData, BaseItem[], Boolean)

Declaration

public virtual void UpdateHideFromResume(User user, UserItemData userData, BaseItem[] collectionFolders, bool hide)

Parameters

Type	Name	Description
User	user
UserItemData	userData
BaseItem[]	collectionFolders
System.Boolean	hide

UpdateHideFromResume(User, UserItemData, Boolean)

Declaration

public void UpdateHideFromResume(User user, UserItemData userData, bool hide)

Parameters

Type	Name	Description
User	user
UserItemData	userData
System.Boolean	hide

UpdateRatingToItems(BaseItem[])

Updates the official rating based on content and returns true or false indicating if it changed.

Declaration

public bool UpdateRatingToItems(BaseItem[] children)

Parameters

Type	Name	Description
BaseItem[]	children

Returns

Type	Description
System.Boolean

UpdateToRepository(ItemUpdateType)

Declaration

public void UpdateToRepository(ItemUpdateType updateReason)

Parameters

Type	Name	Description
ItemUpdateType	updateReason

UpdateToRepository(ItemUpdateType, BaseItem)

Declaration

public void UpdateToRepository(ItemUpdateType updateReason, BaseItem parent)

Parameters

Type	Name	Description
ItemUpdateType	updateReason
BaseItem	parent

UpdateToRepository(ItemUpdateType, BaseItem, MetadataRefreshOptions)

Declaration

public virtual void UpdateToRepository(ItemUpdateType updateReason, BaseItem parent, MetadataRefreshOptions metadataRefreshOptions)

Parameters

Type	Name	Description
ItemUpdateType	updateReason
BaseItem	parent
MetadataRefreshOptions	metadataRefreshOptions

UpdateToRepository(ItemUpdateType, MetadataRefreshOptions)

Declaration

public virtual void UpdateToRepository(ItemUpdateType updateReason, MetadataRefreshOptions metadataRefreshOptions)

Parameters

Type	Name	Description
ItemUpdateType	updateReason
MetadataRefreshOptions	metadataRefreshOptions

ValidateChildren(IProgress<Double>, CancellationToken, MetadataRefreshOptions, Boolean)

Validates that the children of the folder still exist

Declaration

public Task ValidateChildren(IProgress<double> progress, CancellationToken cancellationToken, MetadataRefreshOptions metadataRefreshOptions, bool recursive = true)

Parameters

Type	Name	Description
System.IProgress<System.Double>	progress
System.Threading.CancellationToken	cancellationToken
MetadataRefreshOptions	metadataRefreshOptions
System.Boolean	recursive

Returns

Type	Description
System.Threading.Tasks.Task

ValidateChildrenInternal(IProgress<Double>, CancellationToken, Boolean, Boolean, BaseItem[], LibraryOptions, Dictionary<Int64, Boolean>, MetadataRefreshOptions, IDirectoryService)

Validates the children internal.

Declaration

protected virtual async Task ValidateChildrenInternal(IProgress<double> progress, CancellationToken cancellationToken, bool recursive, bool refreshChildMetadata, BaseItem[] collectionFolders, LibraryOptions libraryOptions, Dictionary<long, bool> newItemIds, MetadataRefreshOptions refreshOptions, IDirectoryService directoryService)

Parameters

Type	Name	Description
System.IProgress<System.Double>	progress	The progress.
System.Threading.CancellationToken	cancellationToken	The cancellation token.
System.Boolean	recursive	if set to true [recursive].
System.Boolean	refreshChildMetadata	if set to true [refresh child metadata].
BaseItem[]	collectionFolders
LibraryOptions	libraryOptions
System.Collections.Generic.Dictionary<System.Int64, System.Boolean>	newItemIds
MetadataRefreshOptions	refreshOptions	The refresh options.
IDirectoryService	directoryService	The directory service.

Returns

Type	Description
System.Threading.Tasks.Task	Task.

Explicit Interface Implementations

IHasLookupInfo<ItemLookupInfo>.GetLookupInfo(LibraryOptions)

Declaration

ItemLookupInfo IHasLookupInfo<ItemLookupInfo>.GetLookupInfo(LibraryOptions libraryOptions)

Parameters

Type	Name	Description
LibraryOptions	libraryOptions

Returns

Type	Description
ItemLookupInfo

Implements

IHasProviderIds

IHasLookupInfo<TLookupInfoType>

Extension Methods

BaseItemExtensions.GetImagePath(BaseItem, ImageType)

BaseItemExtensions.HasImage(BaseItem, ImageType)

Extensions.AddTrailerUrl(BaseItem, String)

TagExtensions.AddTag(BaseItem, String)

TagExtensions.RemoveTag(BaseItem, String)

Extensions.JsonClone<T>(T, IJsonSerializer)