Class Playlist

Inheritance

System.Object

BaseItem

Folder

Playlist

Implements

IHasProviderIds

IHasLookupInfo<ItemLookupInfo>

IHasFolderGrouping

Inherited Members

Folder.UserViewManager

Folder.IsPreSorted

Folder.IsPhysicalRoot

Folder.IsTopParent

Folder.IsFolder

Folder.IsDisplayedAsFolder

Folder.SupportsExternalTransfer

Folder.CanDelete()

Folder.AddChild(BaseItem)

Folder.AddChild(BaseItem, BaseItem[])

Folder.GetChildrenForValidation()

Folder.GetChildren(InternalItemsQuery)

Folder.GetChildrenIds(InternalItemsQuery)

Folder.GetRefreshProgress()

Folder.TriggerOnRefreshStart()

Folder.TriggerOnRefreshComplete()

Folder.GetChildCount(User)

Folder.GetRecursiveChildCount(User)

Folder.GetItems(InternalItemsQuery)

Folder.GetItemIdList(InternalItemsQuery)

Folder.GetItemList(InternalItemsQuery)

Folder.GetChildren(User)

Folder.GetRecursiveChildren()

Folder.MarkDirectlyAsPlayed

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

Folder.MarkUnplayed(User)

Folder.IsPlayed(User)

Folder.IsUnplayed(User)

Folder.AllowRecursiveCounts

Folder.FillUserDataDtoValues(UserItemDataDto, BaseItemDto, User, DtoOptions)

Folder.FillPlayedStatus(UserItemDataDto, Nullable<Int32>, User, DtoOptions)

BaseItem.PlayCount

BaseItem.LastPlayedDate

BaseItem.Played

BaseItem.AudioStreamIndex

BaseItem.SubtitleStreamIndex

BaseItem.UserDataKey

BaseItem.IsFavorite

BaseItem.UserRating

BaseItem.PlaybackPositionTicks

BaseItem.UserDataSet

BaseItem.InternalId

BaseItem.RemoteTrailers

BaseItem.ListItemEntryId

BaseItem.IsSecondaryMergedItemInSameFolder

BaseItem.IsPublic

BaseItem.MediaStreams

BaseItem.AdditionalPartCount

BaseItem.LocalTrailerCount

BaseItem.SpecialFeatureCount

BaseItem.SupportedImageExtensions

BaseItem.TrailerFolderName

BaseItem.ThemeSongsFolderName

BaseItem.ThemeSongFilename

BaseItem.ThemeVideosFolderName

BaseItem.ExtrasSubFolders

BaseItem.SupportsUserData

BaseItem.IsPlaceHolder

BaseItem.SupportsExtras

BaseItem.SupportsAdditionalParts

BaseItem.IsCompleteMedia

BaseItem.DisplayExtraTypes

BaseItem.GetDisplayExtraIds()

BaseItem.ThemeSongIds

BaseItem.ThemeVideoIds

BaseItem.LocalTrailerIds

BaseItem.HasPlaceholderMatadata()

BaseItem.AssertHasMinimumShareLevel(User, UserItemShareLevel)

BaseItem.GetShareLevel(User)

BaseItem.CanMakePublic(User)

BaseItem.CanMakePrivate(User)

BaseItem.CanMakePublic(UserItemShareLevel)

BaseItem.CanMakePrivate(UserItemShareLevel)

BaseItem.GetExtraGuids(ExtraType[])

BaseItem.GetAdditionalParts(DtoOptions, User)

BaseItem.GetAdditionalPartIds()

BaseItem.GetExtraTypes(ExtraType[])

BaseItem.GetExtraIds(ExtraType[])

BaseItem.GetExtras(ExtraType[])

BaseItem.GetExtras(ExtraType[], DtoOptions)

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

BaseItem.GetExtras(Int64, ExtraType[], DtoOptions)

BaseItem.GetThemeSongs(DtoOptions)

BaseItem.GetThemeVideos(DtoOptions)

BaseItem.GetRunTimeTicksForPlayState()

BaseItem.PreferredMetadataCountryCode

BaseItem.PreferredMetadataLanguage

BaseItem.Size

BaseItem.Prefix

BaseItem.ShareLevel

BaseItem.SyncStatus

BaseItem.Container

BaseItem.MediaContainer

BaseItem.Tagline

BaseItem.ImageInfos

BaseItem.IsVirtualItem

BaseItem.AlbumId

BaseItem.SeriesId

BaseItem.Album

BaseItem.SupportsEditingAlbum

BaseItem.GetStandaloneDisplayName()

BaseItem.IsInMixedFolder

BaseItem.OwnsFolder

BaseItem.OriginalParsedName

BaseItem.IsNameParsedFromFolder

BaseItem.SupportsPlayedStatus()

BaseItem.GetDisplayOrderIntValue()

BaseItem.SetDisplayOrder(String)

BaseItem.GetMediaContainingFolderPath(LibraryOptions)

BaseItem.GetSupportsPositionTicksResume(LibraryOptions)

BaseItem.SupportsRemoteImageDownloading

BaseItem.Name

BaseItem.IsShortcut

BaseItem.IsFileShortcut(String)

BaseItem.IsUnaired

BaseItem.TotalBitrate

BaseItem.ExtraType

BaseItem.IsThemeMedia

BaseItem.OriginalTitle

BaseItem.Id

BaseItem.GetDefaultMediaSourceId()

BaseItem.IsHD

BaseItem.Width

BaseItem.Height

BaseItem.DisplayPreferencesId

BaseItem.Path

BaseItem.ContainingFolderPath

BaseItem.ExternalId

BaseItem.SeriesPresentationUniqueKey

BaseItem.IsHidden

BaseItem.LocationType

BaseItem.PathProtocol

BaseItem.IsPathProtocol(MediaProtocol)

BaseItem.IsFileProtocol

BaseItem.HasPathProtocol

BaseItem.FileNameWithoutExtension

BaseItem.FileName

BaseItem.EnableAlphaNumericSorting

BaseItem.PrimaryImagePath

BaseItem.IsMetadataFetcherEnabled(LibraryOptions, String)

BaseItem.IsImageFetcherEnabled(LibraryOptions, String)

BaseItem.CanDelete(User, Folder[])

BaseItem.CanDelete(User, UserItemShareLevel, Folder[])

BaseItem.CanDownload()

BaseItem.IsAuthorizedToDownload(User)

BaseItem.CanDownload(User)

BaseItem.CanDownloadAsSingleMedia()

BaseItem.CanDownloadAsFolder()

BaseItem.DateCreated

BaseItem.DateModified

BaseItem.HasDateModifiedChanged(DateTimeOffset)

BaseItem.HasDateChanged(DateTimeOffset, DateTimeOffset)

BaseItem.HasDateChanged(Nullable<DateTimeOffset>, DateTimeOffset)

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

BaseItem.DateLastSaved

BaseItem.DateLastRefreshed

BaseItem.IsGreaterThanDateLastSaved(DateTimeOffset)

BaseItem.Logger

BaseItem.LibraryManager

BaseItem.LiveTvManager

BaseItem.FeatureManager

BaseItem.UserManager

BaseItem.ConfigurationManager

BaseItem.ProviderManager

BaseItem.LocalizationManager

BaseItem.ItemRepository

BaseItem.FileSystem

BaseItem.UserDataManager

BaseItem.ChannelManager

BaseItem.MediaSourceManager

BaseItem.NetworkManager

BaseItem.ApplicationHost

BaseItem.ToString()

BaseItem.IsLocked

BaseItem.LockedFields

BaseItem.SortName

BaseItem.SetSortNameDirect(String)

BaseItem.IsFieldLocked(MetadataFields)

BaseItem.AddProviderIdsToName(String, String[])

BaseItem.GetInternalMetadataPath()

BaseItem.GetInternalMetadataPath(String)

BaseItem.GetInternalMetadataPath(Guid, String)

BaseItem.CreateSortName()

BaseItem.CreateSortName(ReadOnlySpan<Char>)

BaseItem.ParentId

BaseItem.Parent

BaseItem.SetParent(BaseItem)

BaseItem.GetParent()

BaseItem.GetParents()

BaseItem.FindParent<T>()

BaseItem.DisplayParentId

BaseItem.ImageDisplayParentId

BaseItem.DisplayParent

BaseItem.PremiereDate

BaseItem.EndDate

BaseItem.OfficialRating

BaseItem.CriticRating

BaseItem.CustomRating

BaseItem.Overview

BaseItem.Studios

BaseItem.StudioItems

BaseItem.Genres

BaseItem.GenreItems

BaseItem.Tags

BaseItem.TagItems

BaseItem.Collections

BaseItem.ImportedCollections

BaseItem.GetImportedCollections()

BaseItem.GetAllKnownCollections()

BaseItem.AddImportedCollections(LinkedItemInfo[])

BaseItem.ContainsTag(String)

BaseItem.SetTags(IEnumerable<String>)

BaseItem.SetCollections(IEnumerable<String>)

BaseItem.SetGenres(IEnumerable<String>)

BaseItem.ProductionLocations

BaseItem.CommunityRating

BaseItem.RunTimeTicks

BaseItem.ProductionYear

BaseItem.IndexNumber

BaseItem.ParentIndexNumber

BaseItem.OfficialRatingForComparison

BaseItem.CustomRatingForComparison

BaseItem.GetMediaStreams()

BaseItem.MarkTaggedItemsLoaded()

BaseItem.EnsureTaggedItemsLoaded()

BaseItem.GetSupportedItemLinkTypes()

BaseItem.FillItemLinks(List<(T1, T2, T3)<ItemLinkType, String, Int64>>)

BaseItem.IsActiveRecording()

BaseItem.GetMediaSources(Boolean, Boolean, LibraryOptions)

BaseItem.GetMediaSources(User, Boolean, Boolean, LibraryOptions)

BaseItem.GetAllItemsForMediaSources(User, Boolean)

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

BaseItem.RefreshMetadata(CancellationToken)

BaseItem.EnableInternalIdsExternally

BaseItem.GetClientId()

BaseItem.RefreshMetadata(MetadataRefreshOptions, CancellationToken)

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

BaseItem.SupportsOwnedItems

BaseItem.SupportsPeople

BaseItem.SupportsStudios

BaseItem.SupportsTags

BaseItem.SupportsCollections

BaseItem.SupportsThemeMedia

BaseItem.SupportsLocalTrailers

BaseItem.GetFileSystemChildren(IDirectoryService)

BaseItem.GetUniquelyIdentifiableProviderIds()

BaseItem.ProviderIds

BaseItem.LatestItemsContainerId

BaseItem.ForceDefaultAspectRatio

BaseItem.CreatePresentationUniqueKey()

BaseItem.CreatePresentationUniqueKey(BaseItem[], LibraryOptions)

BaseItem.GetDefaultPresentationUniqueKey()

BaseItem.PresentationUniqueKey

BaseItem.GetPresentationUniqueKey()

BaseItem.GetUserDataKey()

BaseItem.GetUserDataKeyInternal()

BaseItem.AfterMetadataRefresh()

BaseItem.GetPreferredMetadataLanguage()

BaseItem.GetPreferredMetadataLanguage(LibraryOptions)

BaseItem.GetPreferredImageLanguage(LibraryOptions)

BaseItem.GetPreferredMetadataCountryCode()

BaseItem.GetPreferredMetadataCountryCode(LibraryOptions)

BaseItem.IsLocalMetadataReaderEnabled(LibraryOptions, String)

BaseItem.GetParentalRatingValue()

BaseItem.GetInheritedParentalRatingValue()

BaseItem.IsVisible(User)

BaseItem.IsVisibleStandalone(User)

BaseItem.GetClientTypeName()

BaseItem.EnableRememberingTrackSelections

BaseItem.AddStudio(String)

BaseItem.SetStudios(IEnumerable<String>)

BaseItem.AddGenre(String)

BaseItem.AddCollection(String)

BaseItem.AddCollection(LinkedItemInfo)

BaseItem.AddCollectionInfo(LinkedItemInfo)

BaseItem.AddCollection(BoxSet)

BaseItem.RemoveCollection(Int64)

BaseItem.MarkPlayed(User, Nullable<DateTimeOffset>, Boolean)

BaseItem.UpdateHideFromResume(User, UserItemData, Boolean)

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

BaseItem.HasImage(ImageType, Int32)

BaseItem.SetImage(ItemImageInfo, Int32)

BaseItem.SetImage(ItemImageInfo, Int32, Boolean)

BaseItem.AddImage(FileSystemMetadata, ImageType)

BaseItem.DeleteImage(ImageType, Int32)

BaseItem.RemoveImage(ImageType, String)

BaseItem.RemoveImage(ItemImageInfo)

BaseItem.RemoveImages(List<ItemImageInfo>)

BaseItem.UpdateToRepository(ItemUpdateType)

BaseItem.UpdateToRepository(ItemUpdateType, BaseItem)

BaseItem.UpdateToRepository(ItemUpdateType, MetadataRefreshOptions)

BaseItem.UpdateToRepository(ItemUpdateType, BaseItem, MetadataRefreshOptions)

BaseItem.GetImagePath(ImageType, Int32)

BaseItem.GetImageInfo(ImageType, Int32)

BaseItem.GetImages(ImageType)

BaseItem.AddImages(ImageType, List<FileSystemMetadata>, Boolean)

BaseItem.GetDeletePaths(Boolean, BaseItem[])

BaseItem.AllowsMultipleImages(ImageType)

BaseItem.ReorderImage(ImageType, Int32, Int32)

BaseItem.MoveFiles(String[], String[])

BaseItem.IsFavoriteOrLiked(User)

BaseItem.IHasLookupInfo<ItemLookupInfo>.GetLookupInfo(LibraryOptions)

BaseItem.GetItemLookupInfo<T>(LibraryOptions)

BaseItem.GetItemsForAncestorIdsQuery(User)

BaseItem.GetIdsForAncestorIdsQuery(User)

BaseItem.GetNameForMetadataLookup()

BaseItem.BeforeMetadataRefresh(Boolean)

BaseItem.GetMappedPath(String, Nullable<MediaProtocol>, LibraryOptions)

BaseItem.GetEtag(User)

BaseItem.GetEtagValues(User)

BaseItem.GetInternalAncestorIds()

BaseItem.GetTopParent()

BaseItem.SupportsAncestors

BaseItem.GetRelatedUrls()

BaseItem.UpdateRatingToItems(BaseItem[])

BaseItem.AllowEditingField(MetadataFields)

BaseItem.SupportsResetMetadata

BaseItem.ResetMetadata()

BaseItem.ResetMetadataInternal()

BaseItem.GetChildrenForValidationSorted()

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

BaseItem.ResolvedExtras

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

BaseItem.SortChildrenForValidation(BaseItem[])

BaseItem.EnableImageCaching(LibraryOptions)

BaseItem.GetApiImageUrl(ItemImageInfo, Int32, ApiImageOptions, String)

BaseItem.GetLocalApiImageUrl(ItemImageInfo, Int32, ApiImageOptions, CancellationToken)

BaseItem.GetRemoteApiImageUrl(ItemImageInfo, Int32, ApiImageOptions)

Namespace: MediaBrowser.Controller.Playlists

Assembly: MediaBrowser.Controller.dll

Syntax

public sealed class Playlist : Folder, IHasProviderIds, IHasLookupInfo<ItemLookupInfo>, IHasFolderGrouping

Fields

SupportedExtensions

Declaration

public static string[] SupportedExtensions

Field Value

Type	Description
System.String[]

Properties

IsResolvedToFolder

Declaration

[IgnoreDataMember]
public override bool IsResolvedToFolder { get; }

Property Value

Type	Description
System.Boolean

Overrides

Folder.IsResolvedToFolder

