Global

Members

flags :Number

Flags
Type:
  • Number
Properties:
Name Type Default Description
sync Number 1
connect Number 2
repeat Number 4
unknown Number 8
ack Number 16
Source:

videoInterfaceNames :String

Video-interface names
Type:
  • String
Properties:
Name Type Default Description
0 String internal
1 String sdi
2 String hdmi
4 String component
Source:

videoInterfaceNumbers :Number

Video-interface numbers
Type:
  • Number
Properties:
Name Type Default Description
internal Number 0
sdi Number 2
hdmi Number 4
component Number 8
Source:

Methods

getSourceInfo(id) → {Object}

Returns more information about the type (input, auxiliary, mediaPlayer, ...) and index of an ATEM source given its source ID.
For example if one would lookup (SourceID) 4020, this will return {type: ['keyMask'], index: 1} meaning: this is the second key mask. The index is a number starting at 0
Parameters:
Name Type Description
id SourceID The source identification number
Source:
Returns:
Type
Object

pad(number, size) → {string}

Converts a Number into a String
Parameters:
Name Type Description
number Number The number to convert
size Number The length of the new string
Source:
Returns:
A fixed length string representation of the number
Type
string

parseString(buffer) → {string}

Converts a Buffer into a String. Only the first non-zero bytes of the string will be converted
Parameters:
Name Type Description
buffer Buffer a buffer containing a string
Source:
Returns:
the first non-zero bytes
Type
string

setAux(aux, source)

Change the auxiliary output
Parameters:
Name Type Description
aux SourceID
source SourceID
Source:

Type Definitions

SourceConfiguration

Type:
  • Object
Properties:
Name Type Description
name String The display name of the source. This name is shown for each source on the multiview
abbreviation String An abbreviation of the display name. this abbreviation is displayed on the ATEM switcher panels.
videoInterface VideoInterface The video interface used for this source
Source:

SourceID

The ID of a an ATEM source. If you need to know more info of a specified source use getSourceInfo
Type:
  • Number
Source:

SourceState

Type:
  • Object
Properties:
Name Type Description
program boolean Indicates whether the source is in program or not
preview boolean Indicates whether the source is in preview or not
Source:

VideoInterface

A string describing the video interface. Possible values are internal, sdi, hdmi, component
Type:
  • string
Source: