Class: UserPacket

UserPacket

A Packet commissiond by the user. This is used to send messages to the ATEM.

new UserPacket(commandsopt)

Create a custom UserPacket.
Parameters:
Name Type Attributes Description
commands Array.<Command> | null <optional>
 An array of commands. If null, a connect packet will be created
Source:

Extends

Members

body

Properties:
Name Type Description
commands Array.<Command> An array containing all the commands in the Packet
length Number The serialized body's length
serialize method Convert the body to a buffer
Inherited From:
Source:
Represents the first 12 bytes of the serial packet
Properties:
Name Type Description
flags Number See flags
uid Number See Device ~ uid
ls Number Local sequence number
fs Number Foreign sequence number
packetLength Number The length of the serial packet
serialize() method Converts the header into a buffer
Inherited From:
Source:

Methods

markAsRead()

Mark this packet as read. It deletes this packet from the pendingPackets list and stops retransmitting this packet.
Source:

transmit()

Transmits the packet to the atem
Source:
Fires: