Type Alias 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.

type BaseItemDto = {
    Name?: string | null;
    OriginalTitle?: string | null;
    ServerId?: string | null;
    Id?: string;
    Etag?: string | null;
    SourceType?: string | null;
    PlaylistItemId?: string | null;
    DateCreated?: string | null;
    DateLastMediaAdded?: string | null;
    ExtraType?:
        | "Unknown"
        | "Clip"
        | "Trailer"
        | "BehindTheScenes"
        | "DeletedScene"
        | "Interview"
        | "Scene"
        | "Sample"
        | "ThemeSong"
        | "ThemeVideo"
        | "Featurette"
        | "Short";
    AirsBeforeSeasonNumber?: number
    | null;
    AirsAfterSeasonNumber?: number | null;
    AirsBeforeEpisodeNumber?: number | null;
    CanDelete?: boolean | null;
    CanDownload?: boolean | null;
    HasLyrics?: boolean | null;
    HasSubtitles?: boolean | null;
    PreferredMetadataLanguage?: string | null;
    PreferredMetadataCountryCode?: string | null;
    Container?: string | null;
    SortName?: string | null;
    ForcedSortName?: string | null;
    Video3DFormat?:
        | "HalfSideBySide"
        | "FullSideBySide"
        | "FullTopAndBottom"
        | "HalfTopAndBottom"
        | "MVC";
    PremiereDate?: string
    | null;
    ExternalUrls?: ExternalUrl[] | null;
    MediaSources?: MediaSourceInfo[] | null;
    CriticRating?: number | null;
    ProductionLocations?: string[] | null;
    Path?: string | null;
    EnableMediaSourceDisplay?: boolean | null;
    OfficialRating?: string | null;
    CustomRating?: string | null;
    ChannelId?: string | null;
    ChannelName?: string | null;
    Overview?: string | null;
    Taglines?: string[] | null;
    Genres?: string[] | null;
    CommunityRating?: number | null;
    CumulativeRunTimeTicks?: number | null;
    RunTimeTicks?: number | null;
    PlayAccess?: "Full" | "None";
    AspectRatio?: string | null;
    ProductionYear?: number | null;
    IsPlaceHolder?: boolean | null;
    Number?: string | null;
    ChannelNumber?: string | null;
    IndexNumber?: number | null;
    IndexNumberEnd?: number | null;
    ParentIndexNumber?: number | null;
    RemoteTrailers?: MediaUrl[] | null;
    ProviderIds?: { [key: string]: string | null } | null;
    IsHD?: boolean | null;
    IsFolder?: boolean | null;
    ParentId?: string | null;
    Type?:
        | "AggregateFolder"
        | "Audio"
        | "AudioBook"
        | "BasePluginFolder"
        | "Book"
        | "BoxSet"
        | "Channel"
        | "ChannelFolderItem"
        | "CollectionFolder"
        | "Episode"
        | "Folder"
        | "Genre"
        | "ManualPlaylistsFolder"
        | "Movie"
        | "LiveTvChannel"
        | "LiveTvProgram"
        | "MusicAlbum"
        | "MusicArtist"
        | "MusicGenre"
        | "MusicVideo"
        | "Person"
        | "Photo"
        | "PhotoAlbum"
        | "Playlist"
        | "PlaylistsFolder"
        | "Program"
        | "Recording"
        | "Season"
        | "Series"
        | "Studio"
        | "Trailer"
        | "TvChannel"
        | "TvProgram"
        | "UserRootFolder"
        | "UserView"
        | "Video"
        | "Year";
    People?: BaseItemPerson[]
    | null;
    Studios?: NameGuidPair[] | null;
    GenreItems?: NameGuidPair[] | null;
    ParentLogoItemId?: string | null;
    ParentBackdropItemId?: string | null;
    ParentBackdropImageTags?: string[] | null;
    LocalTrailerCount?: number | null;
    UserData?: UserItemDataDto | null;
    RecursiveItemCount?: number | null;
    ChildCount?: number | null;
    SeriesName?: string | null;
    SeriesId?: string | null;
    SeasonId?: string | null;
    SpecialFeatureCount?: number | null;
    DisplayPreferencesId?: string | null;
    Status?: string | null;
    AirTime?: string | null;
    AirDays?: DayOfWeek[] | null;
    Tags?: string[] | null;
    PrimaryImageAspectRatio?: number | null;
    Artists?: string[] | null;
    ArtistItems?: NameGuidPair[] | null;
    Album?: string | null;
    CollectionType?:
        | "unknown"
        | "movies"
        | "tvshows"
        | "music"
        | "musicvideos"
        | "trailers"
        | "homevideos"
        | "boxsets"
        | "books"
        | "photos"
        | "livetv"
        | "playlists"
        | "folders";
    DisplayOrder?: string
    | null;
    AlbumId?: string | null;
    AlbumPrimaryImageTag?: string | null;
    SeriesPrimaryImageTag?: string | null;
    AlbumArtist?: string | null;
    AlbumArtists?: NameGuidPair[] | null;
    SeasonName?: string | null;
    MediaStreams?: MediaStream[] | null;
    VideoType?: "VideoFile" | "Iso" | "Dvd" | "BluRay";
    PartCount?: number | null;
    MediaSourceCount?: number | null;
    ImageTags?: { [key: string]: string | null } | null;
    BackdropImageTags?: string[] | null;
    ScreenshotImageTags?: string[] | null;
    ParentLogoImageTag?: string | null;
    ParentArtItemId?: string | null;
    ParentArtImageTag?: string | null;
    SeriesThumbImageTag?: string | null;
    ImageBlurHashes?:
        | {
            Primary?: { [key: string]: string
            | null };
            Art?: { [key: string]: string | null };
            Backdrop?: { [key: string]: string | null };
            Banner?: { [key: string]: string | null };
            Logo?: { [key: string]: string | null };
            Thumb?: { [key: string]: string | null };
            Disc?: { [key: string]: string | null };
            Box?: { [key: string]: string | null };
            Screenshot?: { [key: string]: string | null };
            Menu?: { [key: string]: string | null };
            Chapter?: { [key: string]: string | null };
            BoxRear?: { [key: string]: string | null };
            Profile?: { [key: string]: string | null };
        }
        | null;
    SeriesStudio?: string
    | null;
    ParentThumbItemId?: string | null;
    ParentThumbImageTag?: string | null;
    ParentPrimaryImageItemId?: string | null;
    ParentPrimaryImageTag?: string | null;
    Chapters?: ChapterInfo[] | null;
    Trickplay?:
        | { [key: string]: { [key: string]: TrickplayInfoDto }
        | null }
        | null;
    LocationType?: "FileSystem" | "Remote" | "Virtual" | "Offline";
    IsoType?: "Dvd" | "BluRay";
    MediaType?: "Unknown" | "Video" | "Audio" | "Photo" | "Book";
    EndDate?: string | null;
    LockedFields?: MetadataField[] | null;
    TrailerCount?: number | null;
    MovieCount?: number | null;
    SeriesCount?: number | null;
    ProgramCount?: number | null;
    EpisodeCount?: number | null;
    SongCount?: number | null;
    AlbumCount?: number | null;
    ArtistCount?: number | null;
    MusicVideoCount?: number | null;
    LockData?: boolean | null;
    Width?: number | null;
    Height?: number | null;
    CameraMake?: string | null;
    CameraModel?: string | null;
    Software?: string | null;
    ExposureTime?: number | null;
    FocalLength?: number | null;
    ImageOrientation?:
        | "TopLeft"
        | "TopRight"
        | "BottomRight"
        | "BottomLeft"
        | "LeftTop"
        | "RightTop"
        | "RightBottom"
        | "LeftBottom";
    Aperture?: number
    | null;
    ShutterSpeed?: number | null;
    Latitude?: number | null;
    Longitude?: number | null;
    Altitude?: number | null;
    IsoSpeedRating?: number | null;
    SeriesTimerId?: string | null;
    ProgramId?: string | null;
    ChannelPrimaryImageTag?: string | null;
    StartDate?: string | null;
    CompletionPercentage?: number | null;
    IsRepeat?: boolean | null;
    EpisodeTitle?: string | null;
    ChannelType?: "TV" | "Radio";
    Audio?: "Mono" | "Stereo" | "Dolby" | "DolbyDigital" | "Thx" | "Atmos";
    IsMovie?: boolean | null;
    IsSports?: boolean | null;
    IsSeries?: boolean | null;
    IsLive?: boolean | null;
    IsNews?: boolean | null;
    IsKids?: boolean | null;
    IsPremiere?: boolean | null;
    TimerId?: string | null;
    NormalizationGain?: number | null;
    AlbumNormalizationGain?: number | null;
    CurrentProgram?: BaseItemDto | null;
    OriginalLanguage?: string | null;
}

Index

Properties

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

Properties

`Optional`Name

Name?: string | null

Gets or sets the name.

`Optional`OriginalTitle

OriginalTitle?: string | null

`Optional`ServerId

ServerId?: string | null

Gets or sets the server identifier.

`Optional`Id

Id?: string

Gets or sets the id.

`Optional`Etag

Etag?: string | null

Gets or sets the etag.

`Optional`SourceType

SourceType?: string | null

Gets or sets the type of the source.

`Optional`PlaylistItemId

PlaylistItemId?: string | null

Gets or sets the playlist item identifier.

`Optional`DateCreated

DateCreated?: string | null

Gets or sets the date created.

`Optional`DateLastMediaAdded

DateLastMediaAdded?: string | null

`Optional`ExtraType

`Optional`AirsBeforeSeasonNumber

AirsBeforeSeasonNumber?: number | null

`Optional`AirsAfterSeasonNumber

AirsAfterSeasonNumber?: number | null

`Optional`AirsBeforeEpisodeNumber

AirsBeforeEpisodeNumber?: number | null

`Optional`CanDelete

CanDelete?: boolean | null

`Optional`CanDownload

CanDownload?: boolean | null

`Optional`HasLyrics

HasLyrics?: boolean | null

`Optional`HasSubtitles

HasSubtitles?: boolean | null

`Optional`PreferredMetadataLanguage

PreferredMetadataLanguage?: string | null

`Optional`PreferredMetadataCountryCode

PreferredMetadataCountryCode?: string | null

`Optional`Container

Container?: string | null

`Optional`SortName

SortName?: string | null

Gets or sets the name of the sort.

`Optional`ForcedSortName

ForcedSortName?: string | null

`Optional`Video3DFormat

Gets or sets the video3 D format.

`Optional`PremiereDate

PremiereDate?: string | null

Gets or sets the premiere date.

`Optional`ExternalUrls

ExternalUrls?: ExternalUrl[] | null

Gets or sets the external urls.

`Optional`MediaSources

MediaSources?: MediaSourceInfo[] | null

Gets or sets the media versions.

`Optional`CriticRating

CriticRating?: number | null

Gets or sets the critic rating.

`Optional`ProductionLocations

ProductionLocations?: string[] | null

`Optional`Path

Path?: string | null

Gets or sets the path.

`Optional`EnableMediaSourceDisplay

EnableMediaSourceDisplay?: boolean | null

`Optional`OfficialRating

OfficialRating?: string | null

Gets or sets the official rating.

`Optional`CustomRating

CustomRating?: string | null

Gets or sets the custom rating.

`Optional`ChannelId

ChannelId?: string | null

Gets or sets the channel identifier.

`Optional`ChannelName

ChannelName?: string | null

`Optional`Overview

Overview?: string | null

Gets or sets the overview.

`Optional`Taglines

Taglines?: string[] | null

Gets or sets the taglines.

`Optional`Genres

Genres?: string[] | null

Gets or sets the genres.

