Variable TextTracksComponentConst

Type declaration

• Readonlyattributes: {
      activeTextTrack: Attribute<null | TypeFromFields<{
          id: FieldType<string>;
          trackAttributes: FieldType<TypeFromFields<{
              characteristics: OptionalFieldType<(...) | (...)>;
              displayName: OptionalFieldType<(...) | (...)>;
              languageCode: FieldType<string>;
          }>>;
      }>, any>;
      availableTextTracks: Attribute<null | TypeFromFields<{
          id: FieldType<string>;
          trackAttributes: FieldType<TypeFromFields<{
              characteristics: OptionalFieldType<(...)>;
              displayName: OptionalFieldType<(...)>;
              languageCode: FieldType<(...)>;
          }>>;
      }>[], any>;
  }

  • ReadonlyactiveTextTrack: Attribute<null | TypeFromFields<{
        id: FieldType<string>;
        trackAttributes: FieldType<TypeFromFields<{
            characteristics: OptionalFieldType<(...) | (...)>;
            displayName: OptionalFieldType<(...) | (...)>;
            languageCode: FieldType<string>;
        }>>;
    }>, any>

    ActiveTrack refers to the Text track currently set and being used for the streaming media. This can be nil. A value of null shall indicate that no Text Track corresponding to the current media is currently being displayed.

    See

    MatterSpecification.v13.Cluster § 6.10.6.10

  • ReadonlyavailableTextTracks: Attribute<null | TypeFromFields<{
        id: FieldType<string>;
        trackAttributes: FieldType<TypeFromFields<{
            characteristics: OptionalFieldType<(...)>;
            displayName: OptionalFieldType<(...)>;
            languageCode: FieldType<(...)>;
        }>>;
    }>[], any>

    AvailableTextTracks refers to the list of Text tracks available for the current title being played. This can be an empty list. A value of null shall indicate that no Text Tracks corresponding to the current media are selectable by the client.

    See

    MatterSpecification.v13.Cluster § 6.10.6.11

• Readonlycommands: {
      activateTextTrack: Command<TypeFromFields<{
          trackId: FieldType<string>;
      }>, void, any>;
      deactivateTextTrack: Command<void, void, any>;
  }

  • ReadonlyactivateTextTrack: Command<TypeFromFields<{
        trackId: FieldType<string>;
    }>, void, any>

    Upon receipt, the server shall set the active Text Track to the one identified by the TrackID in the Track catalog for the streaming media. If the TrackID does not exist in the Track catalog, OR does not correspond to the streaming media OR no media is being streamed at the time of receipt of this command, the server shall return an error status of INVALID_ARGUMENT.

    See

    MatterSpecification.v13.Cluster § 6.10.7.14

  • ReadonlydeactivateTextTrack: Command<void, void, any>

    If a Text Track is active (i.e. being displayed), upon receipt of this command, the server shall stop displaying it.

    See

    MatterSpecification.v13.Cluster § 6.10.7.15