Facebook
Twitter
Pinterest
Tumblr
GitHub
RSS
  • DEV Home
  • Documentation
  • Reference
  • Download
Search Results for

    Show / Hide Table of Contents

    Class Series

    Class Series

    Inheritance
    System.Object
    BaseItem
    Folder
    Series
    Implements
    IHasProviderIds
    IHasLookupInfo<ItemLookupInfo>
    IHasFolderGrouping
    IHasLookupInfo<SeriesInfo>
    Inherited Members
    Folder.UserViewManager
    Folder.IsPreSorted
    Folder.IsPhysicalRoot
    Folder.IsResolvedToFolder
    Folder.IsTopParent
    Folder.IsFolder
    Folder.IsDisplayedAsFolder
    Folder.SupportsCumulativeRunTimeTicks
    Folder.SupportsExternalTransfer
    Folder.CanDelete()
    Folder.AddChild(BaseItem)
    Folder.AddChild(BaseItem, BaseItem[])
    Folder.GetNonCachedChildren(IDirectoryService, LibraryOptions)
    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.SupportsManageAccess()
    BaseItem.CanManageAccess(User, UserItemShareLevel)
    BaseItem.SupportsMakePublicOrPrivate()
    BaseItem.AssertHasMinimumShareLevel(User, UserItemShareLevel)
    BaseItem.GetShareLevel(User)
    BaseItem.CanLeaveSharedContent(User, UserItemShareLevel)
    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.GetStandaloneDisplayName(String, String, Nullable<Int32>, Nullable<Int32>)
    BaseItem.IsInMixedFolder
    BaseItem.OwnsFolder
    BaseItem.OriginalParsedName
    BaseItem.IsNameParsedFromFolder
    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.IsAuthorizedToDelete(User, UserItemShareLevel, Folder[])
    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.MediaType
    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.SupportsTags
    BaseItem.SupportsCollections
    BaseItem.GetFileSystemChildren(IDirectoryService)
    BaseItem.GetUniquelyIdentifiableProviderIds()
    BaseItem.ProviderIds
    BaseItem.LatestItemsContainerId
    BaseItem.ForceDefaultAspectRatio
    BaseItem.CreatePresentationUniqueKey()
    BaseItem.GetDefaultPresentationUniqueKey()
    BaseItem.PresentationUniqueKey
    BaseItem.GetPresentationUniqueKey()
    BaseItem.GetUserDataKey()
    BaseItem.AfterMetadataRefresh()
    BaseItem.GetPreferredMetadataLanguage()
    BaseItem.GetPreferredMetadataLanguage(LibraryOptions)
    BaseItem.GetPreferredImageLanguage(LibraryOptions)
    BaseItem.GetPreferredMetadataCountryCode()
    BaseItem.GetPreferredMetadataCountryCode(LibraryOptions)
    BaseItem.IsLocalMetadataReaderEnabled(LibraryOptions, String)
    BaseItem.IsSaveLocalMetadataEnabled(LibraryOptions)
    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.GetMappedPath(String, Nullable<MediaProtocol>, LibraryOptions)
    BaseItem.GetEtag(User)
    BaseItem.GetEtagValues(User)
    BaseItem.GetInternalAncestorIds()
    BaseItem.GetTopParent()
    BaseItem.SupportsAncestors
    BaseItem.UpdateRatingToItems(BaseItem[])
    BaseItem.AllowEditingField(MetadataFields)
    BaseItem.ResetMetadata()
    BaseItem.ResetMetadataInternal()
    BaseItem.GetChildrenForValidationSorted()
    BaseItem.ValidatesChildren
    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.Entities.TV
    Assembly: MediaBrowser.Controller.dll
    Syntax
    public sealed class Series : Folder, IHasProviderIds, IHasLookupInfo<ItemLookupInfo>, IHasFolderGrouping, IHasLookupInfo<SeriesInfo>

    Properties

    AirDays

    Declaration
    [IgnoreDataMember]
    public DayOfWeek[] AirDays { get; set; }
    Property Value
    Type Description
    System.DayOfWeek[]

    AirTime

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

    DisplayOrder

    airdate, dvd or absolute

    Declaration
    [IgnoreDataMember]
    public SeriesDisplayOrder DisplayOrder { get; set; }
    Property Value
    Type Description
    SeriesDisplayOrder

    Status

    Gets or sets the status.

    Declaration
    [IgnoreDataMember]
    public SeriesStatus? Status { get; set; }
    Property Value
    Type Description
    System.Nullable<SeriesStatus>

    The status.

    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

    SupportsLocalTrailers

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

    SupportsPeople

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

    SupportsResetMetadata

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

    SupportsStudios

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

    SupportsThemeMedia

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

    Methods

    BeforeMetadataRefresh(Boolean)

    Declaration
    public override bool BeforeMetadataRefresh(bool replaceAllMetadata)
    Parameters
    Type Name Description
    System.Boolean replaceAllMetadata
    Returns
    Type Description
    System.Boolean
    Overrides
    BaseItem.BeforeMetadataRefresh(Boolean)

    CreatePresentationUniqueKey(BaseItem[], LibraryOptions)

    Declaration
    public override string CreatePresentationUniqueKey(BaseItem[] collectionFolders, LibraryOptions libraryOptions)
    Parameters
    Type Name Description
    BaseItem[] collectionFolders
    LibraryOptions libraryOptions
    Returns
    Type Description
    System.String
    Overrides
    BaseItem.CreatePresentationUniqueKey(BaseItem[], LibraryOptions)

    GetDefaultPrimaryImageAspectRatio()

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

    GetDisplayOrderIntValue()

    Declaration
    public override int? GetDisplayOrderIntValue()
    Returns
    Type Description
    System.Nullable<System.Int32>
    Overrides
    BaseItem.GetDisplayOrderIntValue()

    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)

    GetLookupInfo(LibraryOptions)

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

    GetRelatedUrls()

    Declaration
    public override List<ExternalUrl> GetRelatedUrls()
    Returns
    Type Description
    System.Collections.Generic.List<ExternalUrl>
    Overrides
    BaseItem.GetRelatedUrls()

    GetSeasonEpisodeIds(Season, InternalItemsQuery)

    Declaration
    public long[] GetSeasonEpisodeIds(Season parentSeason, InternalItemsQuery query)
    Parameters
    Type Name Description
    Season parentSeason
    InternalItemsQuery query
    Returns
    Type Description
    System.Int64[]

    GetSeasonEpisodes(Season, InternalItemsQuery)

    Declaration
    public QueryResult<BaseItem> GetSeasonEpisodes(Season parentSeason, InternalItemsQuery query)
    Parameters
    Type Name Description
    Season parentSeason
    InternalItemsQuery query
    Returns
    Type Description
    QueryResult<BaseItem>

    GetSeriesSorting()

    Declaration
    public static (string, SortOrder)[] GetSeriesSorting()
    Returns
    Type Description
    System.ValueTuple<System.String, SortOrder>[]

    GetSeriesSorting(SortOrder)

    Declaration
    public static (string, SortOrder)[] GetSeriesSorting(SortOrder order)
    Parameters
    Type Name Description
    SortOrder order
    Returns
    Type Description
    System.ValueTuple<System.String, SortOrder>[]

    GetUserDataKeyInternal()

    Declaration
    protected override string GetUserDataKeyInternal()
    Returns
    Type Description
    System.String
    Overrides
    BaseItem.GetUserDataKeyInternal()

    SupportsPlayedStatus()

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

    Implements

    IHasProviderIds
    IHasLookupInfo<TLookupInfoType>
    IHasFolderGrouping
    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)
    SDK
    On this Page
    Back to Top Copyright 2022 © EMBY LLC. Please see our terms of use and privacy policy.