ClippingRoomCreatedEvent#

Class ClippingRoomCreatedEvent

CLIPPING_ROOM_CREATED

Hierarchy

WebVisEvent
- ClippingRoomCreatedEvent

Index

Constructors

Properties

clipRoomID id properties transactionCode? transactionID? type?

Accessors

disabled invisible name size transformation

Constructors

constructor

new ClippingRoomCreatedEvent(clipRoomID, properties): ClippingRoomCreatedEvent
The ClippingRoomCreatedEvent occurs if a clip room was created.
Parameters
- clipRoomID: number
  
  The ID of the clip room.
- properties: ClipRoomProperties
  
  An object with the clip room properties.
Returns ClippingRoomCreatedEvent

Overrides WebVisEvent.constructor

Properties

clipRoomID

clipRoomID: number

The ID of the clip room.

id

id: number

properties

properties: ClipRoomProperties

An object with the clip room properties.

`Optional` transactionCode

transactionCode?: string

`Optional` transactionID

transactionID?: number

`Optional` type

type?: EventType

Accessors

disabled

get disabled(): boolean
Returns boolean

Deprecated
disabled is deprecated, please use properties.enabled instead.

invisible

get invisible(): boolean
Returns boolean

Deprecated
invisible is deprecated, please use properties.invisible instead.

name

get name(): string
Returns string

Deprecated
name is deprecated, please use properties.name instead.

size

get size(): Float32Array | [number, number, number]
Returns Float32Array | [number, number, number]

Deprecated
size is deprecated, please use properties.size instead.

transformation

get transformation(): Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]
Returns Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]

Deprecated
transformation is deprecated, please use properties.transformation instead.