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

Inherited from WebVisEvent.id

properties

properties: ClipRoomProperties

An object with the clip room properties.

OptionaltransactionCode

transactionCode?: string

Inherited from WebVisEvent.transactionCode

OptionaltransactionID

transactionID?: number

Inherited from WebVisEvent.transactionID

Optionaltype

type?: EventType

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.

---

Did you find this page useful? Please give it a rating:

★ ★ ★ ★ ★

Thank you for rating this page!

Any issues or feedback?

What kind of problem would you like to report?

• This page needs code samples
• Code samples do not work
• Information is missing
  Please tell us more about what's wrong:
• Information is incorrect
  Please tell us more about what's wrong:
• Information is unclear or confusing
  Please tell us more about what's wrong:
• The page is rendered incorrectly (styling/CSS)
• Give Feedback

Please tell us more about what's wrong: Name E-Mail Problem (required)