Global

Methods

clientRequest(client, name, params, cb) → {promise}

Source:

index.js, line 296

Generic RRCS request

Parameters:

Name	Type	Description
`client`	object	xml-rpc client connection
`name`	string	xml-rpc request name
`params`	array	array of parameters for this request ['TransKey', ...]
`cb`	function	callback

Returns:

resolve: {val}, reject: {err}

Type: promise

RRCS_Server(local, remote, cb)

Source:

index.js, line 16

RRCS_Server Events

Parameters:

Name	Type	Description
`local`	obj	{ip: str, port: int}
`remote`	obj	{ip: str, port: int}
`cb`	obj	object of callback functions

Type Definitions

getGPInputStateCb(TransKey, state)

Source:

index.js, line 616

Parameters:

Name	Type	Description
`TransKey`	string	Transaction Key
`state`	bool	Input Gain

getGPOutputStateCb(TransKey, state)

Source:

index.js, line 639

Parameters:

Name	Type	Description
`TransKey`	string	Transaction Key
`state`	bool	Input Gain

getInputGainCb(TransKey, gain)

Source:

index.js, line 570

Parameters:

Name	Type	Description
`TransKey`	string	Transaction Key
`gain`	int	Input Gain

getObjectsCb(TransKey, ports, conferences, groups, ifbs, logic, gpio, users, audiopatches, clientCards)

Source:

index.js, line 394

Parameters:

Name	Type	Description
`TransKey`	string	Transaction Key
`ports`	array	{LongName, ObjectID}
`conferences`	array	{LongName, ObjectID}
`groups`	array	{LongName, ObjectID}
`ifbs`	array	{LongName, ObjectID}
`logic`	object	{srcs: [{LongName, ObjectID}], dests: [{LongName, ObjectID}]}
`gpio`	object	{inputs: [{LongName, ObjectID}], outputs: [{LongName, ObjectID}]}
`users`	array	{LongName, ObjectID}
`audiopatches`	array	{LongName, ObjectID}
`clientCards`	array	{ObjectID}

getOutputGainCb(TransKey, gain)

Source:

index.js, line 593

Parameters:

Name	Type	Description
`TransKey`	string	Transaction Key
`gain`	int	Input Gain

getStateCb(TransKey, state)

Source:

index.js, line 348

Parameters:

Name	Type	Description
`TransKey`	string	Transaction Key
`state`	string	['working', 'standby']

getVersionCb(TransKey, version)

Source:

index.js, line 326

Parameters:

Name	Type	Description
`TransKey`	string	Transaction Key
`version`	string	RRCS Version Number

getXpStatusCb(TransKey, xpActive)

Source:

index.js, line 519

Parameters:

Name	Type	Description
`TransKey`	string	Transaction Key
`xpActive`	boolean	State of XP

getXpVolumeCb(TransKey, singleVolume, confVolume)

Source:

index.js, line 544

Parameters:

Name	Type	Description
`TransKey`	string	Transaction Key
`singleVolume`	int	Volume for a point to point XP
`confVolume`	int	Volume for a conference XP

isConnectedToArtistCb(TransKey, isConnected)

Source:

index.js, line 370

Parameters:

Name	Type	Description
`TransKey`	string	Transaction Key
`isConnected`	boolean	RRCS is currently connected to Artist

standardCallback

Source:

index.js, line 269

standardCallback

Events

ClientFailed

Source:

index.js, line 181

clientFailed notification

Returns:

params: [TransKey: str, Net: int, Node: int, slot: Int]

Type: array

ClientFailedCleared

Source:

index.js, line 192

clientFailedCleared notification

Returns:

params: [TransKey: str, Net: int, Node: int, slot: Int]

Type: array

ConfigurationChange

Source:

index.js, line 106

configuratoinChange notification

ConnectArtistFailed

Source:

index.js, line 236

connectArtistFailed notification

Returns:

params: [TransKey: str, GatewayState: str]

Type: array

ConnectArtistRestored

Source:

index.js, line 225

connectArtistRestored notification

Returns:

params: [TransKey: str, GatewayState: str]

Type: array

CrosspointChange

Source:

index.js, line 51

crosspointChange notification

Returns:

params: [TransKey: str, XP_count: int, XPs: {"XP#x": [src.net, src.node, src.port, dest.net, dest.node, dest.port, active]}]

Type: array

DownstreamFailed

Source:

index.js, line 137

downstreamFailed notification

Returns:

params: [TransKey: str, Net: int, Node: int]

Type: array

DownstreamFailedCleared

Source:

index.js, line 148

downstreamFailedCleared notification

Returns:

params: [TransKey: str, Net: int, Node: int]

Type: array

GatewayShutdown

Source:

index.js, line 247

gatewayShutdown notification

GetAlive

Source:

index.js, line 42

getAlive Ping request from RRCS

gpInputChange

Source:

index.js, line 84

gpInputChange notification

Returns:

params: [TransKey: str, net: int, node: int, port: int, slot: int, gpio: int, state: bool]

Type: array

LogicSourceChange

Source:

index.js, line 95

logicSourceChange notification

Returns:

params: [TransKey: str, Object ID: int, state: bool]

Type: array

NodeControllerFailed

Source:

index.js, line 159

nodeControllerFailed notification

Returns:

params: [TransKey: str, Net: int, Node: int]

Type: array

NodeControllerReboot

Source:

index.js, line 170

nodeControllerReboot notification

Returns:

params: [TransKey: str, Net: int, Node: int]

Type: array

PortActive

Source:

index.js, line 214

portActive notification

Returns:

params: [TransKey: str, Net: int, Node: int, port: Int]

Type: array

PortInactive

Source:

index.js, line 203

portInactive notification

Returns:

params: [TransKey: str, Net: int, Node: int, port: Int]

Type: array

SendString

Source:

index.js, line 62

sendString notification

Returns:

params: [TransKey: str, string: str]

Type: array

SendStringOff

Source:

index.js, line 73

sendString notification

Returns:

params: [TransKey: str, string: str]

Type: array

UpstreamFailed

Source:

index.js, line 115

upstreamFailed notification

Returns:

params: [TransKey: str, Net: int, Node: int]

Type: array

UpstreamFailedCleared

Source:

index.js, line 126

upstreamFailedCleared notification

Returns:

params: [TransKey: str, Net: int, Node: int]

Type: array