Interface CopySceneRequest

Input to the ScenesManagement copyScene command

See

MatterSpecification.v13.Cluster § 1.4.9.15

interface CopySceneRequest {
    groupIdentifierFrom: GroupId;
    groupIdentifierTo: GroupId;
    mode: TypeFromPartialBitSchema<{
        copyAllScenes: BitFlag;
    }>;
    sceneIdentifierFrom: number;
    sceneIdentifierTo: number;
}

Hierarchy (view full)

Properties

groupIdentifierFrom groupIdentifierTo mode sceneIdentifierFrom sceneIdentifierTo

Properties

groupIdentifierFrom

groupIdentifierFrom: GroupId

This field shall indicate the identifier of the group from which the scene is to be copied. Together with the SceneIdentifierFrom field, this field uniquely identifies the scene to copy from the Scene Table.

See

MatterSpecification.v13.Cluster § 1.4.9.15.2

groupIdentifierTo

groupIdentifierTo: GroupId

This field shall indicate the identifier of the group to which the scene is to be copied. Together with the SceneIdentifierTo field, this field uniquely identifies the scene to copy to the Scene Table.

See

MatterSpecification.v13.Cluster § 1.4.9.15.4

mode

mode: TypeFromPartialBitSchema<{
    copyAllScenes: BitFlag;
}>

This field shall contain the information of how the scene copy is to proceed.

The CopyAllScenes bit of the Mode indicates whether all scenes are to be copied. If this value is set to 1, all scenes are to be copied and the SceneIdentifierFrom and SceneIdentifierTo fields shall be ignored. Otherwise this bit is set to 0.

Type declaration

  • copyAllScenes: BitFlag

    Copy all scenes in the scene table

See

MatterSpecification.v13.Cluster § 1.4.9.15.1

sceneIdentifierFrom

sceneIdentifierFrom: number

This field shall indicate the identifier of the scene from which the scene is to be copied. Together with the GroupIdentifierFrom field, this field uniquely identifies the scene to copy from the Scene Table.

See

MatterSpecification.v13.Cluster § 1.4.9.15.3

sceneIdentifierTo

sceneIdentifierTo: number

This field shall indicate the identifier of the scene to which the scene is to be copied. Together with the GroupIdentifierTo field, this field uniquely identifies the scene to copy to the Scene Table.

See

MatterSpecification.v13.Cluster § 1.4.9.15.5

Settings

Member Visibility

On This Page

Properties