disguise-osc

Disguise OSC

This module provides default OSC controls to the Disguise server. Setup OSC transport within Disguise.

Warning: Full functionality is only available if the Disguise is configured to always send osc feedback

Variable Support in Actions

All actions that accept numeric input (integer or float) now support Companion variables. You can enter a variable (e.g., $(internal:myvar)) in any field marked as supporting variables. The value will be resolved at runtime, and the action will validate the result before sending.

Examples:

• Cue: Enter 5 or $(internal:cue_number)
• Float Cue: Enter 1.23 or $(internal:float_value)
• Brightness/Volume Steps: Enter 0.01 or $(internal:step)

If a variable does not resolve to a valid number, the action will log a debug message and abort.

Debug Logging

All actions that resolve variables will log debug information to help with troubleshooting. Check the Companion log for details if an action does not behave as expected.

UI Validation

The UI will now accept both direct numbers and variable patterns in relevant fields. Errors will be shown if the resolved value is not a valid number at runtime.

---

ACTIONS

show control

• Play
• Play to end of section
• Loop section
• Stop
• Previous Section
• Next Section
• Return to start
• Previous track
• Next track
• Track name
• Track ID
• Cue (integer or variable)
• Float Cue (float or variable)
• Fade up
• Fade down
• Hold
• Decrease master volume
• Increase master volume
• Toggle shift¹
• Shift aware volume²
• Decrease master brightness
• Increase master brightness
• Shift aware brightness²
• Send custom OSC message

layer control

• video layer
  • blendmode
  • brightness
  • tint
  • speed
  • mode
  • at end point
  • transition_time
  • volume
  • brightness (shift)
  • contrast (scale)
  • saturation scale

VARIABLES

• currentSectionName
• nextSectionName
• heartbeat
• playMode
• current section time elapsed
• current section time remaining
• sectionHint
• timecode position
• timecode position hours
• timecode position minutes
• timecode position seconds
• timecode position frames
• trackid
• track name
• track position
• track position hours
• track position minutes
• track position seconds
• track position frames
• master volume
• master brightness
• bpm

PRESETS

• play
• play section
• loop section
• stop
• previous section
• next section
• return to start
• previous track
• next track
• fade up
• fade down
• hold
• shift aware volume³
• decrease master volume
• increase master volume
• shift aware brightness³
• decrease master brightness
• decrease master brightness
• heartbeat / toggle shift⁴

FEEDBACKS

• heartbeat
• playmode
• increase volume⁵
• decrease volume⁵
• master volume = 0
• increase brightness⁵
• decrease brightness⁵
• master brightness = 0
• custom OSC address

TASKS

• Add presets for information received from Disguise e.g. section name, timecode position
• Add combined preset for fade down / fade up / hold
• Ask Disguise if an output message can be added for status of fade down and hold

Footnotes

1. Toggle shift inverts a boolean variable not available to the user. It provides increased functionality to shift aware actions, presets and feedbacks. ↩

2. If shift is false shift aware volume / brightness decrement the linked value by the user provided step value. If shift is true shift aware volume/brightness increment the linked value by the user provided step value. ↩ ↩²

3. Shift aware volume/brightness presets allow chnages to be made in both directions depending on the value of the shift variable ↩ ↩²

4. The heartbeat preset includes the toggle shift action. Each time the button is pressed shift will invert. ↩

5. increase (or decrease) volume (or brightness) feedbacks change the png on the button to indicate if the shift variable state is set to allow increase or decrease to volume and brightness ↩ ↩² ↩³ ↩⁴