Variable CompleteInstanceConst

Type declaration

• Readonlyattributes: {
      acceptedCommandList: Attribute<CommandId[], never>;
      activeAudioTrack: Attribute<null | TypeFromFields<{
          id: FieldType<string>;
          trackAttributes: FieldType<TypeFromFields<{
              characteristics: ...;
              displayName: ...;
              languageCode: ...;
          }>>;
      }>, any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              audioTracks: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
      activeTextTrack: Attribute<null | TypeFromFields<{
          id: FieldType<string>;
          trackAttributes: FieldType<TypeFromFields<{
              characteristics: ...;
              displayName: ...;
              languageCode: ...;
          }>>;
      }>, any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              textTracks: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
      attributeList: Attribute<AttributeId[], never>;
      availableAudioTracks: Attribute<null | TypeFromFields<{
          id: FieldType<string>;
          trackAttributes: FieldType<TypeFromFields<(...)>>;
      }>[], any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              audioTracks: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
      availableTextTracks: Attribute<null | TypeFromFields<{
          id: FieldType<string>;
          trackAttributes: FieldType<TypeFromFields<(...)>>;
      }>[], any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              textTracks: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
      clusterRevision: Attribute<number, never>;
      currentState: Attribute<MediaPlayback.PlaybackState, any>;
      duration: Attribute<null | number | bigint, any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              advancedSeek: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
      featureMap: Attribute<TypeFromPartialBitSchema<{
          advancedSeek: BitFlag;
          audioAdvance: BitFlag;
          audioTracks: BitFlag;
          textTracks: BitFlag;
          variableSpeed: BitFlag;
      }>, never>;
      generatedCommandList: Attribute<CommandId[], never>;
      playbackSpeed: Attribute<number, any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              advancedSeek: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
      sampledPosition: Attribute<null | TypeFromFields<{
          position: FieldType<null | number | bigint>;
          updatedAt: FieldType<number | bigint>;
      }>, any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              advancedSeek: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
      seekRangeEnd: Attribute<null | number | bigint, any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              advancedSeek: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
      seekRangeStart: Attribute<null | number | bigint, any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              advancedSeek: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
      startTime: Attribute<null | number | bigint, any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              advancedSeek: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
  }

  • ReadonlyacceptedCommandList: Attribute<CommandId[], never>

    List of client generated commands which are supported by this cluster server instance.

  • ReadonlyactiveAudioTrack: Attribute<null | TypeFromFields<{
        id: FieldType<string>;
        trackAttributes: FieldType<TypeFromFields<{
            characteristics: ...;
            displayName: ...;
            languageCode: ...;
        }>>;
    }>, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            audioTracks: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

  • ReadonlyactiveTextTrack: Attribute<null | TypeFromFields<{
        id: FieldType<string>;
        trackAttributes: FieldType<TypeFromFields<{
            characteristics: ...;
            displayName: ...;
            languageCode: ...;
        }>>;
    }>, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            textTracks: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

  • ReadonlyattributeList: Attribute<AttributeId[], never>

    List of the attribute IDs of the attributes supported by the cluster instance.

  • ReadonlyavailableAudioTracks: Attribute<null | TypeFromFields<{
        id: FieldType<string>;
        trackAttributes: FieldType<TypeFromFields<(...)>>;
    }>[], any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            audioTracks: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

  • ReadonlyavailableTextTracks: Attribute<null | TypeFromFields<{
        id: FieldType<string>;
        trackAttributes: FieldType<TypeFromFields<(...)>>;
    }>[], any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            textTracks: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

  • ReadonlyclusterRevision: Attribute<number, never>

    Indicates the revision of the server cluster specification supported by the cluster instance.

  • ReadonlycurrentState: Attribute<MediaPlayback.PlaybackState, any>

    Indicates the current playback state of media.

    During fast-forward, rewind, and other seek operations; this attribute shall be set to PLAYING.

    See

    MatterSpecification.v13.Cluster § 6.10.6.1

  • Readonlyduration: Attribute<null | number | bigint, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            advancedSeek: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

  • ReadonlyfeatureMap: Attribute<TypeFromPartialBitSchema<{
        advancedSeek: BitFlag;
        audioAdvance: BitFlag;
        audioTracks: BitFlag;
        textTracks: BitFlag;
        variableSpeed: BitFlag;
    }>, never>

    Indicates whether the server supports zero or more optional cluster features.

  • ReadonlygeneratedCommandList: Attribute<CommandId[], never>

    List of server generated commands (server to client commands).

  • ReadonlyplaybackSpeed: Attribute<number, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            advancedSeek: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

  • ReadonlysampledPosition: Attribute<null | TypeFromFields<{
        position: FieldType<null | number | bigint>;
        updatedAt: FieldType<number | bigint>;
    }>, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            advancedSeek: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

  • ReadonlyseekRangeEnd: Attribute<null | number | bigint, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            advancedSeek: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

  • ReadonlyseekRangeStart: Attribute<null | number | bigint, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            advancedSeek: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

  • ReadonlystartTime: Attribute<null | number | bigint, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            advancedSeek: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

• Readonlycommands: {
      activateAudioTrack: Command<TypeFromFields<{
          audioOutputIndex: OptionalFieldType<null | number>;
          trackId: FieldType<string>;
      }>, void, any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              audioTracks: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
      activateTextTrack: Command<TypeFromFields<{
          trackId: FieldType<string>;
      }>, void, any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              textTracks: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
      deactivateTextTrack: Command<void, void, any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              textTracks: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
      fastForward: Command<TypeFromFields<{
          audioAdvanceUnmuted: OptionalFieldType<boolean>;
      }>, TypeFromFields<{
          data: OptionalFieldType<string>;
          status: FieldType<MediaPlayback.Status>;
      }>, any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              variableSpeed: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
      next: OptionalCommand<void, TypeFromFields<{
          data: OptionalFieldType<string>;
          status: FieldType<MediaPlayback.Status>;
      }>, any>;
      pause: Command<void, TypeFromFields<{
          data: OptionalFieldType<string>;
          status: FieldType<MediaPlayback.Status>;
      }>, any>;
      play: Command<void, TypeFromFields<{
          data: OptionalFieldType<string>;
          status: FieldType<MediaPlayback.Status>;
      }>, any>;
      previous: OptionalCommand<void, TypeFromFields<{
          data: OptionalFieldType<string>;
          status: FieldType<MediaPlayback.Status>;
      }>, any>;
      rewind: Command<TypeFromFields<{
          audioAdvanceUnmuted: OptionalFieldType<boolean>;
      }>, TypeFromFields<{
          data: OptionalFieldType<string>;
          status: FieldType<MediaPlayback.Status>;
      }>, any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              variableSpeed: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
      seek: Command<TypeFromFields<{
          position: FieldType<number | bigint>;
      }>, TypeFromFields<{
          data: OptionalFieldType<string>;
          status: FieldType<MediaPlayback.Status>;
      }>, any> & {
          isConditional: true;
          mandatoryIf: [] | [{
              advancedSeek: boolean;
          }];
          optional: true;
          optionalIf: [] | ConditionalFeatureList<BitSchema>;
      };
      skipBackward: OptionalCommand<TypeFromFields<{
          deltaPositionMilliseconds: FieldType<number | bigint>;
      }>, TypeFromFields<{
          data: OptionalFieldType<string>;
          status: FieldType<MediaPlayback.Status>;
      }>, any>;
      skipForward: OptionalCommand<TypeFromFields<{
          deltaPositionMilliseconds: FieldType<number | bigint>;
      }>, TypeFromFields<{
          data: OptionalFieldType<string>;
          status: FieldType<MediaPlayback.Status>;
      }>, any>;
      startOver: OptionalCommand<void, TypeFromFields<{
          data: OptionalFieldType<string>;
          status: FieldType<MediaPlayback.Status>;
      }>, any>;
      stop: Command<void, TypeFromFields<{
          data: OptionalFieldType<string>;
          status: FieldType<MediaPlayback.Status>;
      }>, any>;
  }

  • ReadonlyactivateAudioTrack: Command<TypeFromFields<{
        audioOutputIndex: OptionalFieldType<null | number>;
        trackId: FieldType<string>;
    }>, void, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            audioTracks: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

  • ReadonlyactivateTextTrack: Command<TypeFromFields<{
        trackId: FieldType<string>;
    }>, void, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            textTracks: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

  • ReadonlydeactivateTextTrack: Command<void, void, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            textTracks: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

  • ReadonlyfastForward: Command<TypeFromFields<{
        audioAdvanceUnmuted: OptionalFieldType<boolean>;
    }>, TypeFromFields<{
        data: OptionalFieldType<string>;
        status: FieldType<MediaPlayback.Status>;
    }>, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            variableSpeed: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

  • Readonlynext: OptionalCommand<void, TypeFromFields<{
        data: OptionalFieldType<string>;
        status: FieldType<MediaPlayback.Status>;
    }>, any>

    Upon receipt, this shall cause the handler to be invoked for "Next". User experience is context- specific. This will often Go forward to the next media playback item.

    See

    MatterSpecification.v13.Cluster § 6.10.7.6

  • Readonlypause: Command<void, TypeFromFields<{
        data: OptionalFieldType<string>;
        status: FieldType<MediaPlayback.Status>;
    }>, any>

    Upon receipt, this shall pause playback of the media.

    See

    MatterSpecification.v13.Cluster § 6.10.7.2

  • Readonlyplay: Command<void, TypeFromFields<{
        data: OptionalFieldType<string>;
        status: FieldType<MediaPlayback.Status>;
    }>, any>

    Upon receipt, this shall play media. If content is currently in a FastForward or Rewind state. Play shall return media to normal playback speed.

    See

    MatterSpecification.v13.Cluster § 6.10.7.1

  • Readonlyprevious: OptionalCommand<void, TypeFromFields<{
        data: OptionalFieldType<string>;
        status: FieldType<MediaPlayback.Status>;
    }>, any>

    Upon receipt, this shall cause the handler to be invoked for "Previous". User experience is context-specific. This will often Go back to the previous media playback item.

    See

    MatterSpecification.v13.Cluster § 6.10.7.5

  • Readonlyrewind: Command<TypeFromFields<{
        audioAdvanceUnmuted: OptionalFieldType<boolean>;
    }>, TypeFromFields<{
        data: OptionalFieldType<string>;
        status: FieldType<MediaPlayback.Status>;
    }>, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            variableSpeed: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

  • Readonlyseek: Command<TypeFromFields<{
        position: FieldType<number | bigint>;
    }>, TypeFromFields<{
        data: OptionalFieldType<string>;
        status: FieldType<MediaPlayback.Status>;
    }>, any> & {
        isConditional: true;
        mandatoryIf: [] | [{
            advancedSeek: boolean;
        }];
        optional: true;
        optionalIf: [] | ConditionalFeatureList<BitSchema>;
    }

  • ReadonlyskipBackward: OptionalCommand<TypeFromFields<{
        deltaPositionMilliseconds: FieldType<number | bigint>;
    }>, TypeFromFields<{
        data: OptionalFieldType<string>;
        status: FieldType<MediaPlayback.Status>;
    }>, any>

    Upon receipt, this shall Skip backward in the media by the given number of milliseconds.

    See

    MatterSpecification.v13.Cluster § 6.10.7.10

  • ReadonlyskipForward: OptionalCommand<TypeFromFields<{
        deltaPositionMilliseconds: FieldType<number | bigint>;
    }>, TypeFromFields<{
        data: OptionalFieldType<string>;
        status: FieldType<MediaPlayback.Status>;
    }>, any>

    Upon receipt, this shall Skip forward in the media by the given number of milliseconds.

    See

    MatterSpecification.v13.Cluster § 6.10.7.9

  • ReadonlystartOver: OptionalCommand<void, TypeFromFields<{
        data: OptionalFieldType<string>;
        status: FieldType<MediaPlayback.Status>;
    }>, any>

    Upon receipt, this shall Start Over with the current media playback item.

    See

    MatterSpecification.v13.Cluster § 6.10.7.4

  • Readonlystop: Command<void, TypeFromFields<{
        data: OptionalFieldType<string>;
        status: FieldType<MediaPlayback.Status>;
    }>, any>

    Upon receipt, this shall stop playback of the media. User-visible outcome is context-specific. This may navigate the user back to the location from where the media was originally launched.

    See

    MatterSpecification.v13.Cluster § 6.10.7.3

