v1

latestOpenAPI 3.0.12026-07-134082641.7 MB

LiveTv

Gets a live tv program.

get/LiveTv/Programs/{programId}

Path parameters

programIdstring required

Program id.

Query parameters

userIdstring uuid nullable

Optional. Attach user data.

Response

Program returned.

Namestring nullable

Gets or sets the name.

OriginalTitlestring nullable

ServerIdstring nullable

Gets or sets the server identifier.

Idstring uuid

Gets or sets the id.

Etagstring nullable

Gets or sets the etag.

SourceTypestring nullable

Gets or sets the type of the source.

PlaylistItemIdstring nullable

Gets or sets the playlist item identifier.

DateCreatedstring date-time nullable

Gets or sets the date created.

DateLastMediaAddedstring date-time nullable

ExtraTypestring nullable

AirsBeforeSeasonNumberinteger nullable

AirsAfterSeasonNumberinteger nullable

AirsBeforeEpisodeNumberinteger nullable

CanDeleteboolean nullable

CanDownloadboolean nullable

HasSubtitlesboolean nullable

PreferredMetadataLanguagestring nullable

PreferredMetadataCountryCodestring nullable

SupportsSyncboolean nullable

Gets or sets a value indicating whether [supports synchronize].

Containerstring nullable

SortNamestring nullable

Gets or sets the name of the sort.

ForcedSortNamestring nullable

Video3DFormat'HalfSideBySide' | 'FullSideBySide' | 'FullTopAndBottom' | 'HalfTopAndBottom' | 'MVC'

PremiereDatestring date-time nullable

Gets or sets the premiere date.

CriticRatingnumber float nullable

Gets or sets the critic rating.

ProductionLocationsstring[] nullable

Pathstring nullable

Gets or sets the path.

EnableMediaSourceDisplayboolean nullable

OfficialRatingstring nullable

Gets or sets the official rating.

CustomRatingstring nullable

Gets or sets the custom rating.

ChannelIdstring uuid nullable

Gets or sets the channel identifier.

ChannelNamestring nullable

Overviewstring nullable

Gets or sets the overview.

Taglinesstring[] nullable

Gets or sets the taglines.

Genresstring[] nullable

Gets or sets the genres.

CommunityRatingnumber float nullable

Gets or sets the community rating.

CumulativeRunTimeTicksinteger nullable

Gets or sets the cumulative run time ticks.

RunTimeTicksinteger nullable

Gets or sets the run time ticks.

PlayAccess'Full' | 'None'

AspectRatiostring nullable

Gets or sets the aspect ratio.

ProductionYearinteger nullable

Gets or sets the production year.

IsPlaceHolderboolean nullable

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

Numberstring nullable

Gets or sets the number.

ChannelNumberstring nullable

IndexNumberinteger nullable

Gets or sets the index number.

IndexNumberEndinteger nullable

Gets or sets the index number end.

ParentIndexNumberinteger nullable

Gets or sets the parent index number.

ProviderIdsobject nullable

Gets or sets the provider ids.

IsHDboolean nullable

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

IsFolderboolean nullable

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

ParentIdstring uuid nullable

Gets or sets the parent id.

Typestring nullable

Gets or sets the type.

ParentLogoItemIdstring nullable

If the item does not have a logo, this will hold the Id of the Parent that has one.

ParentBackdropItemIdstring nullable

If the item does not have any backdrops, this will hold the Id of the Parent that has one.

ParentBackdropImageTagsstring[] nullable

Gets or sets the parent backdrop image tags.

LocalTrailerCountinteger nullable

Gets or sets the local trailer count.

RecursiveItemCountinteger nullable

Gets or sets the recursive item count.

ChildCountinteger nullable

Gets or sets the child count.

SeriesNamestring nullable

Gets or sets the name of the series.

SeriesIdstring uuid nullable

Gets or sets the series id.

SeasonIdstring uuid nullable

Gets or sets the season identifier.

SpecialFeatureCountinteger nullable

Gets or sets the special feature count.

DisplayPreferencesIdstring nullable

Gets or sets the display preferences id.

Statusstring nullable

Gets or sets the status.

AirTimestring nullable

