Variable TlvLaunchContentRequestConst

Type declaration

• autoPlay: FieldType<boolean>

  This field shall indicate whether to automatically start playing content, where:

  • TRUE means best match should start playing automatically.

  • FALSE means matches should be displayed on screen for user selection.

  See

  MatterSpecification.v13.Cluster § 6.7.7.1.2

• data: OptionalFieldType<string>

  This field, if present, shall indicate app-specific data.

  See

  MatterSpecification.v13.Cluster § 6.7.7.1.3

• playbackPreferences: OptionalFieldType<TypeFromFields<{
      audioTracks: OptionalFieldType<null | TypeFromFields<{
          audioOutputIndex: OptionalFieldType<(...)>;
          characteristics: OptionalFieldType<(...)>;
          languageCode: FieldType<(...)>;
      }>[]>;
      playbackPosition: OptionalFieldType<null | number | bigint>;
      textTrack: OptionalFieldType<null | TypeFromFields<{
          audioOutputIndex: OptionalFieldType<(...) | (...)>;
          characteristics: OptionalFieldType<(...) | (...)>;
          languageCode: FieldType<string>;
      }>>;
  }>>

  This field, if present, shall indicate the user’s preferred Text/AudioTracks and playbackPosition for the media, sent from the client to the server. If the server does not find an available track for the title being played exactly matching a Track requested here, in the list of available tracks, it may default to picking another track that closely matches the requested track. Alternately, it may go with user preferences set on the server side (it will use this option if these PlaybackPreferences are not specified). In the case of text tracks, that may mean that the subtitle text is not displayed at all. In the cases where the preferred Text/AudioTracks are not available, the server shall return the TextTrackNotAvailable and/or AudioTrackNotAvailable Status(es) in the LauncherResponse.

  See

  MatterSpecification.v13.Cluster § 6.7.7.1.4

• search: FieldType<TypeFromFields<{
      parameterList: FieldType<TypeFromFields<{
          externalIdList: OptionalFieldType<(...)[]>;
          type: FieldType<ContentLauncher.ParameterEnum>;
          value: FieldType<string>;
      }>[]>;
  }>>

  This field shall indicate the content to launch.

  See

  MatterSpecification.v13.Cluster § 6.7.7.1.1

• useCurrentContext: OptionalFieldType<boolean>

  This field, if present, shall indicate whether to consider the context of current ongoing activity on the receiver to fulfill the request. For example if the request only includes data in ContentSearch that specifies an Episode number, and UseCurrentContent is set to TRUE, if there is a TV series on going, the request refers to the specific episode of the ongoing season of the TV series. TRUE means current activity context may be considered FALSE means current activity context shall NOT be considered

  See

  MatterSpecification.v13.Cluster § 6.7.7.1.5