@jellyfin/sdk
    Preparing search index...

    Interface BaseItemDto

    This is strictly used as a data transfer object from the api layer. This holds information about a BaseItem in a format that is convenient for the client.

    BaseItemDto

    interface BaseItemDto {
        AirDays?: DayOfWeek[] | null;
        AirsAfterSeasonNumber?: number | null;
        AirsBeforeEpisodeNumber?: number | null;
        AirsBeforeSeasonNumber?: number | null;
        AirTime?: string | null;
        Album?: string | null;
        AlbumArtist?: string | null;
        AlbumArtists?: NameGuidPair[] | null;
        AlbumCount?: number | null;
        AlbumId?: string | null;
        AlbumPrimaryImageTag?: string | null;
        Altitude?: number | null;
        Aperture?: number | null;
        ArtistCount?: number | null;
        ArtistItems?: NameGuidPair[] | null;
        Artists?: string[] | null;
        AspectRatio?: string | null;
        Audio?: ProgramAudio;
        BackdropImageTags?: string[] | null;
        CameraMake?: string | null;
        CameraModel?: string | null;
        CanDelete?: boolean | null;
        CanDownload?: boolean | null;
        ChannelId?: string | null;
        ChannelName?: string | null;
        ChannelNumber?: string | null;
        ChannelPrimaryImageTag?: string | null;
        ChannelType?: ChannelType;
        Chapters?: ChapterInfo[] | null;
        ChildCount?: number | null;
        CollectionType?: CollectionType;
        CommunityRating?: number | null;
        CompletionPercentage?: number | null;
        Container?: string | null;
        CriticRating?: number | null;
        CumulativeRunTimeTicks?: number | null;
        CurrentProgram?: BaseItemDto;
        CustomRating?: string | null;
        DateCreated?: string | null;
        DateLastMediaAdded?: string | null;
        DisplayOrder?: string | null;
        DisplayPreferencesId?: string | null;
        EnableMediaSourceDisplay?: boolean | null;
        EndDate?: string | null;
        EpisodeCount?: number | null;
        EpisodeTitle?: string | null;
        Etag?: string | null;
        ExposureTime?: number | null;
        ExternalUrls?: ExternalUrl[] | null;
        ExtraType?: ExtraType;
        FocalLength?: number | null;
        ForcedSortName?: string | null;
        GenreItems?: NameGuidPair[] | null;
        Genres?: string[] | null;
        HasLyrics?: boolean | null;
        HasSubtitles?: boolean | null;
        Height?: number | null;
        Id?: string;
        ImageBlurHashes?: BaseItemDtoImageBlurHashes | null;
        ImageOrientation?: ImageOrientation;
        ImageTags?: { [key: string]: string } | null;
        IndexNumber?: number | null;
        IndexNumberEnd?: number | null;
        IsFolder?: boolean | null;
        IsHD?: boolean | null;
        IsKids?: boolean | null;
        IsLive?: boolean | null;
        IsMovie?: boolean | null;
        IsNews?: boolean | null;
        IsoSpeedRating?: number | null;
        IsoType?: IsoType;
        IsPlaceHolder?: boolean | null;
        IsPremiere?: boolean | null;
        IsRepeat?: boolean | null;
        IsSeries?: boolean | null;
        IsSports?: boolean | null;
        Latitude?: number | null;
        LocalTrailerCount?: number | null;
        LocationType?: LocationType;
        LockData?: boolean | null;
        LockedFields?: MetadataField[] | null;
        Longitude?: number | null;
        MediaSourceCount?: number | null;
        MediaSources?: MediaSourceInfo[] | null;
        MediaStreams?: MediaStream[] | null;
        MediaType?: MediaType;
        MovieCount?: number | null;
        MusicVideoCount?: number | null;
        Name?: string | null;
        NormalizationGain?: number | null;
        Number?: string | null;
        OfficialRating?: string | null;
        OriginalTitle?: string | null;
        Overview?: string | null;
        ParentArtImageTag?: string | null;
        ParentArtItemId?: string | null;
        ParentBackdropImageTags?: string[] | null;
        ParentBackdropItemId?: string | null;
        ParentId?: string | null;
        ParentIndexNumber?: number | null;
        ParentLogoImageTag?: string | null;
        ParentLogoItemId?: string | null;
        ParentPrimaryImageItemId?: string | null;
        ParentPrimaryImageTag?: string | null;
        ParentThumbImageTag?: string | null;
        ParentThumbItemId?: string | null;
        PartCount?: number | null;
        Path?: string | null;
        People?: BaseItemPerson[] | null;
        PlayAccess?: PlayAccess;
        PlaylistItemId?: string | null;
        PreferredMetadataCountryCode?: string | null;
        PreferredMetadataLanguage?: string | null;
        PremiereDate?: string | null;
        PrimaryImageAspectRatio?: number | null;
        ProductionLocations?: string[] | null;
        ProductionYear?: number | null;
        ProgramCount?: number | null;
        ProgramId?: string | null;
        ProviderIds?: { [key: string]: string | null } | null;
        RecursiveItemCount?: number | null;
        RemoteTrailers?: MediaUrl[] | null;
        RunTimeTicks?: number | null;
        ScreenshotImageTags?: string[] | null;
        SeasonId?: string | null;
        SeasonName?: string | null;
        SeriesCount?: number | null;
        SeriesId?: string | null;
        SeriesName?: string | null;
        SeriesPrimaryImageTag?: string | null;
        SeriesStudio?: string | null;
        SeriesThumbImageTag?: string | null;
        SeriesTimerId?: string | null;
        ServerId?: string | null;
        ShutterSpeed?: number | null;
        Software?: string | null;
        SongCount?: number | null;
        SortName?: string | null;
        SourceType?: string | null;
        SpecialFeatureCount?: number | null;
        StartDate?: string | null;
        Status?: string | null;
        Studios?: NameGuidPair[] | null;
        Taglines?: string[] | null;
        Tags?: string[] | null;
        TimerId?: string | null;
        TrailerCount?: number | null;
        Trickplay?: { [key: string]: { [key: string]: TrickplayInfoDto } } | null;
        Type?: BaseItemKind;
        UserData?: UserItemDataDto;
        Video3DFormat?: Video3DFormat;
        VideoType?: VideoType;
        Width?: number | null;
    }
    Index

    Properties

    AirDays? AirsAfterSeasonNumber? AirsBeforeEpisodeNumber? AirsBeforeSeasonNumber? AirTime? Album? AlbumArtist? AlbumArtists? AlbumCount? AlbumId? AlbumPrimaryImageTag? Altitude? Aperture? ArtistCount? ArtistItems? Artists? AspectRatio? Audio? BackdropImageTags? CameraMake? CameraModel? CanDelete? CanDownload? ChannelId? ChannelName? ChannelNumber? ChannelPrimaryImageTag? ChannelType? Chapters? ChildCount? CollectionType? CommunityRating? CompletionPercentage? Container? CriticRating? CumulativeRunTimeTicks? CurrentProgram? CustomRating? DateCreated? DateLastMediaAdded? DisplayOrder? DisplayPreferencesId? EnableMediaSourceDisplay? EndDate? EpisodeCount? EpisodeTitle? Etag? ExposureTime? ExternalUrls? ExtraType? FocalLength? ForcedSortName? GenreItems? Genres? HasLyrics? HasSubtitles? Height? Id? ImageBlurHashes? ImageOrientation? ImageTags? IndexNumber? IndexNumberEnd? IsFolder? IsHD? IsKids? IsLive? IsMovie? IsNews? IsoSpeedRating? IsoType? IsPlaceHolder? IsPremiere? IsRepeat? IsSeries? IsSports? Latitude? LocalTrailerCount? LocationType? LockData? LockedFields? Longitude? MediaSourceCount? MediaSources? MediaStreams? MediaType? MovieCount? MusicVideoCount? Name? NormalizationGain? Number? OfficialRating? OriginalTitle? Overview? ParentArtImageTag? ParentArtItemId? ParentBackdropImageTags? ParentBackdropItemId? ParentId? ParentIndexNumber? ParentLogoImageTag? ParentLogoItemId? ParentPrimaryImageItemId? ParentPrimaryImageTag? ParentThumbImageTag? ParentThumbItemId? PartCount? Path? People? PlayAccess? PlaylistItemId? PreferredMetadataCountryCode? PreferredMetadataLanguage? PremiereDate? PrimaryImageAspectRatio? ProductionLocations? ProductionYear? ProgramCount? ProgramId? ProviderIds? RecursiveItemCount? RemoteTrailers? RunTimeTicks? ScreenshotImageTags? SeasonId? SeasonName? SeriesCount? SeriesId? SeriesName? SeriesPrimaryImageTag? SeriesStudio? SeriesThumbImageTag? SeriesTimerId? ServerId? ShutterSpeed? Software? SongCount? SortName? SourceType? SpecialFeatureCount? StartDate? Status? Studios? Taglines? Tags? TimerId? TrailerCount? Trickplay? Type? UserData? Video3DFormat? VideoType? Width?

    Properties

    AirDays?: DayOfWeek[] | null

    Gets or sets the air days.

    BaseItemDto

    AirsAfterSeasonNumber?: number | null

    BaseItemDto

    AirsBeforeEpisodeNumber?: number | null

    BaseItemDto

    AirsBeforeSeasonNumber?: number | null

    BaseItemDto

    AirTime?: string | null

    Gets or sets the air time.

    BaseItemDto

    Album?: string | null

    Gets or sets the album.

    BaseItemDto

    AlbumArtist?: string | null

    Gets or sets the album artist.

    BaseItemDto

    AlbumArtists?: NameGuidPair[] | null

    Gets or sets the album artists.

    BaseItemDto

    AlbumCount?: number | null

    Gets or sets the album count.

    BaseItemDto

    AlbumId?: string | null

    Gets or sets the album id.

    BaseItemDto

    AlbumPrimaryImageTag?: string | null

    Gets or sets the album image tag.

    BaseItemDto

    Altitude?: number | null

    BaseItemDto

    Aperture?: number | null

    BaseItemDto

    ArtistCount?: number | null

    BaseItemDto

    ArtistItems?: NameGuidPair[] | null

    Gets or sets the artist items.

    BaseItemDto

    Artists?: string[] | null

    Gets or sets the artists.

    BaseItemDto

    AspectRatio?: string | null

    Gets or sets the aspect ratio.

    BaseItemDto

    Audio?: ProgramAudio

    BaseItemDto

    BackdropImageTags?: string[] | null

    Gets or sets the backdrop image tags.

    BaseItemDto

    CameraMake?: string | null

    BaseItemDto

    CameraModel?: string | null

    BaseItemDto

    CanDelete?: boolean | null

    BaseItemDto

    CanDownload?: boolean | null

    BaseItemDto

    ChannelId?: string | null

    Gets or sets the channel identifier.

    BaseItemDto

    ChannelName?: string | null

    BaseItemDto

    ChannelNumber?: string | null

    BaseItemDto

    ChannelPrimaryImageTag?: string | null

    Gets or sets the channel primary image tag.

    BaseItemDto

    ChannelType?: ChannelType

    BaseItemDto

    Chapters?: ChapterInfo[] | null

    Gets or sets the chapters.

    BaseItemDto

    ChildCount?: number | null

    Gets or sets the child count.

    BaseItemDto

    CollectionType?: CollectionType

    BaseItemDto

    CommunityRating?: number | null

    Gets or sets the community rating.

    BaseItemDto

    CompletionPercentage?: number | null

    Gets or sets the completion percentage.

    BaseItemDto

    Container?: string | null

    BaseItemDto

    CriticRating?: number | null

    Gets or sets the critic rating.

    BaseItemDto

    CumulativeRunTimeTicks?: number | null

    Gets or sets the cumulative run time ticks.

    BaseItemDto

    CurrentProgram?: BaseItemDto

    BaseItemDto

    CustomRating?: string | null

    Gets or sets the custom rating.

    BaseItemDto

    DateCreated?: string | null

    Gets or sets the date created.

    BaseItemDto

    DateLastMediaAdded?: string | null

    BaseItemDto

    DisplayOrder?: string | null

    Gets or sets the display order.

    BaseItemDto

    DisplayPreferencesId?: string | null

    Gets or sets the display preferences id.

    BaseItemDto

    EnableMediaSourceDisplay?: boolean | null

    BaseItemDto

    EndDate?: string | null

    Gets or sets the end date.

    BaseItemDto

    EpisodeCount?: number | null

    Gets or sets the episode count.

    BaseItemDto

    EpisodeTitle?: string | null

    Gets or sets the episode title.

    BaseItemDto

    Etag?: string | null

    Gets or sets the etag.

    BaseItemDto

    ExposureTime?: number | null

    BaseItemDto

    ExternalUrls?: ExternalUrl[] | null

    Gets or sets the external urls.

    BaseItemDto

    ExtraType?: ExtraType

    BaseItemDto

    FocalLength?: number | null

    BaseItemDto

    ForcedSortName?: string | null

    BaseItemDto

    GenreItems?: NameGuidPair[] | null

    BaseItemDto

    Genres?: string[] | null

    Gets or sets the genres.

    BaseItemDto

    HasLyrics?: boolean | null

    BaseItemDto

    HasSubtitles?: boolean | null

    BaseItemDto

    Height?: number | null

    BaseItemDto

    Id?: string

    Gets or sets the id.

    BaseItemDto

    ImageBlurHashes?: BaseItemDtoImageBlurHashes | null

    BaseItemDto

    ImageOrientation?: ImageOrientation

    BaseItemDto

    ImageTags?: { [key: string]: string } | null

    Gets or sets the image tags.

    BaseItemDto

    IndexNumber?: number | null

    Gets or sets the index number.

    BaseItemDto

    IndexNumberEnd?: number | null

    Gets or sets the index number end.

    BaseItemDto

    IsFolder?: boolean | null

    Gets or sets a value indicating whether this instance is folder.

    BaseItemDto

    IsHD?: boolean | null

    Gets or sets a value indicating whether this instance is HD.

    BaseItemDto

    IsKids?: boolean | null

    Gets or sets a value indicating whether this instance is kids.

    BaseItemDto

    IsLive?: boolean | null

    Gets or sets a value indicating whether this instance is live.

    BaseItemDto

    IsMovie?: boolean | null

    Gets or sets a value indicating whether this instance is movie.

    BaseItemDto

    IsNews?: boolean | null

    Gets or sets a value indicating whether this instance is news.

    BaseItemDto

    IsoSpeedRating?: number | null

    BaseItemDto

    IsoType?: IsoType

    BaseItemDto

    IsPlaceHolder?: boolean | null

    Gets or sets a value indicating whether this instance is place holder.

    BaseItemDto

    IsPremiere?: boolean | null

    Gets or sets a value indicating whether this instance is premiere.

    BaseItemDto

    IsRepeat?: boolean | null

    Gets or sets a value indicating whether this instance is repeat.

    BaseItemDto

    IsSeries?: boolean | null

    Gets or sets a value indicating whether this instance is series.

    BaseItemDto

    IsSports?: boolean | null

    Gets or sets a value indicating whether this instance is sports.

    BaseItemDto

    Latitude?: number | null

    BaseItemDto

    LocalTrailerCount?: number | null

    Gets or sets the local trailer count.

    BaseItemDto

    LocationType?: LocationType

    BaseItemDto

    LockData?: boolean | null

    Gets or sets a value indicating whether [enable internet providers].

    BaseItemDto

    LockedFields?: MetadataField[] | null

    Gets or sets the locked fields.

    BaseItemDto

    Longitude?: number | null

    BaseItemDto

    MediaSourceCount?: number | null

    BaseItemDto

    MediaSources?: MediaSourceInfo[] | null

    Gets or sets the media versions.

    BaseItemDto

    MediaStreams?: MediaStream[] | null

    Gets or sets the media streams.

    BaseItemDto

    MediaType?: MediaType

    BaseItemDto

    MovieCount?: number | null

    Gets or sets the movie count.

    BaseItemDto

    MusicVideoCount?: number | null

    Gets or sets the music video count.

    BaseItemDto

    Name?: string | null

    Gets or sets the name.

    BaseItemDto

    NormalizationGain?: number | null

    Gets or sets the gain required for audio normalization.

    BaseItemDto

    Number?: string | null

    Gets or sets the number.

    BaseItemDto

    OfficialRating?: string | null

    Gets or sets the official rating.

    BaseItemDto

    OriginalTitle?: string | null

    BaseItemDto

    Overview?: string | null

    Gets or sets the overview.

    BaseItemDto

    ParentArtImageTag?: string | null

    Gets or sets the parent art image tag.

    BaseItemDto

    ParentArtItemId?: string | null

    Gets or sets whether the item has fan art, this will hold the Id of the Parent that has one.

    BaseItemDto

    ParentBackdropImageTags?: string[] | null

    Gets or sets the parent backdrop image tags.

    BaseItemDto

    ParentBackdropItemId?: string | null

    Gets or sets whether the item has any backdrops, this will hold the Id of the Parent that has one.

    BaseItemDto

    ParentId?: string | null

    Gets or sets the parent id.

    BaseItemDto

    ParentIndexNumber?: number | null

    Gets or sets the parent index number.

    BaseItemDto

    ParentLogoImageTag?: string | null

    Gets or sets the parent logo image tag.

    BaseItemDto

    ParentLogoItemId?: string | null

    Gets or sets whether the item has a logo, this will hold the Id of the Parent that has one.

    BaseItemDto

    ParentPrimaryImageItemId?: string | null

    Gets or sets the parent primary image item identifier.

    BaseItemDto

    ParentPrimaryImageTag?: string | null

    Gets or sets the parent primary image tag.

    BaseItemDto

    ParentThumbImageTag?: string | null

    Gets or sets the parent thumb image tag.

    BaseItemDto

    ParentThumbItemId?: string | null

    Gets or sets the parent thumb item id.

    BaseItemDto

    PartCount?: number | null

    Gets or sets the part count.

    BaseItemDto

    Path?: string | null

    Gets or sets the path.

    BaseItemDto

    People?: BaseItemPerson[] | null

    Gets or sets the people.

    BaseItemDto

    PlayAccess?: PlayAccess

    BaseItemDto

    PlaylistItemId?: string | null

    Gets or sets the playlist item identifier.

    BaseItemDto

    PreferredMetadataCountryCode?: string | null

    BaseItemDto

    PreferredMetadataLanguage?: string | null

    BaseItemDto

    PremiereDate?: string | null

    Gets or sets the premiere date.

    BaseItemDto

    PrimaryImageAspectRatio?: number | null

    Gets or sets the primary image aspect ratio, after image enhancements.

    BaseItemDto

    ProductionLocations?: string[] | null

    BaseItemDto

    ProductionYear?: number | null

    Gets or sets the production year.

    BaseItemDto

    ProgramCount?: number | null

    BaseItemDto

    ProgramId?: string | null

    Gets or sets the program identifier.

    BaseItemDto

    ProviderIds?: { [key: string]: string | null } | null

    Gets or sets the provider ids.

    BaseItemDto

    RecursiveItemCount?: number | null

    Gets or sets the recursive item count.

    BaseItemDto

    RemoteTrailers?: MediaUrl[] | null

    Gets or sets the trailer urls.

    BaseItemDto

    RunTimeTicks?: number | null

    Gets or sets the run time ticks.

    BaseItemDto

    ScreenshotImageTags?: string[] | null

    Gets or sets the screenshot image tags.

    BaseItemDto

    SeasonId?: string | null

    Gets or sets the season identifier.

    BaseItemDto

    SeasonName?: string | null

    Gets or sets the name of the season.

    BaseItemDto

    SeriesCount?: number | null

    Gets or sets the series count.

    BaseItemDto

    SeriesId?: string | null

    Gets or sets the series id.

    BaseItemDto

    SeriesName?: string | null

    Gets or sets the name of the series.

    BaseItemDto

    SeriesPrimaryImageTag?: string | null

    Gets or sets the series primary image tag.

    BaseItemDto

    SeriesStudio?: string | null

    Gets or sets the series studio.

    BaseItemDto

    SeriesThumbImageTag?: string | null

    Gets or sets the series thumb image tag.

    BaseItemDto

    SeriesTimerId?: string | null

    Gets or sets the series timer identifier.

    BaseItemDto

    ServerId?: string | null

    Gets or sets the server identifier.

    BaseItemDto

    ShutterSpeed?: number | null

    BaseItemDto

    Software?: string | null

    BaseItemDto

    SongCount?: number | null

    Gets or sets the song count.

    BaseItemDto

    SortName?: string | null

    Gets or sets the name of the sort.

    BaseItemDto

    SourceType?: string | null

    Gets or sets the type of the source.

    BaseItemDto

    SpecialFeatureCount?: number | null

    Gets or sets the special feature count.

    BaseItemDto

    StartDate?: string | null

    Gets or sets the start date of the recording, in UTC.

    BaseItemDto

    Status?: string | null

    Gets or sets the status.

    BaseItemDto

    Studios?: NameGuidPair[] | null

    Gets or sets the studios.

    BaseItemDto

    Taglines?: string[] | null

    Gets or sets the taglines.

    BaseItemDto

    Tags?: string[] | null

    Gets or sets the tags.

    BaseItemDto

    TimerId?: string | null

    Gets or sets the timer identifier.

    BaseItemDto

    TrailerCount?: number | null

    Gets or sets the trailer count.

    BaseItemDto

    Trickplay?: { [key: string]: { [key: string]: TrickplayInfoDto } } | null

    Gets or sets the trickplay manifest.

    BaseItemDto

    BaseItemDto

    UserData?: UserItemDataDto

    BaseItemDto

    Video3DFormat?: Video3DFormat

    BaseItemDto

    VideoType?: VideoType

    BaseItemDto

    Width?: number | null

    BaseItemDto