Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

ClippingRoomCreatedEvent

• webVis API Reference
• ClippingRoomCreatedEvent

Class ClippingRoomCreatedEvent

CLIPPING_ROOM_CREATED

Hierarchy (View Summary)

• WebVisEvent
  • ClippingRoomCreatedEvent

Index

Constructors

constructor

Properties

clipRoomID id properties transactionCode? transactionID? type?

Accessors

disabled invisible name size transformation

Constructors

constructor

• new ClippingRoomCreatedEvent(
      clipRoomID: number,
      properties: ClipRoomProperties,
  ): 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

The unique ID of the event.

Inherited from WebVisEvent.id

properties

properties: ClipRoomProperties

An object with the clip room properties.

OptionaltransactionCode

transactionCode?: string

The transaction code associated with the event.

Inherited from WebVisEvent.transactionCode

OptionaltransactionID

transactionID?: number

The transaction ID associated with the event.

Inherited from WebVisEvent.transactionID

Optionaltype

type?: EventType

The type of the event.

Inherited from WebVisEvent.type

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<ArrayBufferLike> | [number, number, number]

• Returns Float32Array<ArrayBufferLike> | [number, number, number]

  Deprecated

  size is deprecated, please use properties.size instead.

transformation

• get transformation(): | Float32Array<ArrayBufferLike>
  | [
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
      number,
  ]

• Returns
      | Float32Array<ArrayBufferLike>
      | [
          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.