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.

Export

BaseItemDto

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

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

`Optional`AirDays

AirDays?: null | DayOfWeek[]

Gets or sets the air days.

Memberof

BaseItemDto

`Optional`AirsAfterSeasonNumber

AirsAfterSeasonNumber?: null | number

Memberof

BaseItemDto

`Optional`AirsBeforeEpisodeNumber

AirsBeforeEpisodeNumber?: null | number

Memberof

BaseItemDto

`Optional`AirsBeforeSeasonNumber

AirsBeforeSeasonNumber?: null | number

Memberof

BaseItemDto

`Optional`AirTime

AirTime?: null | string

Gets or sets the air time.

Memberof

BaseItemDto

`Optional`Album

Album?: null | string

Gets or sets the album.

Memberof

BaseItemDto

`Optional`AlbumArtist

AlbumArtist?: null | string

Gets or sets the album artist.

Memberof

BaseItemDto

`Optional`AlbumArtists

AlbumArtists?: null | NameGuidPair[]

Gets or sets the album artists.

Memberof

BaseItemDto

`Optional`AlbumCount

AlbumCount?: null | number

Gets or sets the album count.

Memberof

BaseItemDto

`Optional`AlbumId

AlbumId?: null | string

Gets or sets the album id.

Memberof

BaseItemDto

`Optional`AlbumPrimaryImageTag

AlbumPrimaryImageTag?: null | string

Gets or sets the album image tag.

Memberof

BaseItemDto

`Optional`Altitude

Altitude?: null | number

Memberof

BaseItemDto

`Optional`Aperture

Aperture?: null | number

Memberof

BaseItemDto

`Optional`ArtistCount

ArtistCount?: null | number

Memberof

BaseItemDto

`Optional`ArtistItems

ArtistItems?: null | NameGuidPair[]

Gets or sets the artist items.

Memberof

BaseItemDto

`Optional`Artists

Artists?: null | string[]

Gets or sets the artists.

Memberof

BaseItemDto

`Optional`AspectRatio

AspectRatio?: null | string

Gets or sets the aspect ratio.

Memberof

BaseItemDto

`Optional`Audio

Audio?: ProgramAudio

Memberof

BaseItemDto

`Optional`BackdropImageTags

BackdropImageTags?: null | string[]

Gets or sets the backdrop image tags.

Memberof

BaseItemDto

`Optional`CameraMake

CameraMake?: null | string

Memberof

BaseItemDto

`Optional`CameraModel

CameraModel?: null | string

Memberof

BaseItemDto

`Optional`CanDelete

CanDelete?: null | boolean

Memberof

BaseItemDto

`Optional`CanDownload

CanDownload?: null | boolean

Memberof

BaseItemDto

`Optional`ChannelId

ChannelId?: null | string

Gets or sets the channel identifier.

Memberof

BaseItemDto

`Optional`ChannelName

ChannelName?: null | string

Memberof

BaseItemDto

`Optional`ChannelNumber

ChannelNumber?: null | string

Memberof

BaseItemDto

`Optional`ChannelPrimaryImageTag

ChannelPrimaryImageTag?: null | string

Gets or sets the channel primary image tag.

Memberof

BaseItemDto

`Optional`ChannelType

ChannelType?: ChannelType

Memberof

BaseItemDto

`Optional`Chapters

Chapters?: null | ChapterInfo[]

Gets or sets the chapters.

Memberof

BaseItemDto

`Optional`ChildCount

ChildCount?: null | number

Gets or sets the child count.

Memberof

BaseItemDto

`Optional`CollectionType

CollectionType?: CollectionType

Memberof

BaseItemDto

`Optional`CommunityRating

CommunityRating?: null | number

Gets or sets the community rating.

Memberof

BaseItemDto

`Optional`CompletionPercentage

CompletionPercentage?: null | number

Gets or sets the completion percentage.

Memberof

BaseItemDto

`Optional`Container

Container?: null | string

Memberof

BaseItemDto

`Optional`CriticRating

CriticRating?: null | number

Gets or sets the critic rating.

Memberof

BaseItemDto

`Optional`CumulativeRunTimeTicks

CumulativeRunTimeTicks?: null | number

Gets or sets the cumulative run time ticks.

Memberof

BaseItemDto

`Optional`CurrentProgram

CurrentProgram?: BaseItemDto

Memberof

BaseItemDto

