Class InstanceBase<TConfig>Abstract

constructor

• new InstanceBase<TConfig>(internal): InstanceBase<TConfig>

• Create an instance of the module

  Type Parameters

  • TConfig

  Parameters

  • internal: unknown

  Returns InstanceBase<TConfig>

Readonlyid

instanceOptions

• get instanceOptions(): InstanceBaseOptions

• Returns InstanceBaseOptions

label

• get label(): string

• The user chosen name for this instance. This can be changed just before configUpdated is called

  Returns string

_getAllActions

• _getAllActions(): Pick<ActionInstance,
      | "id"
      | "controlId"
      | "actionId"
      | "options">[]

• Returns Pick<ActionInstance,
      | "id"
      | "controlId"
      | "actionId"
      | "options">[]

  Deprecated

_getAllFeedbacks

• _getAllFeedbacks(): Pick<FeedbackInstance,
      | "id"
      | "controlId"
      | "options"
      | "feedbackId">[]

• Returns Pick<FeedbackInstance,
      | "id"
      | "controlId"
      | "options"
      | "feedbackId">[]

  Deprecated

checkFeedbacks

• checkFeedbacks(...feedbackTypes): void

• Request all feedbacks of the specified types to be checked for changes

  Parameters

  • Rest...feedbackTypes: string[]

    The feedback types to check

  Returns void

checkFeedbacksById

• checkFeedbacksById(...feedbackIds): void

• Request the specified feedback instances to be checked for changes

  Parameters

  • Rest...feedbackIds: string[]

    The ids of the feedback instances to check

  Returns void

AbstractconfigUpdated

• configUpdated(config): Promise<void>

• Called when the configuration is updated.

  Parameters

  • config: TConfig

    The new config object

  Returns Promise<void>

createSharedUdpSocket

• createSharedUdpSocket(type, callback?): SharedUdpSocket

• Create a shared udp socket. This can be neccessary 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.

  Parameters

  • type: "udp4" | "udp6"

    Type of udp to use
  • Optionalcallback: SharedUdpSocketMessageCallback

    Message received callback

  Returns SharedUdpSocket
• createSharedUdpSocket(options, callback?): SharedUdpSocket

• Parameters

  • options: SharedUdpSocketOptions
  • Optionalcallback: SharedUdpSocketMessageCallback

  Returns SharedUdpSocket

Abstractdestroy

• destroy(): Promise<void>

• Clean up the instance before it is destroyed.

  Returns Promise<void>

AbstractgetConfigFields

• getConfigFields(): SomeCompanionConfigField[]

• Creates the configuration fields for web config

  Returns SomeCompanionConfigField[]

getVariableValue

• getVariableValue(variableId): undefined | CompanionVariableValue

• Get the last set value of a variable from this connection

  Parameters

  • variableId: string

    id of the variable

  Returns undefined | CompanionVariableValue

  The value

OptionalhandleHttpRequest

• handleHttpRequest(request): CompanionHTTPResponse | Promise<CompanionHTTPResponse>

• Handle HTTP requests from Companion

  Parameters

  • request: CompanionHTTPRequest

    partial request object from Express

  Returns CompanionHTTPResponse | Promise<CompanionHTTPResponse>

OptionalhandleStartStopRecordActions

• handleStartStopRecordActions(isRecording): void

• Handle request from Companion to start/stop recording actions

  Parameters

  • isRecording: boolean

    whether recording is now running

  Returns void

Abstractinit

• init(config, isFirstInit): Promise<void>

• Main initialization function called once the module is OK to start doing things.

  Parameters

  • config: TConfig
  • isFirstInit: boolean

  Returns Promise<void>

log

• log(level, message): void

• Write a line to the log

  Parameters

  • level: LogLevel

    The level of the message
  • message: string

    The message text to write

  Returns void

oscSend

• oscSend(host, port, path, args): void

• Send an osc message from the system osc sender

  Parameters

  • host: string

    destination ip address
  • port: number

    destination port number
  • path: string

    message path
  • args: OSCSomeArguments

    mesage arguments

  Returns void

parseVariablesInString

• parseVariablesInString(text): Promise<string>

• Parse and replace all the variables in a string Note: You must not use this for feedbacks, as your feedback will not update when the variable changes. There is an alternate version of this supplied to each of the action/feedback callbacks that tracks usages properly and will retrigger the feedback when the variables change.

  Parameters

  • text: string

    The text to parse

  Returns Promise<string>

  The string with variables replaced with their values

recordAction

• recordAction(action, uniquenessId?): void

• Add an action to the current recording session

  Parameters

  • action: CompanionRecordedAction

    The action to be added to the recording session
  • OptionaluniquenessId: string

    A 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.

  Returns void

saveConfig

• saveConfig(newConfig): void

• Save an updated configuration object

  Parameters

  • newConfig: TConfig

    The new config object

  Returns void

setActionDefinitions

• setActionDefinitions(actions): void

• Set the action definitions for this instance

  Parameters

  • actions: CompanionActionDefinitions

    The action definitions

  Returns void

setCustomVariableValue

• setCustomVariableValue(variableName, value): void

• Parameters

  • variableName: string
  • value: CompanionVariableValue

  Returns void

  Promise which resolves upon success, or rejects if the variable no longer exists

  Deprecated

  Experimental: This method may change without notice. Do not use! Set the value of a custom variable

setFeedbackDefinitions

• setFeedbackDefinitions(feedbacks): void

• Set the feedback definitions for this instance

  Parameters

  • feedbacks: CompanionFeedbackDefinitions

    The feedback definitions

  Returns void

setPresetDefinitions

• setPresetDefinitions(presets): void

• Set the peset definitions for this instance

  Parameters

  • presets: CompanionPresetDefinitions

    The preset definitions

  Returns void

setVariableDefinitions

• setVariableDefinitions(variables): void

• Set the variable definitions for this instance

  Parameters

  • variables: CompanionVariableDefinition[]

    The variable definitions

  Returns void

setVariableValues

• setVariableValues(values): void

• Set the values of some variables

  Parameters

  • values: CompanionVariableValues

    The new values for the variables

  Returns void

subscribeActions

• subscribeActions(...actionIds): void

• 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.

  Parameters

  • Rest...actionIds: string[]

    The actionIds to call subscribe for. If no values are provided, then all are called.

  Returns void

subscribeFeedbacks

• subscribeFeedbacks(...feedbackIds): void

• Call subscribe on all currently known placed feedbacks. It can be useful to trigger this upon establishing a connection, to ensure all data is loaded.

  Parameters

  • Rest...feedbackIds: string[]

    The feedbackIds to call subscribe for. If no values are provided, then all are called.

  Returns void

unsubscribeActions

• unsubscribeActions(...actionIds): void

• Call unsubscribe on all currently known placed actions. It can be useful to do some cleanup upon a connection closing.

  Parameters

  • Rest...actionIds: string[]

    The actionIds to call subscribe for. If no values are provided, then all are called.

  Returns void

unsubscribeFeedbacks

• unsubscribeFeedbacks(...feedbackIds): void

• Call unsubscribe on all currently known placed feedbacks. It can be useful to do some cleanup upon a connection closing.

  Parameters

  • Rest...feedbackIds: string[]

    The feedbackIds to call subscribe for. If no values are provided, then all are called.

  Returns void

updateStatus

• updateStatus(status, message?): void

• Update the status of this connection

  Parameters

  • status: InstanceStatus

    The status level
  • Optionalmessage: null | string

    Additional information about the status

    Example

    this.updateStatus(InstanceStatus.Ok)
    Copy

  Returns void