Interface StateChangedEvent

Body of the MediaPlayback stateChanged event

See

MatterSpecification.v13.Cluster § 6.10.8.1

interface StateChangedEvent {
    audioAdvanceUnmuted?: boolean;
    currentState: MediaPlayback.PlaybackState;
    data?: Uint8Array;
    duration?: number | bigint;
    playbackSpeed?: number;
    sampledPosition?: TypeFromFields<{
        position: FieldType<null | number | bigint>;
        updatedAt: FieldType<number | bigint>;
    }>;
    seekRangeEnd?: number | bigint;
    seekRangeStart?: number | bigint;
    startTime?: number | bigint;
}

Hierarchy (view full)

Properties

audioAdvanceUnmuted? currentState data? duration? playbackSpeed? sampledPosition? seekRangeEnd? seekRangeStart? startTime?

Properties

OptionalaudioAdvanceUnmuted

audioAdvanceUnmuted?: boolean

This field shall indicate whether audio is unmuted by the player due to a FF or REW command. This field is only meaningful when the PlaybackSpeed is present and not equal to 0 (paused) or 1 (normal playback). Typically the value will be false (muted), however, some players will play audio during certain fast forward and rewind speeds, and in these cases, the value will be true (not muted).

A value of true does not guarantee that audio can be heard by the user since the speaker may be muted, turned down to a low level and/or unplugged.

See

MatterSpecification.v13.Cluster § 6.10.8.1.9

currentState

currentState: MediaPlayback.PlaybackState

This field shall indicate the updated playback state as defined by the CurrentState attribute, and has the same constraint as that attribute.

See

MatterSpecification.v13.Cluster § 6.10.8.1.1

Optionaldata

data?: Uint8Array

This field shall indicate Optional app-specific data.

See

MatterSpecification.v13.Cluster § 6.10.8.1.8

Optionalduration

duration?: number | bigint

This field shall indicate the updated duration as defined by the Duration attribute, and has the same constraint as that attribute.

See

MatterSpecification.v13.Cluster § 6.10.8.1.3

OptionalplaybackSpeed

playbackSpeed?: number

This field shall indicate the updated speed at which the current media is being played as defined by the PlaybackSpeed attribute, and has the same constraint as that attribute.

See

MatterSpecification.v13.Cluster § 6.10.8.1.5

OptionalsampledPosition

sampledPosition?: TypeFromFields<{
    position: FieldType<null | number | bigint>;
    updatedAt: FieldType<number | bigint>;
}>

This field shall indicate the updated position of playback as defined by the SampledPosition attribute, and has the same constraint as that attribute.

Type declaration

  • position: FieldType<null | number | bigint>

    This field shall indicate the associated discrete position within the media stream, in milliseconds from the beginning of the stream, being associated with the time indicated by the UpdatedAt field. The Position shall not be greater than the duration of the media if duration is specified. The Position shall not be greater than the time difference between current time and start time of the media when start time is specified.

    A value of null shall indicate that playback position is not applicable for the current state of the media playback (For example : Live media with no known duration and where seek is not supported).

    See

    MatterSpecification.v13.Cluster § 6.10.5.4.2

  • updatedAt: FieldType<number | bigint>

    This field shall indicate the time when the position was last updated.

    See

    MatterSpecification.v13.Cluster § 6.10.5.4.1

See

MatterSpecification.v13.Cluster § 6.10.8.1.4

OptionalseekRangeEnd

seekRangeEnd?: number | bigint

This field shall indicate the updated start of the seek range end as defined by the SeekRangeEnd attribute, and has the same constraint as that attribute.

See

MatterSpecification.v13.Cluster § 6.10.8.1.7

OptionalseekRangeStart

seekRangeStart?: number | bigint

This field shall indicate the updated start of the seek range start as defined by the SeekRangeStart attribute, and has the same constraint as that attribute.

See

MatterSpecification.v13.Cluster § 6.10.8.1.6

OptionalstartTime

startTime?: number | bigint

This field shall indicate the updated start time as defined by the StartTime attribute, and has the same constraint as that attribute.

See

MatterSpecification.v13.Cluster § 6.10.8.1.2

Settings

Member Visibility

On This Page

Properties