`Optional`CustomRating

CustomRating?: null | string

Gets or sets the custom rating.

Memberof

BaseItemDto

`Optional`DateCreated

DateCreated?: null | string

Gets or sets the date created.

Memberof

BaseItemDto

`Optional`DateLastMediaAdded

DateLastMediaAdded?: null | string

Memberof

BaseItemDto

`Optional`DisplayOrder

DisplayOrder?: null | string

Gets or sets the display order.

Memberof

BaseItemDto

`Optional`DisplayPreferencesId

DisplayPreferencesId?: null | string

Gets or sets the display preferences id.

Memberof

BaseItemDto

`Optional`EnableMediaSourceDisplay

EnableMediaSourceDisplay?: null | boolean

Memberof

BaseItemDto

`Optional`EndDate

EndDate?: null | string

Gets or sets the end date.

Memberof

BaseItemDto

`Optional`EpisodeCount

EpisodeCount?: null | number

Gets or sets the episode count.

Memberof

BaseItemDto

`Optional`EpisodeTitle

EpisodeTitle?: null | string

Gets or sets the episode title.

Memberof

BaseItemDto

`Optional`Etag

Etag?: null | string

Gets or sets the etag.

Memberof

BaseItemDto

`Optional`ExposureTime

ExposureTime?: null | number

Memberof

BaseItemDto

`Optional`ExternalUrls

ExternalUrls?: null | ExternalUrl[]

Gets or sets the external urls.

Memberof

BaseItemDto

`Optional`ExtraType

ExtraType?: ExtraType

Memberof

BaseItemDto

`Optional`FocalLength

FocalLength?: null | number

Memberof

BaseItemDto

`Optional`ForcedSortName

ForcedSortName?: null | string

Memberof

BaseItemDto

`Optional`GenreItems

GenreItems?: null | NameGuidPair[]

Memberof

BaseItemDto

`Optional`Genres

Genres?: null | string[]

Gets or sets the genres.

Memberof

BaseItemDto

`Optional`HasLyrics

HasLyrics?: null | boolean

Memberof

BaseItemDto

`Optional`HasSubtitles

HasSubtitles?: null | boolean

Memberof

BaseItemDto

`Optional`Height

Height?: null | number

Memberof

BaseItemDto

`Optional`Id

Id?: string

Gets or sets the id.

Memberof

BaseItemDto

`Optional`ImageBlurHashes

ImageBlurHashes?: null | BaseItemDtoImageBlurHashes

Memberof

BaseItemDto

`Optional`ImageOrientation

ImageOrientation?: ImageOrientation

Memberof

BaseItemDto

`Optional`ImageTags

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

Gets or sets the image tags.

Memberof

BaseItemDto

`Optional`IndexNumber

IndexNumber?: null | number

Gets or sets the index number.

Memberof

BaseItemDto

`Optional`IndexNumberEnd

IndexNumberEnd?: null | number

Gets or sets the index number end.

Memberof

BaseItemDto

`Optional`IsFolder

IsFolder?: null | boolean

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

Memberof

BaseItemDto

`Optional`IsHD

IsHD?: null | boolean

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

Memberof

BaseItemDto

`Optional`IsKids

IsKids?: null | boolean

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

Memberof

BaseItemDto

`Optional`IsLive

IsLive?: null | boolean

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

Memberof

BaseItemDto

`Optional`IsMovie

IsMovie?: null | boolean

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

Memberof

BaseItemDto

`Optional`IsNews

IsNews?: null | boolean

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

Memberof

BaseItemDto

`Optional`IsoSpeedRating

IsoSpeedRating?: null | number

Memberof

BaseItemDto

`Optional`IsoType

IsoType?: IsoType

Memberof

BaseItemDto

`Optional`IsPlaceHolder

IsPlaceHolder?: null | boolean

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

Memberof

BaseItemDto

`Optional`IsPremiere

IsPremiere?: null | boolean

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

Memberof

BaseItemDto

`Optional`IsRepeat

IsRepeat?: null | boolean

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

Memberof

BaseItemDto

`Optional`IsSeries

IsSeries?: null | boolean

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

Memberof

BaseItemDto

`Optional`IsSports

IsSports?: null | boolean

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

Memberof

BaseItemDto

`Optional`Latitude

Latitude?: null | number

Memberof

BaseItemDto

`Optional`LocalTrailerCount

