@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.

    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.

    AirsAfterSeasonNumber?: number | null
    AirsBeforeEpisodeNumber?: number | null
    AirsBeforeSeasonNumber?: number | null
    AirTime?: string | null

    Gets or sets the air time.

    Album?: string | null

    Gets or sets the album.

    AlbumArtist?: string | null

    Gets or sets the album artist.

    AlbumArtists?: NameGuidPair[] | null

    Gets or sets the album artists.

    AlbumCount?: number | null

    Gets or sets the album count.

    AlbumId?: string | null

    Gets or sets the album id.

    AlbumPrimaryImageTag?: string | null

    Gets or sets the album image tag.

    Altitude?: number | null
    Aperture?: number | null
    ArtistCount?: number | null
    ArtistItems?: NameGuidPair[] | null

    Gets or sets the artist items.

    Artists?: string[] | null

    Gets or sets the artists.

    AspectRatio?: string | null

    Gets or sets the aspect ratio.

    Audio?: ProgramAudio
    BackdropImageTags?: string[] | null

    Gets or sets the backdrop image tags.

    CameraMake?: string | null
    CameraModel?: string | null
    CanDelete?: boolean | null
    CanDownload?: boolean | null
    ChannelId?: string | null

    Gets or sets the channel identifier.

    ChannelName?: string | null
    ChannelNumber?: string | null
    ChannelPrimaryImageTag?: string | null

    Gets or sets the channel primary image tag.

    ChannelType?: ChannelType
    Chapters?: ChapterInfo[] | null

    Gets or sets the chapters.

    ChildCount?: number | null

    Gets or sets the child count.

    CollectionType?: CollectionType
    CommunityRating?: number | null

    Gets or sets the community rating.

    CompletionPercentage?: number | null

    Gets or sets the completion percentage.

    Container?: string | null
    CriticRating?: number | null

    Gets or sets the critic rating.

    CumulativeRunTimeTicks?: number | null

    Gets or sets the cumulative run time ticks.

    CurrentProgram?: BaseItemDto
    CustomRating?: string | null

    Gets or sets the custom rating.

    DateCreated?: string | null

    Gets or sets the date created.

    DateLastMediaAdded?: string | null
    DisplayOrder?: string | null

    Gets or sets the display order.

    DisplayPreferencesId?: string | null

    Gets or sets the display preferences id.

    EnableMediaSourceDisplay?: boolean | null
    EndDate?: string | null

    Gets or sets the end date.

    EpisodeCount?: number | null

    Gets or sets the episode count.

    EpisodeTitle?: string | null

    Gets or sets the episode title.

    Etag?: string | null

    Gets or sets the etag.

    ExposureTime?: number | null
    ExternalUrls?: ExternalUrl[] | null

    Gets or sets the external urls.

    ExtraType?: ExtraType
    FocalLength?: number | null
    ForcedSortName?: string | null
    GenreItems?: NameGuidPair[] | null
    Genres?: string[] | null

    Gets or sets the genres.

    HasLyrics?: boolean | null
    HasSubtitles?: boolean | null
    Height?: number | null
    Id?: string

    Gets or sets the id.

    ImageBlurHashes?: BaseItemDtoImageBlurHashes | null
    ImageOrientation?: ImageOrientation
    ImageTags?: { [key: string]: string } | null

    Gets or sets the image tags.

    IndexNumber?: number | null

    Gets or sets the index number.

    IndexNumberEnd?: number | null

    Gets or sets the index number end.

    IsFolder?: boolean | null

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

    IsHD?: boolean | null

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

    IsKids?: boolean | null

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

    IsLive?: boolean | null

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

    IsMovie?: boolean | null

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

    IsNews?: boolean | null

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

    IsoSpeedRating?: number | null
    IsoType?: IsoType
    IsPlaceHolder?: boolean | null

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

    IsPremiere?: boolean | null

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

    IsRepeat?: boolean | null

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

    IsSeries?: boolean | null

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

    IsSports?: boolean | null

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

    Latitude?: number | null
    LocalTrailerCount?: number | null

    Gets or sets the local trailer count.

    LocationType?: LocationType
    LockData?: boolean | null

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

    LockedFields?: MetadataField[] | null

    Gets or sets the locked fields.

    Longitude?: number | null
    MediaSourceCount?: number | null
    MediaSources?: MediaSourceInfo[] | null

    Gets or sets the media versions.

    MediaStreams?: MediaStream[] | null

    Gets or sets the media streams.

    MediaType?: MediaType
    MovieCount?: number | null

    Gets or sets the movie count.

    MusicVideoCount?: number | null

    Gets or sets the music video count.

    Name?: string | null

    Gets or sets the name.

    NormalizationGain?: number | null

    Gets or sets the gain required for audio normalization.

    Number?: string | null

    Gets or sets the number.

    OfficialRating?: string | null

    Gets or sets the official rating.

    OriginalTitle?: string | null
    Overview?: string | null

    Gets or sets the overview.

    ParentArtImageTag?: string | null

    Gets or sets the parent art image tag.

    ParentArtItemId?: string | null

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

    ParentBackdropImageTags?: string[] | null

    Gets or sets the parent backdrop image tags.

    ParentBackdropItemId?: string | null

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

    ParentId?: string | null

    Gets or sets the parent id.

    ParentIndexNumber?: number | null

    Gets or sets the parent index number.

    ParentLogoImageTag?: string | null

    Gets or sets the parent logo image tag.

    ParentLogoItemId?: string | null

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

    ParentPrimaryImageItemId?: string | null

    Gets or sets the parent primary image item identifier.

    ParentPrimaryImageTag?: string | null

    Gets or sets the parent primary image tag.

    ParentThumbImageTag?: string | null

    Gets or sets the parent thumb image tag.

    ParentThumbItemId?: string | null

    Gets or sets the parent thumb item id.

    PartCount?: number | null

    Gets or sets the part count.

    Path?: string | null

    Gets or sets the path.

    People?: BaseItemPerson[] | null

    Gets or sets the people.

    PlayAccess?: PlayAccess
    PlaylistItemId?: string | null

    Gets or sets the playlist item identifier.

    PreferredMetadataCountryCode?: string | null
    PreferredMetadataLanguage?: string | null
    PremiereDate?: string | null

    Gets or sets the premiere date.

    PrimaryImageAspectRatio?: number | null

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

    ProductionLocations?: string[] | null
    ProductionYear?: number | null

    Gets or sets the production year.

    ProgramCount?: number | null
    ProgramId?: string | null

    Gets or sets the program identifier.

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

    Gets or sets the provider ids.

    RecursiveItemCount?: number | null

    Gets or sets the recursive item count.

    RemoteTrailers?: MediaUrl[] | null

    Gets or sets the trailer urls.

    RunTimeTicks?: number | null

    Gets or sets the run time ticks.

    ScreenshotImageTags?: string[] | null

    Gets or sets the screenshot image tags.

    SeasonId?: string | null

    Gets or sets the season identifier.

    SeasonName?: string | null

    Gets or sets the name of the season.

    SeriesCount?: number | null

    Gets or sets the series count.

    SeriesId?: string | null

    Gets or sets the series id.

    SeriesName?: string | null

    Gets or sets the name of the series.

    SeriesPrimaryImageTag?: string | null

    Gets or sets the series primary image tag.

    SeriesStudio?: string | null

    Gets or sets the series studio.

    SeriesThumbImageTag?: string | null

    Gets or sets the series thumb image tag.

    SeriesTimerId?: string | null

    Gets or sets the series timer identifier.

    ServerId?: string | null

    Gets or sets the server identifier.

    ShutterSpeed?: number | null
    Software?: string | null
    SongCount?: number | null

    Gets or sets the song count.

    SortName?: string | null

    Gets or sets the name of the sort.

    SourceType?: string | null

    Gets or sets the type of the source.

    SpecialFeatureCount?: number | null

    Gets or sets the special feature count.

    StartDate?: string | null

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

    Status?: string | null

    Gets or sets the status.

    Studios?: NameGuidPair[] | null

    Gets or sets the studios.

    Taglines?: string[] | null

    Gets or sets the taglines.

    Tags?: string[] | null

    Gets or sets the tags.

    TimerId?: string | null

    Gets or sets the timer identifier.

    TrailerCount?: number | null

    Gets or sets the trailer count.

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

    Gets or sets the trickplay manifest.

    Type?: BaseItemKind
    UserData?: UserItemDataDto
    Video3DFormat?: Video3DFormat
    VideoType?: VideoType
    Width?: number | null

    Settings

    Member Visibility

    On This Page

    Properties
    AirDaysAirsAfterSeasonNumberAirsBeforeEpisodeNumberAirsBeforeSeasonNumberAirTimeAlbumAlbumArtistAlbumArtistsAlbumCountAlbumIdAlbumPrimaryImageTagAltitudeApertureArtistCountArtistItemsArtistsAspectRatioAudioBackdropImageTagsCameraMakeCameraModelCanDeleteCanDownloadChannelIdChannelNameChannelNumberChannelPrimaryImageTagChannelTypeChaptersChildCountCollectionTypeCommunityRatingCompletionPercentageContainerCriticRatingCumulativeRunTimeTicksCurrentProgramCustomRatingDateCreatedDateLastMediaAddedDisplayOrderDisplayPreferencesIdEnableMediaSourceDisplayEndDateEpisodeCountEpisodeTitleEtagExposureTimeExternalUrlsExtraTypeFocalLengthForcedSortNameGenreItemsGenresHasLyricsHasSubtitlesHeightIdImageBlurHashesImageOrientationImageTagsIndexNumberIndexNumberEndIsFolderIsHDIsKidsIsLiveIsMovieIsNewsIsoSpeedRatingIsoTypeIsPlaceHolderIsPremiereIsRepeatIsSeriesIsSportsLatitudeLocalTrailerCountLocationTypeLockDataLockedFieldsLongitudeMediaSourceCountMediaSourcesMediaStreamsMediaTypeMovieCountMusicVideoCountNameNormalizationGainNumberOfficialRatingOriginalTitleOverviewParentArtImageTagParentArtItemIdParentBackdropImageTagsParentBackdropItemIdParentIdParentIndexNumberParentLogoImageTagParentLogoItemIdParentPrimaryImageItemIdParentPrimaryImageTagParentThumbImageTagParentThumbItemIdPartCountPathPeoplePlayAccessPlaylistItemIdPreferredMetadataCountryCodePreferredMetadataLanguagePremiereDatePrimaryImageAspectRatioProductionLocationsProductionYearProgramCountProgramIdProviderIdsRecursiveItemCountRemoteTrailersRunTimeTicksScreenshotImageTagsSeasonIdSeasonNameSeriesCountSeriesIdSeriesNameSeriesPrimaryImageTagSeriesStudioSeriesThumbImageTagSeriesTimerIdServerIdShutterSpeedSoftwareSongCountSortNameSourceTypeSpecialFeatureCountStartDateStatusStudiosTaglinesTagsTimerIdTrailerCountTrickplayTypeUserDataVideo3DFormatVideoTypeWidth