`Optional`CommunityRating

CommunityRating?: number | null

Gets or sets the community rating.

`Optional`CumulativeRunTimeTicks

CumulativeRunTimeTicks?: number | null

Gets or sets the cumulative run time ticks.

`Optional`RunTimeTicks

RunTimeTicks?: number | null

Gets or sets the run time ticks.

`Optional`PlayAccess

PlayAccess?: "Full" | "None"

Gets or sets the play access.

`Optional`AspectRatio

AspectRatio?: string | null

Gets or sets the aspect ratio.

`Optional`ProductionYear

ProductionYear?: number | null

Gets or sets the production year.

`Optional`IsPlaceHolder

IsPlaceHolder?: boolean | null

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

`Optional`Number

Number?: string | null

Gets or sets the number.

`Optional`ChannelNumber

ChannelNumber?: string | null

`Optional`IndexNumber

IndexNumber?: number | null

Gets or sets the index number.

`Optional`IndexNumberEnd

IndexNumberEnd?: number | null

Gets or sets the index number end.

`Optional`ParentIndexNumber

ParentIndexNumber?: number | null

Gets or sets the parent index number.

`Optional`RemoteTrailers

RemoteTrailers?: MediaUrl[] | null

Gets or sets the trailer urls.

`Optional`ProviderIds

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

Gets or sets the provider ids.

`Optional`IsHD

IsHD?: boolean | null

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

`Optional`IsFolder

IsFolder?: boolean | null

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

`Optional`ParentId

ParentId?: string | null

Gets or sets the parent id.

`Optional`Type

Gets or sets the type.

`Optional`People

People?: BaseItemPerson[] | null

Gets or sets the people.

`Optional`Studios

Studios?: NameGuidPair[] | null

Gets or sets the studios.

`Optional`GenreItems

GenreItems?: NameGuidPair[] | null

`Optional`ParentLogoItemId

ParentLogoItemId?: string | null

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

`Optional`ParentBackdropItemId

ParentBackdropItemId?: string | null

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

`Optional`ParentBackdropImageTags

ParentBackdropImageTags?: string[] | null

Gets or sets the parent backdrop image tags.

`Optional`LocalTrailerCount

LocalTrailerCount?: number | null

Gets or sets the local trailer count.

`Optional`UserData

UserData?: UserItemDataDto | null

Gets or sets the user data for this item based on the user it's being requested for.

`Optional`RecursiveItemCount

RecursiveItemCount?: number | null

Gets or sets the recursive item count.

`Optional`ChildCount

ChildCount?: number | null

Gets or sets the child count.

`Optional`SeriesName

SeriesName?: string | null

Gets or sets the name of the series.

`Optional`SeriesId

SeriesId?: string | null

Gets or sets the series id.

`Optional`SeasonId

SeasonId?: string | null

Gets or sets the season identifier.

`Optional`SpecialFeatureCount

SpecialFeatureCount?: number | null

Gets or sets the special feature count.

`Optional`DisplayPreferencesId

DisplayPreferencesId?: string | null

Gets or sets the display preferences id.

`Optional`Status

Status?: string | null

Gets or sets the status.

`Optional`AirTime

AirTime?: string | null

Gets or sets the air time.

`Optional`AirDays

AirDays?: DayOfWeek[] | null

Gets or sets the air days.

`Optional`Tags

Tags?: string[] | null

Gets or sets the tags.

`Optional`PrimaryImageAspectRatio

PrimaryImageAspectRatio?: number | null

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

`Optional`Artists

Artists?: string[] | null

Gets or sets the artists.

`Optional`ArtistItems

ArtistItems?: NameGuidPair[] | null

Gets or sets the artist items.

`Optional`Album

Album?: string | null

Gets or sets the album.

`Optional`CollectionType

Gets or sets the type of the collection.

`Optional`DisplayOrder

DisplayOrder?: string | null

Gets or sets the display order.

`Optional`AlbumId

AlbumId?: string | null

Gets or sets the album id.

