Variable AudioTracksComponentConst

Type declaration

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

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

    ActiveTrack refers to the Audio track currently set and being used for the streaming media. A value of null shall indicate that no Audio Track corresponding to the current media is currently being played.

    See

    MatterSpecification.v13.Cluster § 6.10.6.8

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

    AvailableAudioTracks refers to the list of Audio tracks available for the current title being played. A value of null shall indicate that no Audio Tracks corresponding to the current media are selectable by the client.

    See

    MatterSpecification.v13.Cluster § 6.10.6.9

• Readonlycommands: {
      activateAudioTrack: Command<TypeFromFields<{
          audioOutputIndex: OptionalFieldType<null | number>;
          trackId: FieldType<string>;
      }>, void, any>;
  }

  • ReadonlyactivateAudioTrack: Command<TypeFromFields<{
        audioOutputIndex: OptionalFieldType<null | number>;
        trackId: FieldType<string>;
    }>, void, any>

    Upon receipt, the server shall set the active Audio 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 will return an error status of INVALID_ARGUMENT.

    See

    MatterSpecification.v13.Cluster § 6.10.7.13