ChannelTrait.ProgramStruct
class ChannelTrait.ProgramStruct : ClusterStruct
A program within an electronic program guide (EPG).
Summary
Nested types |
|---|
|
Descriptor enum for this struct's fields. |
Public constructors |
|---|
ProgramStruct(Creates the ProgramStruct class. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
Returns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
OptionalValue<List<String>> |
The audio language for the specific program. |
OptionalValue<List<ChannelTrait.ProgramCastStruct>> |
A list of the cast or the crew on the program. |
OptionalValue<List<ChannelTrait.ProgramCategoryStruct>> |
The category of a particular program. |
ChannelTrait.ChannelInfoStruct |
The channel associated to the program. |
OptionalValue<String> |
The brief description for the specific program. |
OptionalValue<String> |
The DVB-I URL associated to the program. |
UInt |
The end time of a program, as a UTC time. |
OptionalValue<List<ChannelTrait.ProgramCastStruct>> |
|
String |
A unique identifier for a program within an electronic program guide list. |
OptionalValue<String> |
Additional information on the parental guidance. |
OptionalValue<String> |
A URL of a poster that clients can use to render an image for the program on the detail view. |
OptionalValue<List<String>> |
Indicating the level of parental guidance recommended for a particular program. |
OptionalValue<ChannelTrait.RecordingFlagBitmap> |
The recording status of the program. |
OptionalValue<String> |
The date on which the program was released. |
OptionalValue<ChannelTrait.SeriesInfoStruct?> |
The information of a series such as season and episode number. |
UInt |
The start time of a program, as a UTC time. |
OptionalValue<String> |
The subtitle for the specific program. |
OptionalValue<String> |
A URL of a thumbnail that clients can use to render an image for the program. |
String |
The title or name for the specific program. |
Public constructors
ProgramStruct
ProgramStruct(
identifier: String = "",
channel: ChannelTrait.ChannelInfoStruct = ChannelInfoStruct(),
startTime: UInt,
endTime: UInt,
title: String = "",
subtitle: OptionalValue<String> = OptionalValue.absent(),
description: OptionalValue<String> = OptionalValue.absent(),
audioLanguages: OptionalValue<List<String>> = OptionalValue.absent(),
ratings: OptionalValue<List<String>> = OptionalValue.absent(),
thumbnailUrl: OptionalValue<String> = OptionalValue.absent(),
posterArtUrl: OptionalValue<String> = OptionalValue.absent(),
dvbiUrl: OptionalValue<String> = OptionalValue.absent(),
releaseDate: OptionalValue<String> = OptionalValue.absent(),
parentalGuidanceText: OptionalValue<String> = OptionalValue.absent(),
recordingFlag: OptionalValue<ChannelTrait.RecordingFlagBitmap> = OptionalValue.absent(),
seriesInfo: OptionalValue<ChannelTrait.SeriesInfoStruct?> = OptionalValue.absent(),
categoryList: OptionalValue<List<ChannelTrait.ProgramCategoryStruct>> = OptionalValue.absent(),
castList: OptionalValue<List<ChannelTrait.ProgramCastStruct>> = OptionalValue.absent(),
externalIdList: OptionalValue<List<ChannelTrait.ProgramCastStruct>> = OptionalValue.absent()
)
Creates the ProgramStruct class.
Public functions
getDescriptor
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
audioLanguages
val audioLanguages: OptionalValue<List<String>>
The audio language for the specific program.
castList
val castList: OptionalValue<List<ChannelTrait.ProgramCastStruct>>
A list of the cast or the crew on the program.
categoryList
val categoryList: OptionalValue<List<ChannelTrait.ProgramCategoryStruct>>
The category of a particular program.
identifier
val identifier: String
A unique identifier for a program within an electronic program guide list.
parentalGuidanceText
val parentalGuidanceText: OptionalValue<String>
Additional information on the parental guidance.
posterArtUrl
val posterArtUrl: OptionalValue<String>
A URL of a poster that clients can use to render an image for the program on the detail view.
ratings
val ratings: OptionalValue<List<String>>
Indicating the level of parental guidance recommended for a particular program.
recordingFlag
val recordingFlag: OptionalValue<ChannelTrait.RecordingFlagBitmap>
The recording status of the program.
seriesInfo
val seriesInfo: OptionalValue<ChannelTrait.SeriesInfoStruct?>
The information of a series such as season and episode number.
thumbnailUrl
val thumbnailUrl: OptionalValue<String>
A URL of a thumbnail that clients can use to render an image for the program.