Gets or sets the air time.

AirDaysDayOfWeek[] nullable

Gets or sets the air days.

Tagsstring[] nullable

Gets or sets the tags.

PrimaryImageAspectRationumber double nullable

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

Artistsstring[] nullable

Gets or sets the artists.

Albumstring nullable

Gets or sets the album.

CollectionTypestring nullable

Gets or sets the type of the collection.

DisplayOrderstring nullable

Gets or sets the display order.

AlbumIdstring uuid nullable

Gets or sets the album id.

AlbumPrimaryImageTagstring nullable

Gets or sets the album image tag.

SeriesPrimaryImageTagstring nullable

Gets or sets the series primary image tag.

AlbumArtiststring nullable

Gets or sets the album artist.

SeasonNamestring nullable

Gets or sets the name of the season.

VideoType'VideoFile' | 'Iso' | 'Dvd' | 'BluRay'

Enum VideoType.

PartCountinteger nullable

Gets or sets the part count.

MediaSourceCountinteger nullable

ImageTagsobject nullable

Gets or sets the image tags.

BackdropImageTagsstring[] nullable

Gets or sets the backdrop image tags.

ScreenshotImageTagsstring[] nullable

Gets or sets the screenshot image tags.

ParentLogoImageTagstring nullable

Gets or sets the parent logo image tag.

ParentArtItemIdstring nullable

If the item does not have a art, this will hold the Id of the Parent that has one.

ParentArtImageTagstring nullable

Gets or sets the parent art image tag.

SeriesThumbImageTagstring nullable

Gets or sets the series thumb image tag.

SeriesStudiostring nullable

Gets or sets the series studio.

ParentThumbItemIdstring nullable

Gets or sets the parent thumb item id.

ParentThumbImageTagstring nullable

Gets or sets the parent thumb image tag.

ParentPrimaryImageItemIdstring nullable

Gets or sets the parent primary image item identifier.

ParentPrimaryImageTagstring nullable

Gets or sets the parent primary image tag.

LocationType'FileSystem' | 'Remote' | 'Virtual' | 'Offline'

Enum LocationType.

IsoType'Dvd' | 'BluRay'

Enum IsoType.

MediaTypestring nullable

Gets or sets the type of the media.

EndDatestring date-time nullable

Gets or sets the end date.

LockedFieldsMetadataField[] nullable

Gets or sets the locked fields.

TrailerCountinteger nullable

Gets or sets the trailer count.

MovieCountinteger nullable

Gets or sets the movie count.

SeriesCountinteger nullable

Gets or sets the series count.

ProgramCountinteger nullable

EpisodeCountinteger nullable

Gets or sets the episode count.

SongCountinteger nullable

Gets or sets the song count.

AlbumCountinteger nullable

Gets or sets the album count.

ArtistCountinteger nullable

MusicVideoCountinteger nullable

Gets or sets the music video count.

LockDataboolean nullable

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

Widthinteger nullable

Heightinteger nullable

CameraMakestring nullable

CameraModelstring nullable

Softwarestring nullable

ExposureTimenumber double nullable

FocalLengthnumber double nullable

Aperturenumber double nullable

ShutterSpeednumber double nullable

Latitudenumber double nullable

Longitudenumber double nullable

Altitudenumber double nullable

IsoSpeedRatinginteger nullable

SeriesTimerIdstring nullable

Gets or sets the series timer identifier.

ProgramIdstring nullable

Gets or sets the program identifier.

ChannelPrimaryImageTagstring nullable

Gets or sets the channel primary image tag.

StartDatestring date-time nullable

The start date of the recording, in UTC.

CompletionPercentagenumber double nullable

Gets or sets the completion percentage.

IsRepeatboolean nullable

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

EpisodeTitlestring nullable

Gets or sets the episode title.

ChannelType'TV' | 'Radio'

Enum ChannelType.

IsMovieboolean nullable

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

IsSportsboolean nullable

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

IsSeriesboolean nullable

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

IsLiveboolean nullable

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

IsNewsboolean nullable

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

IsKidsboolean nullable

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

IsPremiereboolean nullable

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

TimerIdstring nullable

Gets or sets the timer identifier.