Interface BasicVideoPlayerDevice

This defines conformance to the Basic Video Player device type.

A Video Player (either Basic or Casting) represents a device that is able to play media to a physical output or to a display screen which is part of the device.

A Basic Video Player has playback controls (play, pause, etc.) and keypad remote controls (up, down, number input), but is not able to launch content and is not a content app platform (the Casting Video Player device type is used for these functions).

For example, a Basic Video Player can be a traditional TV device a physical media playback device such as a DVD Player, or a device that provides input to another device like a TV or computer monitor.

Please see Video Player Architecture for additional Basic Video Player requirements relating to Video Player device endpoint composition, commissioning, feature representation in clusters, and UI context.

See

MatterSpecification.v13.Device § 10.2

interface BasicVideoPlayerDevice {
    behaviors: {
        onOff: typeof OnOffServer;
    } & {
        mediaPlayback: typeof MediaPlaybackServer;
    } & {
        keypadInput: typeof KeypadInputServer;
    };
    defaults: StateOf<{
        onOff: typeof OnOffServer;
    } & {
        mediaPlayback: typeof MediaPlaybackServer;
    } & {
        keypadInput: typeof KeypadInputServer;
    }>;
    deviceClass: DeviceClassification;
    deviceRevision: number;
    deviceType: DeviceTypeId;
    name: "BasicVideoPlayer";
    requirements: typeof BasicVideoPlayerRequirements;
    set(defaults: InputStateOf<{
        onOff: typeof OnOffServer;
    } & {
        mediaPlayback: typeof MediaPlaybackServer;
    } & {
        keypadInput: typeof KeypadInputServer;
    }>): With<For<{
        behaviors: {
            onOff: typeof OnOffServer;
        } & {
            mediaPlayback: typeof MediaPlaybackServer;
        } & {
            keypadInput: typeof KeypadInputServer;
        };
        deviceRevision: 2;
        deviceType: 40;
        name: "BasicVideoPlayer";
        requirements: typeof BasicVideoPlayerRequirements;
    }>, {
        onOff: typeof OnOffServer;
    } & {
        mediaPlayback: typeof MediaPlaybackServer;
    } & {
        keypadInput: typeof KeypadInputServer;
    }>;
    with<const BL>(...behaviors: BL): With<For<{
        behaviors: {
            onOff: typeof OnOffServer;
        } & {
            mediaPlayback: typeof MediaPlaybackServer;
        } & {
            keypadInput: typeof KeypadInputServer;
        };
        deviceRevision: 2;
        deviceType: 40;
        name: "BasicVideoPlayer";
        requirements: typeof BasicVideoPlayerRequirements;
    }>, With<{
        onOff: typeof OnOffServer;
    } & {
        mediaPlayback: typeof MediaPlaybackServer;
    } & {
        keypadInput: typeof KeypadInputServer;
    }, BL>>;
}

Hierarchy (view full)

Identity<typeof BasicVideoPlayerDeviceDefinition>
- BasicVideoPlayerDevice

Index

Properties

behaviors defaults deviceClass deviceRevision deviceType name requirements

Methods

set with

Properties

behaviors

behaviors: {
    onOff: typeof OnOffServer;
} & {
    mediaPlayback: typeof MediaPlaybackServer;
} & {
    keypadInput: typeof KeypadInputServer;
}

defaults

defaults: StateOf<{
    onOff: typeof OnOffServer;
} & {
    mediaPlayback: typeof MediaPlaybackServer;
} & {
    keypadInput: typeof KeypadInputServer;
}>

Access default state values.

deviceClass

deviceClass: DeviceClassification

deviceRevision

deviceRevision: number

deviceType

deviceType: DeviceTypeId

name

requirements

requirements: typeof BasicVideoPlayerRequirements

Methods

set

set(defaults): With<For<{
    behaviors: {
        onOff: typeof OnOffServer;
    } & {
        mediaPlayback: typeof MediaPlaybackServer;
    } & {
        keypadInput: typeof KeypadInputServer;
    };
    deviceRevision: 2;
    deviceType: 40;
    name: "BasicVideoPlayer";
    requirements: typeof BasicVideoPlayerRequirements;
}>, {
    onOff: typeof OnOffServer;
} & {
    mediaPlayback: typeof MediaPlaybackServer;
} & {
    keypadInput: typeof KeypadInputServer;
}>
Define an endpoint like this one with different defaults. Only updates values present in the input object.
Parameters
- defaults: InputStateOf<{
      onOff: typeof OnOffServer;
  } & {
      mediaPlayback: typeof MediaPlaybackServer;
  } & {
      keypadInput: typeof KeypadInputServer;
  }>
Returns With<For<{
    behaviors: {
        onOff: typeof OnOffServer;
    } & {
        mediaPlayback: typeof MediaPlaybackServer;
    } & {
        keypadInput: typeof KeypadInputServer;
    };
    deviceRevision: 2;
    deviceType: 40;
    name: "BasicVideoPlayer";
    requirements: typeof BasicVideoPlayerRequirements;
}>, {
    onOff: typeof OnOffServer;
} & {
    mediaPlayback: typeof MediaPlaybackServer;
} & {
    keypadInput: typeof KeypadInputServer;
}>
Inherited from Identity.set
- Defined in packages/node/src/endpoint/type/MutableEndpoint.ts:94

with

with<const BL>(...behaviors): With<For<{
    behaviors: {
        onOff: typeof OnOffServer;
    } & {
        mediaPlayback: typeof MediaPlaybackServer;
    } & {
        keypadInput: typeof KeypadInputServer;
    };
    deviceRevision: 2;
    deviceType: 40;
    name: "BasicVideoPlayer";
    requirements: typeof BasicVideoPlayerRequirements;
}>, With<{
    onOff: typeof OnOffServer;
} & {
    mediaPlayback: typeof MediaPlaybackServer;
} & {
    keypadInput: typeof KeypadInputServer;
}, BL>>
Define an endpoint like this one with additional and/or replacement server behaviors.
Type Parameters
- const BL extends List
Parameters
- Rest...behaviors: BL
Returns With<For<{
    behaviors: {
        onOff: typeof OnOffServer;
    } & {
        mediaPlayback: typeof MediaPlaybackServer;
    } & {
        keypadInput: typeof KeypadInputServer;
    };
    deviceRevision: 2;
    deviceType: 40;
    name: "BasicVideoPlayer";
    requirements: typeof BasicVideoPlayerRequirements;
}>, With<{
    onOff: typeof OnOffServer;
} & {
    mediaPlayback: typeof MediaPlaybackServer;
} & {
    keypadInput: typeof KeypadInputServer;
}, BL>>
Inherited from Identity.with
- Defined in packages/node/src/endpoint/type/MutableEndpoint.ts:99

Interface BasicVideoPlayerDevice

See

Hierarchy (view full)

Index

Properties

Methods

Properties

behaviors

defaults

deviceClass

deviceRevision

deviceType

name

requirements

Methods

set

Parameters

with

Type Parameters

Parameters

Settings

On This Page