LocalTrailerCount?: null | number

Gets or sets the local trailer count.

Memberof

BaseItemDto

`Optional`LocationType

LocationType?: LocationType

Memberof

BaseItemDto

`Optional`LockData

LockData?: null | boolean

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

Memberof

BaseItemDto

`Optional`LockedFields

LockedFields?: null | MetadataField[]

Gets or sets the locked fields.

Memberof

BaseItemDto

`Optional`Longitude

Longitude?: null | number

Memberof

BaseItemDto

`Optional`MediaSourceCount

MediaSourceCount?: null | number

Memberof

BaseItemDto

`Optional`MediaSources

MediaSources?: null | MediaSourceInfo[]

Gets or sets the media versions.

Memberof

BaseItemDto

`Optional`MediaStreams

MediaStreams?: null | MediaStream[]

Gets or sets the media streams.

Memberof

BaseItemDto

`Optional`MediaType

MediaType?: MediaType

Memberof

BaseItemDto

`Optional`MovieCount

MovieCount?: null | number

Gets or sets the movie count.

Memberof

BaseItemDto

`Optional`MusicVideoCount

MusicVideoCount?: null | number

Gets or sets the music video count.

Memberof

BaseItemDto

`Optional`Name

Name?: null | string

Gets or sets the name.

Memberof

BaseItemDto

`Optional`NormalizationGain

NormalizationGain?: null | number

Gets or sets the gain required for audio normalization.

Memberof

BaseItemDto

`Optional`Number

Number?: null | string

Gets or sets the number.

Memberof

BaseItemDto

`Optional`OfficialRating

OfficialRating?: null | string

Gets or sets the official rating.

Memberof

BaseItemDto

`Optional`OriginalTitle

OriginalTitle?: null | string

Memberof

BaseItemDto

`Optional`Overview

Overview?: null | string

Gets or sets the overview.

Memberof

BaseItemDto

`Optional`ParentArtImageTag

ParentArtImageTag?: null | string

Gets or sets the parent art image tag.

Memberof

BaseItemDto

`Optional`ParentArtItemId

ParentArtItemId?: null | string

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

Memberof

BaseItemDto

`Optional`ParentBackdropImageTags

ParentBackdropImageTags?: null | string[]

Gets or sets the parent backdrop image tags.

Memberof

BaseItemDto

`Optional`ParentBackdropItemId

ParentBackdropItemId?: null | string

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

Memberof

BaseItemDto

`Optional`ParentId

ParentId?: null | string

Gets or sets the parent id.

Memberof

BaseItemDto

`Optional`ParentIndexNumber

ParentIndexNumber?: null | number

Gets or sets the parent index number.

Memberof

BaseItemDto

`Optional`ParentLogoImageTag

ParentLogoImageTag?: null | string

Gets or sets the parent logo image tag.

Memberof

BaseItemDto

`Optional`ParentLogoItemId

ParentLogoItemId?: null | string

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

Memberof

BaseItemDto

`Optional`ParentPrimaryImageItemId

ParentPrimaryImageItemId?: null | string

Gets or sets the parent primary image item identifier.

Memberof

BaseItemDto

`Optional`ParentPrimaryImageTag

ParentPrimaryImageTag?: null | string

Gets or sets the parent primary image tag.

Memberof

BaseItemDto

`Optional`ParentThumbImageTag

ParentThumbImageTag?: null | string

Gets or sets the parent thumb image tag.

Memberof

BaseItemDto

`Optional`ParentThumbItemId

ParentThumbItemId?: null | string

Gets or sets the parent thumb item id.

Memberof

BaseItemDto

`Optional`PartCount

PartCount?: null | number

Gets or sets the part count.

Memberof

BaseItemDto

`Optional`Path

Path?: null | string

Gets or sets the path.

Memberof

BaseItemDto

`Optional`People

People?: null | BaseItemPerson[]

Gets or sets the people.

Memberof

BaseItemDto

`Optional`PlayAccess

PlayAccess?: PlayAccess

Memberof

BaseItemDto

`Optional`PlaylistItemId

PlaylistItemId?: null | string

Gets or sets the playlist item identifier.

Memberof

BaseItemDto

`Optional`PreferredMetadataCountryCode

PreferredMetadataCountryCode?: null | string

Memberof

BaseItemDto

`Optional`PreferredMetadataLanguage

