Class MediaPlayerStatusCommand

Base command type for a full writable command, which uses flags to indicate the changed properties

Hierarchy

WritableCommand<MediaPlayer>
- MediaPlayerStatusCommand

Index

Constructors

Properties

_properties flag mediaPlayerId MaskFlags minimumVersion? rawName

Accessors

Methods

_updateProps serialize updateProps

Constructors

constructor

new MediaPlayerStatusCommand(mediaPlayerId): MediaPlayerStatusCommand
Parameters
- mediaPlayerId: number
Returns MediaPlayerStatusCommand
Overrides WritableCommand.constructor
- Defined in src/commands/Media/MediaPlayerStatusCommand.ts:16

Properties

`Protected` _properties

_properties: Partial<MediaPlayer>

flag

flag: number

`Readonly` mediaPlayerId

mediaPlayerId: number

`Static` MaskFlags

MaskFlags: {
    atBeginning: number;
    clipFrame: number;
    loop: number;
    playing: number;
} = ...

Type declaration

atBeginning: number
clipFrame: number
loop: number
playing: number

`Static` `Optional` `Readonly` minimumVersion

minimumVersion?: ProtocolVersion

`Static` `Readonly` rawName

rawName: "SCPS" = 'SCPS'

Accessors

properties

get properties(): Readonly<T>
Returns Readonly<T>
Inherited from WritableCommand.properties
- Defined in src/commands/CommandBase.ts:35

Methods

`Protected` _updateProps

_updateProps(newProps): boolean
Parameters
- newProps: {
  [key: string]: any;
  }
  - [key: string]: any
Returns boolean
Inherited from WritableCommand._updateProps
- Defined in src/commands/CommandBase.ts:63

serialize

serialize(): Buffer
Returns Buffer
Overrides WritableCommand.serialize
- Defined in src/commands/Media/MediaPlayerStatusCommand.ts:22

updateProps

updateProps(newProps): boolean
Update the values of some properties with this command
Parameters
- newProps: Partial<MediaPlayer>
Returns boolean
Inherited from WritableCommand.updateProps
- Defined in src/commands/CommandBase.ts:59

Generated using TypeDoc