AbstractThe user chosen name for this instance.
This can be changed just before configUpdated is called
Request all feedbacks of all types to be re-executed
Request all feedbacks of the specified types to be re-executed. At least one feedback type must be provided.
The first feedback type to check
Additional feedback types to check
Request the specified feedback instances to be be re-executed
The ids of the feedback instances to check
AbstractconfigCreate a shared udp socket.
This can be necessary for modules where the device/software sends UDP messages to a hardcoded port number. In those
cases if you don't use this then it won't be possible to use multiple instances of you module.
The api here is a subset of the Socket from the builtin node:dgram, but with Companion hosting the sockets instead of the module.
Type of udp to use
Optionalcallback: SharedUdpSocketMessageCallbackMessage received callback
Create a shared udp socket.
This can be necessary for modules where the device/software sends UDP messages to a hardcoded port number. In those
cases if you don't use this then it won't be possible to use multiple instances of you module.
The api here is a subset of the Socket from the builtin node:dgram, but with Companion hosting the sockets instead of the module.
Optionalcallback: SharedUdpSocketMessageCallbackMessage received callback
AbstractdestroyClean up the instance before it is destroyed.
AbstractgetCreates the configuration fields for web config
OptionalhandleHandle HTTP requests from Companion
partial request object from Express
OptionalhandleHandle request from Companion to start/stop recording actions
whether recording is now running
AbstractinitWrite a line to the log
The level of the message
The message text to write
Send an osc message from the system osc sender
destination ip address
destination port number
message path
message arguments
Add an action to the current recording session
The action to be added to the recording session
OptionaluniquenessId: stringA unique id for the action being recorded. This should be different for each action, but by passing the same as a previous call will replace the previous value.
Save an updated configuration object Note: The whole config object and the keys of the secrets object are reported to the webui, so be careful how sensitive data is stored
The new config object, or undefined to not update the config
Save an updated configuration object Note: The whole config object and the keys of the secrets object are reported to the webui, so be careful how sensitive data is stored
The new config object, or undefined to not update the config
The new secrets object, or undefined to not update the secrets
Set the action definitions for this instance
The action definitions
Set the feedback definitions for this instance
The feedback definitions
Set the preset definitions for this instance
The structure of the preset sections
The unstructured preset definitions
Set the variable definitions for this instance
The variable definitions
Set the values of some variables
The new values for the variables
Call subscribe on all currently known placed actions. It can be useful to trigger this upon establishing a connection, to ensure all data is loaded.
The actionIds to call subscribe for. If no values are provided, then all are called.
Call unsubscribe on all currently known placed actions. It can be useful to do some cleanup upon a connection closing.
The actionIds to call subscribe for. If no values are provided, then all are called.
Call unsubscribe on all currently known placed feedbacks. It can be useful to do some cleanup upon a connection closing.
The feedbackIds to call subscribe for. If no values are provided, then all are called.
Update the status of this connection
The status level
Optionalmessage: string | null
Create an instance of the module