`Optional`AlbumPrimaryImageTag

AlbumPrimaryImageTag?: string | null

Gets or sets the album image tag.

`Optional`SeriesPrimaryImageTag

SeriesPrimaryImageTag?: string | null

Gets or sets the series primary image tag.

`Optional`AlbumArtist

AlbumArtist?: string | null

Gets or sets the album artist.

`Optional`AlbumArtists

AlbumArtists?: NameGuidPair[] | null

Gets or sets the album artists.

`Optional`SeasonName

SeasonName?: string | null

Gets or sets the name of the season.

`Optional`MediaStreams

MediaStreams?: MediaStream[] | null

Gets or sets the media streams.

`Optional`VideoType

VideoType?: "VideoFile" | "Iso" | "Dvd" | "BluRay"

Gets or sets the type of the video.

`Optional`PartCount

PartCount?: number | null

Gets or sets the part count.

`Optional`MediaSourceCount

MediaSourceCount?: number | null

`Optional`ImageTags

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

Gets or sets the image tags.

`Optional`BackdropImageTags

BackdropImageTags?: string[] | null

Gets or sets the backdrop image tags.

`Optional`ScreenshotImageTags

ScreenshotImageTags?: string[] | null

Gets or sets the screenshot image tags.

`Optional`ParentLogoImageTag

ParentLogoImageTag?: string | null

Gets or sets the parent logo image tag.

`Optional`ParentArtItemId

ParentArtItemId?: string | null

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

`Optional`ParentArtImageTag

ParentArtImageTag?: string | null

Gets or sets the parent art image tag.

`Optional`SeriesThumbImageTag

SeriesThumbImageTag?: string | null

Gets or sets the series thumb image tag.

`Optional`ImageBlurHashes

ImageBlurHashes?:
    | {
        Primary?: { [key: string]: string
        | null };
        Art?: { [key: string]: string | null };
        Backdrop?: { [key: string]: string | null };
        Banner?: { [key: string]: string | null };
        Logo?: { [key: string]: string | null };
        Thumb?: { [key: string]: string | null };
        Disc?: { [key: string]: string | null };
        Box?: { [key: string]: string | null };
        Screenshot?: { [key: string]: string | null };
        Menu?: { [key: string]: string | null };
        Chapter?: { [key: string]: string | null };
        BoxRear?: { [key: string]: string | null };
        Profile?: { [key: string]: string | null };
    }
    | null

Gets or sets the blurhashes for the image tags. Maps image type to dictionary mapping image tag to blurhash value.

`Optional`SeriesStudio

SeriesStudio?: string | null

Gets or sets the series studio.

`Optional`ParentThumbItemId

ParentThumbItemId?: string | null

Gets or sets the parent thumb item id.

`Optional`ParentThumbImageTag

ParentThumbImageTag?: string | null

Gets or sets the parent thumb image tag.

`Optional`ParentPrimaryImageItemId

ParentPrimaryImageItemId?: string | null

Gets or sets the parent primary image item identifier.

`Optional`ParentPrimaryImageTag

ParentPrimaryImageTag?: string | null

Gets or sets the parent primary image tag.

`Optional`Chapters

Chapters?: ChapterInfo[] | null

Gets or sets the chapters.

`Optional`Trickplay

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

Gets or sets the trickplay manifest.

`Optional`LocationType

LocationType?: "FileSystem" | "Remote" | "Virtual" | "Offline"

Gets or sets the type of the location.

`Optional`IsoType

IsoType?: "Dvd" | "BluRay"

Gets or sets the type of the iso.

`Optional`MediaType

MediaType?: "Unknown" | "Video" | "Audio" | "Photo" | "Book"

Gets or sets the type of the media.

`Optional`EndDate

EndDate?: string | null

Gets or sets the end date.

`Optional`LockedFields

LockedFields?: MetadataField[] | null

Gets or sets the locked fields.

`Optional`TrailerCount

TrailerCount?: number | null

Gets or sets the trailer count.

