Global

Type Definitions

ComoNodeClassDescription

Description:

  • Shared state class description representing a ComoNode

Source:
Properties:
Name Type Description
id String

Topological id (can be fixed between different restarts):

  • For browser clients: generated from soundworks node id, or user defined through query parameter, i.e. http://host.local?id=my-client-id
  • For node clients: hostname
  • For server: 'server' constant
nodeId Number

Underlying soundworks id, unstable across restarts
role String

Role of the node in the application
runtime 'browser' | 'node'

Javascript runtime in which the node is running

PlayerClassDescription

Source:
Properties:
Name Type Description
id String

Id of the player (generated or user-defined)
nodeId String

Id of the node on which the player has been created
sourceId String

Id of the source associated with the player
sessionId String

If the session with which the player is associated. null is associated to no session.
sessionLoading Boolean

True if the session is currently loading, false otherwise
scriptName String

Name of the script associated to this player.
scriptLoaded Boolean

Event that triggers whe the script is ready.
mute Boolean

Mute the audio of this player.
volume Number

Volume of the audio of this player, in dB.

SourceClassDescription

Source:
Properties:
Name Type Description
id String

Id of the source, user-defined
type String

Type of the source (e.g. comote, riot, etc.)
nodeId Number

Id of the node where the source is created
infos Object