Variable TlvProgramConst

Type declaration

• audioLanguages: OptionalFieldType<string[]>

  This field shall indicate the audio language for the specific program. The value is a string containing one of the standard Tags for Identifying Languages RFC 5646. This field is optional but shall be provided if known.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.8

• castList: OptionalFieldType<TypeFromFields<{
      name: FieldType<string>;
      role: FieldType<string>;
  }>[]>

  This field shall represent a list of the cast or the crew on the program. A single cast member may have more than one role. This field is optional but shall be provided if known.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.18

• categoryList: OptionalFieldType<TypeFromFields<{
      category: FieldType<string>;
      subCategory: OptionalFieldType<string>;
  }>[]>

  This field shall represent the category of a particular program. This field is optional but shall be provided if known.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.17

• channel: FieldType<TypeFromFields<{
      affiliateCallSign: OptionalFieldType<string>;
      callSign: OptionalFieldType<string>;
      identifier: OptionalFieldType<string>;
      majorNumber: FieldType<number>;
      minorNumber: FieldType<number>;
      name: OptionalFieldType<string>;
      type: OptionalFieldType<Channel.ChannelType>;
  }>>

  This field shall indicate the channel associated to the program.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.2

• description: OptionalFieldType<string>

  This field shall indicate the brief description for the specific program. For example, a description of an episode. This field is optional but shall be provided if known.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.7

• dvbiUrl: OptionalFieldType<string>

  This field shall represent the DVB-I url associated to the program.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.12

• endTime: FieldType<number>

  This field shall indicate an epoch time in seconds indicating the end time of a program, as a UTC time. This field can represent a past or future value but shall be greater than the StartTime.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.4

• externalIdList: OptionalFieldType<TypeFromFields<{
      name: FieldType<string>;
      value: FieldType<string>;
  }>[]>

  This field shall indicate the list of additional external content identifiers.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.19

• identifier: FieldType<string>

  This field shall indicate a unique identifier for a program within an electronic program guide list. The identifier shall be unique across multiple channels.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.1

• parentalGuidanceText: OptionalFieldType<string>

  This field shall represent a string providing additional information on the parental guidance. This field is optional.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.14

• posterArtUrl: OptionalFieldType<string>

  This field shall represent a url of a poster that clients can use to render an image for the program on the detail view.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.11

• ratings: OptionalFieldType<string[]>

  This field shall be used for indicating the level of parental guidance recommended for of a particular program. This can be any rating system used in the country or region where the program is

  broadcast. For example, in the United States “TV-PG” may contain material that parents can find not suitable for younger children but can be accepted in general for older children. This field is optional but shall be provided if known.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.9

• recordingFlag: OptionalFieldType<TypeFromPartialBitSchema<{
      recorded: BitFlag;
      recordSeries: BitFlag;
      scheduled: BitFlag;
  }>>

  This field shall represent the recording status of the program. This field is required if the RecordProgram feature is set.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.15

• releaseDate: OptionalFieldType<string>

  This field shall be a string, in ISO 8601 format, representing the date on which the program was released. This field is optional but when provided, the year shall be provided as part of the string.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.13

• seriesInfo: OptionalFieldType<null | TypeFromFields<{
      episode: FieldType<string>;
      season: FieldType<string>;
  }>>

  This field shall represent the information of a series such as season and episode number. This field is optional but SHOULD be provided if the program represents a series and this information is available.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.16

• startTime: FieldType<number>

  This field shall indicate an epoch time in seconds indicating the start time of a program, as a UTC time. This field can represent a past or future value.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.3

• subtitle: OptionalFieldType<string>

  This field shall indicate the subtitle for the specific program. For example, “Maybe Today" which is an episode name for “MCIS: Los Angeles”. This field is optional but shall be provided if applicable and known.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.6

• thumbnailUrl: OptionalFieldType<string>

  This field shall represent a url of a thumbnail that clients can use to render an image for the program.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.10

• title: FieldType<string>

  This field shall indicate the title or name for the specific program. For example, “MCIS: Los Angeles”.

  See

  MatterSpecification.v13.Cluster § 6.6.5.7.5