`Optional`MovieCount

MovieCount?: number | null

Gets or sets the movie count.

`Optional`SeriesCount

SeriesCount?: number | null

Gets or sets the series count.

`Optional`ProgramCount

ProgramCount?: number | null

`Optional`EpisodeCount

EpisodeCount?: number | null

Gets or sets the episode count.

`Optional`SongCount

SongCount?: number | null

Gets or sets the song count.

`Optional`AlbumCount

AlbumCount?: number | null

Gets or sets the album count.

`Optional`ArtistCount

ArtistCount?: number | null

`Optional`MusicVideoCount

MusicVideoCount?: number | null

Gets or sets the music video count.

`Optional`LockData

LockData?: boolean | null

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

`Optional`Width

Width?: number | null

`Optional`Height

Height?: number | null

`Optional`CameraMake

CameraMake?: string | null

`Optional`CameraModel

CameraModel?: string | null

`Optional`Software

Software?: string | null

`Optional`ExposureTime

ExposureTime?: number | null

`Optional`FocalLength

FocalLength?: number | null

`Optional`ImageOrientation

`Optional`Aperture

Aperture?: number | null

`Optional`ShutterSpeed

ShutterSpeed?: number | null

`Optional`Latitude

Latitude?: number | null

`Optional`Longitude

Longitude?: number | null

`Optional`Altitude

Altitude?: number | null

`Optional`IsoSpeedRating

IsoSpeedRating?: number | null

`Optional`SeriesTimerId

SeriesTimerId?: string | null

Gets or sets the series timer identifier.

`Optional`ProgramId

ProgramId?: string | null

Gets or sets the program identifier.

`Optional`ChannelPrimaryImageTag

ChannelPrimaryImageTag?: string | null

Gets or sets the channel primary image tag.

`Optional`StartDate

StartDate?: string | null

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

`Optional`CompletionPercentage

CompletionPercentage?: number | null

Gets or sets the completion percentage.

`Optional`IsRepeat

IsRepeat?: boolean | null

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

`Optional`EpisodeTitle

EpisodeTitle?: string | null

Gets or sets the episode title.

`Optional`ChannelType

ChannelType?: "TV" | "Radio"

Gets or sets the type of the channel.

`Optional`Audio

Gets or sets the audio.

`Optional`IsMovie

IsMovie?: boolean | null

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

`Optional`IsSports

IsSports?: boolean | null

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

`Optional`IsSeries

IsSeries?: boolean | null

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

`Optional`IsLive

IsLive?: boolean | null

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

`Optional`IsNews

IsNews?: boolean | null

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

`Optional`IsKids

IsKids?: boolean | null

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

`Optional`IsPremiere

IsPremiere?: boolean | null

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

`Optional`TimerId

TimerId?: string | null

Gets or sets the timer identifier.

`Optional`NormalizationGain

NormalizationGain?: number | null

Gets or sets the gain required for audio normalization.

`Optional`AlbumNormalizationGain

AlbumNormalizationGain?: number | null

Gets or sets the gain required for audio normalization. This field is inherited from music album normalization gain.

`Optional`CurrentProgram

CurrentProgram?: BaseItemDto | null

Gets or sets the current program.

`Optional`OriginalLanguage

OriginalLanguage?: string | null

Type Alias BaseItemDto

Index

Properties

Properties

OptionalName

OptionalOriginalTitle

OptionalServerId

OptionalId

OptionalEtag

OptionalSourceType

OptionalPlaylistItemId

OptionalDateCreated

OptionalDateLastMediaAdded

OptionalExtraType

OptionalAirsBeforeSeasonNumber

OptionalAirsAfterSeasonNumber

OptionalAirsBeforeEpisodeNumber

OptionalCanDelete

OptionalCanDownload

OptionalHasLyrics

OptionalHasSubtitles

OptionalPreferredMetadataLanguage

OptionalPreferredMetadataCountryCode

OptionalContainer

OptionalSortName