PreferredMetadataLanguage?: null | string

Memberof

BaseItemDto

`Optional`PremiereDate

PremiereDate?: null | string

Gets or sets the premiere date.

Memberof

BaseItemDto

`Optional`PrimaryImageAspectRatio

PrimaryImageAspectRatio?: null | number

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

Memberof

BaseItemDto

`Optional`ProductionLocations

ProductionLocations?: null | string[]

Memberof

BaseItemDto

`Optional`ProductionYear

ProductionYear?: null | number

Gets or sets the production year.

Memberof

BaseItemDto

`Optional`ProgramCount

ProgramCount?: null | number

Memberof

BaseItemDto

`Optional`ProgramId

ProgramId?: null | string

Gets or sets the program identifier.

Memberof

BaseItemDto

`Optional`ProviderIds

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

Gets or sets the provider ids.

Memberof

BaseItemDto

`Optional`RecursiveItemCount

RecursiveItemCount?: null | number

Gets or sets the recursive item count.

Memberof

BaseItemDto

`Optional`RemoteTrailers

RemoteTrailers?: null | MediaUrl[]

Gets or sets the trailer urls.

Memberof

BaseItemDto

`Optional`RunTimeTicks

RunTimeTicks?: null | number

Gets or sets the run time ticks.

Memberof

BaseItemDto

`Optional`ScreenshotImageTags

ScreenshotImageTags?: null | string[]

Gets or sets the screenshot image tags.

Memberof

BaseItemDto

`Optional`SeasonId

SeasonId?: null | string

Gets or sets the season identifier.

Memberof

BaseItemDto

`Optional`SeasonName

SeasonName?: null | string

Gets or sets the name of the season.

Memberof

BaseItemDto

`Optional`SeriesCount

SeriesCount?: null | number

Gets or sets the series count.

Memberof

BaseItemDto

`Optional`SeriesId

SeriesId?: null | string

Gets or sets the series id.

Memberof

BaseItemDto

`Optional`SeriesName

SeriesName?: null | string

Gets or sets the name of the series.

Memberof

BaseItemDto

`Optional`SeriesPrimaryImageTag

SeriesPrimaryImageTag?: null | string

Gets or sets the series primary image tag.

Memberof

BaseItemDto

`Optional`SeriesStudio

SeriesStudio?: null | string

Gets or sets the series studio.

Memberof

BaseItemDto

`Optional`SeriesThumbImageTag

SeriesThumbImageTag?: null | string

Gets or sets the series thumb image tag.

Memberof

BaseItemDto

`Optional`SeriesTimerId

SeriesTimerId?: null | string

Gets or sets the series timer identifier.

Memberof

BaseItemDto

`Optional`ServerId

ServerId?: null | string

Gets or sets the server identifier.

Memberof

BaseItemDto

`Optional`ShutterSpeed

ShutterSpeed?: null | number

Memberof

BaseItemDto

`Optional`Software

Software?: null | string

Memberof

BaseItemDto

`Optional`SongCount

SongCount?: null | number

Gets or sets the song count.

Memberof

BaseItemDto

`Optional`SortName

SortName?: null | string

Gets or sets the name of the sort.

Memberof

BaseItemDto

`Optional`SourceType

SourceType?: null | string

Gets or sets the type of the source.

Memberof

BaseItemDto

`Optional`SpecialFeatureCount

SpecialFeatureCount?: null | number

Gets or sets the special feature count.

Memberof

BaseItemDto

`Optional`StartDate

StartDate?: null | string

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

Memberof

BaseItemDto

`Optional`Status

Status?: null | string

Gets or sets the status.

Memberof

BaseItemDto

`Optional`Studios

Studios?: null | NameGuidPair[]

Gets or sets the studios.

Memberof

BaseItemDto

`Optional`Taglines

Taglines?: null | string[]

Gets or sets the taglines.

Memberof

BaseItemDto

`Optional`Tags

Tags?: null | string[]

Gets or sets the tags.

Memberof

BaseItemDto

`Optional`TimerId

TimerId?: null | string

Gets or sets the timer identifier.

Memberof

BaseItemDto

`Optional`TrailerCount

TrailerCount?: null | number

Gets or sets the trailer count.

Memberof

BaseItemDto

`Optional`Trickplay

Trickplay?: null | {
    [key: string]: {
        [key: string]: TrickplayInfo;
    };
}

