Class BasicAtem

Hierarchy

EventEmitter<AtemEvents>
- BasicAtem

Implements

IBasicAtem

Index

Constructors

constructor

new BasicAtem(options?): BasicAtem
Parameters
- Optional options: AtemOptions
Returns BasicAtem
Overrides EventEmitter<AtemEvents>.constructor
- Defined in src/atem.ts:297

Properties

`Static` prefixed

prefixed: string | boolean

Accessors

apiVersion

get apiVersion(): undefined | ProtocolVersion
Get the apiVersion of the connected ATEM, if known

Returns undefined | ProtocolVersion
- Defined in src/atem.ts:322

`Protected` dataTransferManager

get dataTransferManager(): DataTransferManager
The data transfer manager, for uploading/downloading media. Exposed to subclasses (eg Atem) which build higher level helpers on top of it.

Returns DataTransferManager
- Defined in src/atem.ts:307

state

get state(): undefined | Readonly<AtemState>
Returns undefined | Readonly<AtemState>
Implementation of IBasicAtem.state
- Defined in src/atem.ts:315

status

get status(): AtemConnectionStatus
Returns AtemConnectionStatus
Implementation of IBasicAtem.status
- Defined in src/atem.ts:311

videoMode

get videoMode(): undefined | Readonly<VideoModeInfo>
Get the current videomode of the ATEM, if known

Returns undefined | Readonly<VideoModeInfo>
Implementation of IBasicAtem.videoMode
- Defined in src/atem.ts:329

Methods

addListener

addListener<T>(event, fn, context?): BasicAtem
Type Parameters
- T extends keyof AtemEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]
      
      Returns void
- Optional context: any
Returns BasicAtem
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

connect

connect(address, port?): Promise<void>
Parameters
- address: string
- Optional port: number
Returns Promise<void>
Implementation of IBasicAtem.connect
- Defined in src/atem.ts:333

createCommandBatch

createCommandBatch(): AtemCommandBatch
Create a new command batch, to queue up multiple commands and send them together in a single batch.

Returns AtemCommandBatch
- Defined in src/atem.ts:360

destroy

destroy(): Promise<void>
Returns Promise<void>
Implementation of IBasicAtem.destroy
- Defined in src/atem.ts:341

disconnect

disconnect(): Promise<void>
Returns Promise<void>
Implementation of IBasicAtem.disconnect
- Defined in src/atem.ts:337

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof AtemEvents
Parameters
- event: T
- Rest ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof AtemEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof AtemEvents)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof AtemEvents
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof AtemEvents
Parameters
- event: T
Returns ((...args) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T>(event, fn?, context?, once?): BasicAtem
Type Parameters
- T extends keyof AtemEvents
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns BasicAtem
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): BasicAtem
Add a listener for a given event.
Type Parameters
- T extends keyof AtemEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]
      
      Returns void
- Optional context: any
Returns BasicAtem
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T>(event, fn, context?): BasicAtem
Add a one-time listener for a given event.
Type Parameters
- T extends keyof AtemEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]
      
      Returns void
- Optional context: any
Returns BasicAtem
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?): BasicAtem
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof AtemEvents
Returns BasicAtem
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): BasicAtem
Remove the listeners of a given event.
Type Parameters
- T extends keyof AtemEvents
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns BasicAtem
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

sendCommand

sendCommand(command): Promise<void>
Parameters
- command: ISerializableCommand
Returns Promise<void>
Implementation of IBasicAtem.sendCommand
- Defined in src/atem.ts:353

sendCommands

sendCommands(commands): Promise<void>
Parameters
- commands: ISerializableCommand[]
Returns Promise<void>
Implementation of IBasicAtem.sendCommands
- Defined in src/atem.ts:345

sendUnprioritizedCommands

sendUnprioritizedCommands(commands): Promise<void>
Parameters
- commands: ISerializableCommand[]
Returns Promise<void>
- Defined in src/atem.ts:349

Class BasicAtem

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: AtemOptions

Returns BasicAtem

Properties

Static prefixed

Accessors

apiVersion

Returns undefined | ProtocolVersion

Protected dataTransferManager

Returns DataTransferManager

state

Returns undefined | Readonly<AtemState>

status

Returns AtemConnectionStatus

videoMode

Returns undefined | Readonly<VideoModeInfo>

Methods

addListener

Type Parameters

T extends keyof AtemEvents

Parameters

event: T

fn: ((...args) => void)

Parameters

Rest ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]

Returns void

Optional context: any

Returns BasicAtem

connect

Parameters

address: string

Optional port: number

Returns Promise<void>

createCommandBatch

Returns AtemCommandBatch

destroy

Returns Promise<void>

disconnect

Returns Promise<void>

emit

Type Parameters

T extends keyof AtemEvents

Parameters

event: T

Rest ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]

Returns boolean

eventNames

Returns (keyof AtemEvents)[]

listenerCount

Parameters

event: keyof AtemEvents

Returns number

listeners

Type Parameters

T extends keyof AtemEvents

Parameters

event: T

Returns ((...args) => void)[]

off

Type Parameters

T extends keyof AtemEvents

Parameters

event: T

Optional fn: ((...args) => void)

Parameters

Rest ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]

Returns void

Optional context: any

Optional once: boolean

Returns BasicAtem

`Optional` options: AtemOptions

`Static` prefixed

`Protected` dataTransferManager

`Rest` ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]

`Optional` context: any

`Optional` port: number

`Rest` ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]

`Optional` fn: ((...args) => void)

`Rest` ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]

`Optional` context: any

`Optional` once: boolean

`Rest` ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]

`Optional` context: any

`Rest` ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]

`Optional` context: any

`Optional` event: keyof AtemEvents

`Optional` fn: ((...args) => void)

`Rest` ...args: ArgumentMap<AtemEvents>[Extract<T, keyof AtemEvents>]

`Optional` context: any

`Optional` once: boolean