• Readonlyevents: {
      stateChanged: OptionalEvent<TypeFromFields<{
          audioAdvanceUnmuted: OptionalFieldType<boolean>;
          currentState: FieldType<MediaPlayback.PlaybackState>;
          data: OptionalFieldType<Uint8Array>;
          duration: OptionalFieldType<number | bigint>;
          playbackSpeed: OptionalFieldType<number>;
          sampledPosition: OptionalFieldType<TypeFromFields<{
              position: FieldType<(...) | (...) | (...)>;
              updatedAt: FieldType<(...) | (...)>;
          }>>;
          seekRangeEnd: OptionalFieldType<number | bigint>;
          seekRangeStart: OptionalFieldType<number | bigint>;
          startTime: OptionalFieldType<number | bigint>;
      }>, any>;
  }

  • ReadonlystateChanged: OptionalEvent<TypeFromFields<{
        audioAdvanceUnmuted: OptionalFieldType<boolean>;
        currentState: FieldType<MediaPlayback.PlaybackState>;
        data: OptionalFieldType<Uint8Array>;
        duration: OptionalFieldType<number | bigint>;
        playbackSpeed: OptionalFieldType<number>;
        sampledPosition: OptionalFieldType<TypeFromFields<{
            position: FieldType<(...) | (...) | (...)>;
            updatedAt: FieldType<(...) | (...)>;
        }>>;
        seekRangeEnd: OptionalFieldType<number | bigint>;
        seekRangeStart: OptionalFieldType<number | bigint>;
        startTime: OptionalFieldType<number | bigint>;
    }>, any>

    If supported, this event shall be generated when there is a change in any of the supported attributes of the Media Playback cluster.

    See

    MatterSpecification.v13.Cluster § 6.10.8.1

• Readonlyfeatures: {
      advancedSeek: BitFlag;
      audioAdvance: BitFlag;
      audioTracks: BitFlag;
      textTracks: BitFlag;
      variableSpeed: BitFlag;
  }

  • ReadonlyadvancedSeek: BitFlag

    AdvancedSeek

    This feature provides access to the time offset location within current playback media and allows for jumping to a specific location using time offsets. This enables clients to implement more advanced media seeking behavior in their user interface, for instance a "seek bar".

    See

    MatterSpecification.v13.Cluster § 6.10.4.1

  • ReadonlyaudioAdvance: BitFlag

    AudioAdvance

    This feature is for a device or app that supports playing audio during fast and slow advance and rewind (e.g., while playback speed is not 1). A device that supports this feature may only support playing audio during certain speeds.

    A cluster implementing AA shall implement AS.

    See

    MatterSpecification.v13.Cluster § 6.10.4.5

  • ReadonlyaudioTracks: BitFlag

    AudioTracks

    This feature is for a device or app that supports Audio Tracks.

    See

    MatterSpecification.v13.Cluster § 6.10.4.4

  • ReadonlytextTracks: BitFlag

    TextTracks

    This feature is for a device or app that supports Text Tracks.

    See

    MatterSpecification.v13.Cluster § 6.10.4.3

  • ReadonlyvariableSpeed: BitFlag

    VariableSpeed

    This feature is for a device which supports variable speed playback on media that supports it.

    See

    MatterSpecification.v13.Cluster § 6.10.4.2

• Readonlyid: Branded<1286, "ClusterId">

• Readonlyname: "MediaPlayback"

• Readonlyrevision: 2