MediaType

Declaration

[IgnoreDataMember]
public override string MediaType { get; }

Property Value

Type	Description
System.String

Overrides

BaseItem.MediaType

PlaylistMediaType

Declaration

public string PlaylistMediaType { get; set; }

Property Value

Type	Description
System.String

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

ValidatesChildren

Declaration

[IgnoreDataMember]
protected override bool ValidatesChildren { get; }

Property Value

Type	Description
System.Boolean

Overrides

BaseItem.ValidatesChildren

Methods

CanLeaveSharedContent(User, UserItemShareLevel)

Declaration

public override bool CanLeaveSharedContent(User user, UserItemShareLevel shareLevel)

Parameters

Type	Name	Description
User	user
UserItemShareLevel	shareLevel

Returns

Type	Description
System.Boolean

Overrides

BaseItem.CanLeaveSharedContent(User, UserItemShareLevel)

CanManageAccess(User, UserItemShareLevel)

Declaration

public override bool CanManageAccess(User user, UserItemShareLevel shareLevel)

Parameters

Type	Name	Description
User	user
UserItemShareLevel	shareLevel

Returns

Type	Description
System.Boolean

Overrides

BaseItem.CanManageAccess(User, UserItemShareLevel)

GetDefaultPrimaryImageAspectRatio()

Declaration

public override double GetDefaultPrimaryImageAspectRatio()

Returns

Type	Description
System.Double

Overrides

BaseItem.GetDefaultPrimaryImageAspectRatio()

GetItemIdsInternal(InternalItemsQuery)

Declaration

protected override long[] GetItemIdsInternal(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
System.Int64[]

Overrides

Folder.GetItemIdsInternal(InternalItemsQuery)

GetItemsInternal(InternalItemsQuery)

Declaration

protected override QueryResult<BaseItem> GetItemsInternal(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
QueryResult<BaseItem>

Overrides

Folder.GetItemsInternal(InternalItemsQuery)

GetNonCachedChildren(IDirectoryService, LibraryOptions)

Declaration

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

Parameters

Type	Name	Description
IDirectoryService	directoryService
LibraryOptions	libraryOptions

Returns

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

Overrides

Folder.GetNonCachedChildren(IDirectoryService, LibraryOptions)

GetPlaylistItems(String, BaseItem[], User)

Declaration

public static long[] GetPlaylistItems(string playlistMediaType, BaseItem[] inputItems, User user)

Parameters

Type	Name	Description
System.String	playlistMediaType
BaseItem[]	inputItems
User	user

Returns

Type	Description
System.Int64[]

IsAuthorizedToDelete(User, UserItemShareLevel, Folder[])

Declaration

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

Parameters

Type	Name	Description
User	user
UserItemShareLevel	shareLevel
Folder[]	collectionFolders

Returns

Type	Description
System.Boolean

Overrides

BaseItem.IsAuthorizedToDelete(User, UserItemShareLevel, Folder[])

IsInSpecialUserPlaylistsFolder(String)

Declaration

public static bool IsInSpecialUserPlaylistsFolder(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
System.Boolean

IsPlaylistFile(String)

Declaration

public static bool IsPlaylistFile(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
System.Boolean

IsSaveLocalMetadataEnabled(LibraryOptions)

Declaration

public override bool IsSaveLocalMetadataEnabled(LibraryOptions libraryOptions)

Parameters

Type	Name	Description
LibraryOptions	libraryOptions

Returns

Type	Description
System.Boolean

Overrides

BaseItem.IsSaveLocalMetadataEnabled(LibraryOptions)

SetMediaType(String)

Declaration

public void SetMediaType(string value)

Parameters

Type	Name	Description
System.String	value

SupportsMakePublicOrPrivate()

Declaration

public override bool SupportsMakePublicOrPrivate()

Returns

Type	Description
System.Boolean

Overrides

BaseItem.SupportsMakePublicOrPrivate()

SupportsManageAccess()

Declaration

public override bool SupportsManageAccess()

Returns

Type	Description
System.Boolean