Interface MotionComposerFlowCommandUpload

Represents a command within a Motion Composer flow. Commands are executed sequentially within a single flow.

Hierarchy

Properties

config: {
    index: number;
    subindex: number;
}

Device-specific configuration. Interfaces extending this one will define the appropriate config type for the command.

Type declaration

  • index: number
  • subindex: number
deviceRef: DeviceRef

Optional reference to a device. Most commands refer to a device, except for cases like delay.

Device-specific result. Not all commands return a result, but commands like upload provide a parameter value as the result.

Current status of the command during Motion Composer execution. If undefined, the command is in an idle state. This property should be excluded when serializing or storing the command in a file.

statusMessage?: string

A textual description of the status. Typically used for the error message when the command has a failed status.

type: "upload"

Specifies the type of command, corresponding to a function in the client library.

Generated using TypeDoc