Gets or sets the trickplay manifest.

Memberof

BaseItemDto

`Optional`Type

Type?: BaseItemKind

Memberof

BaseItemDto

`Optional`UserData

UserData?: UserItemDataDto

Memberof

BaseItemDto

`Optional`Video3DFormat

Video3DFormat?: Video3DFormat

Memberof

BaseItemDto

`Optional`VideoType

VideoType?: VideoType

Memberof

BaseItemDto

`Optional`Width

Width?: null | number

Memberof

BaseItemDto

Interface BaseItemDto

Export

Index

Properties

Properties

OptionalAirDays

Memberof

OptionalAirsAfterSeasonNumber

Memberof

OptionalAirsBeforeEpisodeNumber

Memberof

OptionalAirsBeforeSeasonNumber

Memberof

OptionalAirTime

Memberof

OptionalAlbum

Memberof

OptionalAlbumArtist

Memberof

OptionalAlbumArtists

Memberof

OptionalAlbumCount

Memberof

OptionalAlbumId

Memberof

OptionalAlbumPrimaryImageTag

Memberof

OptionalAltitude

Memberof

OptionalAperture

Memberof

OptionalArtistCount

Memberof

OptionalArtistItems

Memberof

OptionalArtists

Memberof

OptionalAspectRatio

Memberof

OptionalAudio

Memberof

OptionalBackdropImageTags

Memberof

OptionalCameraMake

Memberof

OptionalCameraModel

Memberof

OptionalCanDelete

Memberof

OptionalCanDownload

Memberof

OptionalChannelId

Memberof

OptionalChannelName

Memberof

OptionalChannelNumber

Memberof

OptionalChannelPrimaryImageTag

Memberof

OptionalChannelType

Memberof

OptionalChapters

Memberof

OptionalChildCount

Memberof

OptionalCollectionType

Memberof

OptionalCommunityRating

Memberof

OptionalCompletionPercentage

Memberof

OptionalContainer

Memberof

OptionalCriticRating

Memberof

OptionalCumulativeRunTimeTicks

Memberof

OptionalCurrentProgram

Memberof

OptionalCustomRating

`Optional`AirDays

`Optional`AirsAfterSeasonNumber

`Optional`AirsBeforeEpisodeNumber

`Optional`AirsBeforeSeasonNumber

`Optional`AirTime

`Optional`Album

`Optional`AlbumArtist

`Optional`AlbumArtists

`Optional`AlbumCount

`Optional`AlbumId

`Optional`AlbumPrimaryImageTag

`Optional`Altitude

`Optional`Aperture

`Optional`ArtistCount

`Optional`ArtistItems

`Optional`Artists

`Optional`AspectRatio

`Optional`Audio

`Optional`BackdropImageTags

`Optional`CameraMake

`Optional`CameraModel

`Optional`CanDelete

`Optional`CanDownload

`Optional`ChannelId

`Optional`ChannelName

`Optional`ChannelNumber

`Optional`ChannelPrimaryImageTag

`Optional`ChannelType

`Optional`Chapters

`Optional`ChildCount

`Optional`CollectionType

`Optional`CommunityRating

`Optional`CompletionPercentage

`Optional`Container

`Optional`CriticRating

`Optional`CumulativeRunTimeTicks

`Optional`CurrentProgram

`Optional`CustomRating

`Optional`DateCreated

`Optional`DateLastMediaAdded

`Optional`DisplayOrder

`Optional`DisplayPreferencesId

`Optional`EnableMediaSourceDisplay

`Optional`EndDate

`Optional`EpisodeCount

`Optional`EpisodeTitle

`Optional`Etag

`Optional`ExposureTime

`Optional`ExternalUrls

`Optional`ExtraType

`Optional`FocalLength

`Optional`ForcedSortName

`Optional`GenreItems

`Optional`Genres

`Optional`HasLyrics

`Optional`HasSubtitles

`Optional`Height

`Optional`Id

`Optional`ImageBlurHashes

`Optional`ImageOrientation

`Optional`ImageTags

`Optional`IndexNumber

`Optional`IndexNumberEnd

`Optional`IsFolder

`Optional`IsHD

`Optional`IsKids

`Optional`IsLive

`Optional`IsMovie

`Optional`IsNews

`Optional`IsoSpeedRating

`Optional`IsoType

`Optional`IsPlaceHolder

`Optional`IsPremiere