Interface MediaPlaybackBehavior

interface MediaPlaybackBehavior {
    [reference]: Datasource<StateType>;
    agent: Agent;
    cluster: never;
    context: ActionContext;
    endpoint: Endpoint<Empty>;
    env: Environment;
    events: EventEmitter & Omit<ClusterEvents<Of<{
        attributes: {};
        commands: {};
        events: {};
        id: 0;
        name: "Unknown";
        revision: 0;
    }>, typeof ClusterBehavior>, never> & {
        currentState$Changing: ClusterEvents.AttributeObservable<Attribute<MediaPlayback.PlaybackState, any>>;
    } & {} & {
        currentState$Changed: ClusterEvents.AttributeObservable<Attribute<MediaPlayback.PlaybackState, any>>;
    } & {} & {} & {
        stateChanged?: ClusterEvents.EventObservable<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>>;
    };
    features: TypeFromBitSchema<{}> & TypeFromBitSchema<{
        advancedSeek: BitFlag;
        audioAdvance: BitFlag;
        audioTracks: BitFlag;
        textTracks: BitFlag;
        variableSpeed: BitFlag;
    }>;
    session: SecureSession;
    state: Omit<ClusterState.Type<Of<{
        attributes: {};
        commands: {};
        events: {};
        id: 0;
        name: "Unknown";
        revision: 0;
    }>, typeof ClusterBehavior>, never> & {
        currentState: MediaPlayback.PlaybackState;
    } & {} & {} & {};
    [asyncDispose](): MaybePromise;
    asAdmin(fn: (() => void)): void;
    assertAttributeEnabled<This, K>(this: This, attributeName: K): void;
    callback<A, R>(reactor: Reactor<A, R>, options?: Reactor.Options): ((...args: A) => undefined | R);
    initialize(_options?: {}): MaybePromise;
    next(): MaybePromise<MediaPlayback.PlaybackResponse>;
    pause(): MaybePromise<MediaPlayback.PlaybackResponse>;
    play(): MaybePromise<MediaPlayback.PlaybackResponse>;
    previous(): MaybePromise<MediaPlayback.PlaybackResponse>;
    reactTo<O>(observable: O, reactor: Reactor<Parameters<O["emit"]>, ReturnType<O["emit"]>>, options?: Reactor.Options): void;
    requireAttributeEnabled<This, K>(this: This, attributeName: K): Exclude<This["state"][K], undefined>;
    skipBackward(request: MediaPlayback.SkipBackwardRequest): MaybePromise<MediaPlayback.PlaybackResponse>;
    skipForward(request: MediaPlayback.SkipForwardRequest): MaybePromise<MediaPlayback.PlaybackResponse>;
    startOver(): MaybePromise<MediaPlayback.PlaybackResponse>;
    stop(): MaybePromise<MediaPlayback.PlaybackResponse>;
    toString(): string;
    State: any;
}

Hierarchy (view full)

Properties

[reference] agent cluster context endpoint env events features session state

Methods

[asyncDispose] asAdmin assertAttributeEnabled callback initialize next pause play previous reactTo requireAttributeEnabled skipBackward skipForward startOver stop toString

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

cluster

cluster: never

The implemented cluster.

context

context: ActionContext

endpoint

endpoint: Endpoint<Empty>

env

env: Environment

Readonlyevents

events: EventEmitter & Omit<ClusterEvents<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior>, never> & {
    currentState$Changing: ClusterEvents.AttributeObservable<Attribute<MediaPlayback.PlaybackState, any>>;
} & {} & {
    currentState$Changed: ClusterEvents.AttributeObservable<Attribute<MediaPlayback.PlaybackState, any>>;
} & {} & {} & {
    stateChanged?: ClusterEvents.EventObservable<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>>;
}

Access the behavior's events.

Type declaration

features

features: TypeFromBitSchema<{}> & TypeFromBitSchema<{
    advancedSeek: BitFlag;
    audioAdvance: BitFlag;
    audioTracks: BitFlag;
    textTracks: BitFlag;
    variableSpeed: BitFlag;
}>

Supported features as a flag object.

session

session: SecureSession

Readonlystate

state: Omit<ClusterState.Type<Of<{
    attributes: {};
    commands: {};
    events: {};
    id: 0;
    name: "Unknown";
    revision: 0;
}>, typeof ClusterBehavior>, never> & {
    currentState: MediaPlayback.PlaybackState;
} & {} & {} & {}

Access the behavior's state.

Type declaration

  • ReadonlycurrentState: MediaPlayback.PlaybackState

    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

Methods

[asyncDispose]

asAdmin

assertAttributeEnabled

Protectedcallback

  • callback<A, R>(reactor, options?): ((...args: A) => undefined | R)

  • Create a generic callback function that has the same properties as a Reactor.

    Like a reactor, the callback's "this" will be bound to an active Behavior instance. Because of this: The reactor MUST be a real JS function - arrow functions will not work!

    Type Parameters

    • A extends any[]
    • R

    Parameters

    Returns ((...args: A) => undefined | R)

      • (...args): undefined | R

      • Parameters

        • Rest...args: A

        Returns undefined | R

initialize

  • initialize(_options?): MaybePromise

  • Behaviors are ephemeral and should not perform initialization in their constructor. They can override this method instead.

    This method may be synchronous or asyncronous. If asynchronous, the behavior will not be available for external use until initialization completes.

    Parameters

    • Optional_options: {}

      Returns MaybePromise

    next

    pause

    play

    previous

    ProtectedreactTo

    • reactTo<O>(observable, reactor, options?): void

    • Install a Reactor.

      Important: The reactor MUST be a real JS function - arrow functions will not work!

      Type Parameters

      Parameters

      Returns void

    requireAttributeEnabled

    skipBackward

    skipForward

    startOver

    stop

    toString

    Settings

    Member Visibility

    On This Page

    Properties
    Methods