OptionalForcedSortName

OptionalVideo3DFormat

OptionalPremiereDate

OptionalExternalUrls

OptionalMediaSources

OptionalCriticRating

OptionalProductionLocations

OptionalPath

OptionalEnableMediaSourceDisplay

OptionalOfficialRating

OptionalCustomRating

OptionalChannelId

OptionalChannelName

OptionalOverview

OptionalTaglines

OptionalGenres

OptionalCommunityRating

OptionalCumulativeRunTimeTicks

OptionalRunTimeTicks

OptionalPlayAccess

OptionalAspectRatio

OptionalProductionYear

OptionalIsPlaceHolder

OptionalNumber

OptionalChannelNumber

OptionalIndexNumber

OptionalIndexNumberEnd

OptionalParentIndexNumber

OptionalRemoteTrailers

OptionalProviderIds

OptionalIsHD

OptionalIsFolder

OptionalParentId

OptionalType

OptionalPeople

OptionalStudios

OptionalGenreItems

OptionalParentLogoItemId

OptionalParentBackdropItemId

OptionalParentBackdropImageTags

OptionalLocalTrailerCount

OptionalUserData

OptionalRecursiveItemCount

OptionalChildCount

OptionalSeriesName

OptionalSeriesId

OptionalSeasonId

OptionalSpecialFeatureCount

OptionalDisplayPreferencesId

OptionalStatus

OptionalAirTime

OptionalAirDays

OptionalTags

OptionalPrimaryImageAspectRatio

OptionalArtists

`Optional`Name

`Optional`OriginalTitle

`Optional`ServerId

`Optional`Id

`Optional`Etag

`Optional`SourceType

`Optional`PlaylistItemId

`Optional`DateCreated

`Optional`DateLastMediaAdded

`Optional`ExtraType

`Optional`AirsBeforeSeasonNumber

`Optional`AirsAfterSeasonNumber

`Optional`AirsBeforeEpisodeNumber

`Optional`CanDelete

`Optional`CanDownload

`Optional`HasLyrics

`Optional`HasSubtitles

`Optional`PreferredMetadataLanguage

`Optional`PreferredMetadataCountryCode

`Optional`Container

`Optional`SortName

`Optional`ForcedSortName

`Optional`Video3DFormat

`Optional`PremiereDate

`Optional`ExternalUrls

`Optional`MediaSources

`Optional`CriticRating

`Optional`ProductionLocations

`Optional`Path

`Optional`EnableMediaSourceDisplay

`Optional`OfficialRating

`Optional`CustomRating

`Optional`ChannelId

`Optional`ChannelName

`Optional`Overview

`Optional`Taglines

`Optional`Genres

`Optional`CommunityRating

`Optional`CumulativeRunTimeTicks

`Optional`RunTimeTicks

`Optional`PlayAccess

`Optional`AspectRatio

`Optional`ProductionYear

`Optional`IsPlaceHolder

`Optional`Number

`Optional`ChannelNumber

`Optional`IndexNumber

`Optional`IndexNumberEnd

`Optional`ParentIndexNumber

`Optional`RemoteTrailers

`Optional`ProviderIds

`Optional`IsHD

`Optional`IsFolder

`Optional`ParentId

`Optional`Type

`Optional`People

`Optional`Studios

`Optional`GenreItems

`Optional`ParentLogoItemId

`Optional`ParentBackdropItemId

`Optional`ParentBackdropImageTags

`Optional`LocalTrailerCount

`Optional`UserData

`Optional`RecursiveItemCount

`Optional`ChildCount

`Optional`SeriesName

`Optional`SeriesId

`Optional`SeasonId

`Optional`SpecialFeatureCount

`Optional`DisplayPreferencesId

`Optional`Status

`Optional`AirTime

`Optional`AirDays

`Optional`Tags

`Optional`PrimaryImageAspectRatio

`Optional`Artists

`Optional`ArtistItems

`Optional`Album

`Optional`CollectionType

`Optional`DisplayOrder