disguise Session API
Released to Beta
Control of the disguise media server Session API compatible with disguise release r23.0 and later using HTTP. This Module allows control over the current d3 session, and as such only functions when d3 Designer is running. To control the d3 service, look to use the disguise service API module.
disguise is a platform for creatives and technologists to imagine, create and deliver spectacular visual experiences. Combining software with powerful media server video playback and video hardware, disguise empowers brands, artists, production houses and our partners to tell stories that inspire their audiences.
Note: To use this module, the disguise server must be set to receive HTTP. - If using more than one disguise server to create a Main &Understudy setup, commands be sent to both the main and understudy server.
| Module Rating | |
|---|---|
| Quality of API | 3/3 |
| Implementation | 2/3 |
| Status | Partial |
See the Modules Overview article for more information about how Module Ratings are calculated.
Module Settings
- disguise Patch - Select an HTTP patch referencing your disguise server from the Module Settings.
Process Block
After creating a disguise node, a block will be generated for it within Ctrl Suite's Process Editor for integration as part of a process flow.
Create a Process node or edit an existing one to use the block's full functionality.
Options
To allow options to auto=populate then using Ctrl Designer, ensure you are connected to Ctrl Engine on a network, your workspace is synced (Ctrl+S/Cmd+S) and the disguise d3 Designer software can communicate with Ctrl Engine on a local network.
If you are unable to connect to Ctrl Engine, or do not have a disguise server on your network, it is possible to define commands and UID's, however, these will not automatically auto-populate based on the content of the selected server.
| Endpoint | Option 1 | Option 2 | Option 3 | Option 4 | Option 5 | Notes |
|---|---|---|---|---|---|---|
| Renderstream Get Layer Config | Layer [Select] | - | - | - | - | Returns a list of Renderstream Layers in json. If disconnected from disguise when creating this request, define the layer to target using the Layer UID or Name. |
| Renderstream Get Layers | - | - | - | - | - | Receives the names of all layers in Renderstream. |
| Renderstream Get Layer Status | Layer [Select] | - | - | - | - | Receives the status of each layer. If disconnected from disguise when creating this request, define the layer to target using the Layer UID or Name. |
| Renderstream Restart Layers | Layer(s) [Select] | - | - | - | - | Restarts specific layers within Renderstream. If disconnected from disguise when creating this request, define the layer to target using the Layer UID or Name. |
| Renderstream Start Layers | Layer(s) [Select] | - | - | - | - | Starts specific layers within Renderstream. If disconnected from disguise when creating this request, define the layer to target using the Layer UID or Name. |
| Renderstream Stop Layers | Layer(s) [Select] | - | - | - | - | Stops specific layers within Renderstream. If disconnected from disguise when creating this request, define the layer to target using the Layer UID or Name. |
| Renderstream Sync Layers | Layer(s) [Select] | - | - | - | - | Syncs specific layers within Renderstream. If disconnected from disguise when creating this request, define the layer to target using the Layer UID or Name. |
| Sequencing Change Indirections | Indirection [Select] | Resource [Select] | - | - | - | Change Renderstream. If disconnected from disguise when creating this command, define the Indirection to target using the UID or Name. |
| Sequencing List Available Resourecs | Indirection [Select] | - | - | - | - | Lists all resources available to an indirection. If disconnected from disguise when creating this, define the Indirection to target using the Layer UID or Name. |
| Sequencing List Indirections | - | - | - | - | - | Returns a list of all Indirections. If disconnected from disguise when creating this request, define the layer to target using the Layer UID or Name. |
| Status List Heath | - | - | - | - | - | Returns health of the target server. |
| Status Get Session | - | - | - | - | - | List the name of the current session. notifications. |
| Status List Notifications | - | - | - | - | - | List project notifications. |
| Status Get Project | - | - | - | - | - | Returns the current project information. |
| Transport Get Active Transports | - | - | - | - | - | Returns all active Transports. |
| Transport List Annotations | Track [Select] | - | - | - | - | Lists all available tracks. If disconnected from disguise when creating this, define the track to target using the Track UID or Name. |
| Transport Set Brightness | Transport(s) [Select] | Brightness [0..1] | - | - | - | A Float value to set the Transport brightness. If disconnected from disguise when creating this, define each transport using its UID or Name. |
| Transport Set Engaged | Transport(s) [Select] | Engaged [Yes/No] | - | - | - | Bool to set if the Transport is Engaged. If disconnected from disguise when creating this, define each transport using its UID or Name. |
| Transport Go To Frame | Transport(s) [Select] | Frame Number [Select] | Play Mode [Set/Not Set/PlaySection/Loop/Stop] | - | - | Use this option to jump the playhead to a specific frame within a transport. If disconnected from disguise when creating this request, define the transport to target using its UID or Name. |
| Transport Go To Next Section | Transport(s) [Select] | Play Mode [Set/Not Set/PlaySection/Loop/Stop] | - | - | - | Use this option to jump the playhead to the next section within a transport. If disconnected from disguise when creating this request, define the transport to target using its UID or Name. |
| Transport Go To Next Track | Transport(s) [Select] | Play Mode [Set/Not Set/PlaySection/Loop/Stop] | - | - | - | Use this option to jump to the next track. If disconnected from disguise when creating this request, define the transport to target using its UID or Name. |
| Transport Go To Note | Transport(s) [Select] | Note to Jump to [Select] | Play Mode [Set/Not Set/PlaySection/Loop/Stop] | - | - | Use this option to jump the playhead to a specific note within a transport. If disconnected from disguise when creating this request, define the transport to target using its UID or Name. |
| Transport Go To Prev Section | Transport(s) [Select] | Play Mode [Set/Not Set/PlaySection/Loop/Stop] | - | - | - | Use this option to jump the playhead to the previous section within a transport. _If disconnected from disguise when creating this request, define the transport to target using its UID or Name. |
| Transport Go To Prev Track | Transport(s) [Select] | Play Mode [Set/Not Set/PlaySection/Loop/Stop] | - | - | Use this option to jump the playhead to a specific note within a transport. _If disconnected from disguise when creating this request, define the transport to target using its UID or Name. | |
| Transport Go To Section | Transport(s) [Select] | Section to Jump to [Select] | Play Mode [Set/Not Set/PlaySection/Loop/Stop] | - | - | Use this option to jump the playhead to a specific section within a transport. If disconnected from disguise when creating this request, define the transport to target using its UID or Name. |
| Transport Go To Tag | Transport Name / ID [Select] | Type [Cue/Timecode/MIDI] | Tag [Select] | Global Jump [Yes/No] | Play Mode [Set/Not Set/PlaySection/Loop/Stop] | Use this option to jump the playhead to a specific tag within a transport. If disconnected from disguise when creating this request, define the transport to target using its UID or Name. |
| Transport Go To Time | Transport(s) [Select] | Time in seconds [Select] | Play Mode [Set/Not Set/PlaySection/Loop/Stop] | - | - | Use this option to jump the playhead to a specific time within a transport. _If disconnected from disguise when creating this request, define the transport to target using its UID or Name. |
| Transport Go To Time Code | Transport(s) [Select] | Timecode point [MM:SS:FF] | Ignore Tags [Yes/No] | Play Mode [Set/Not Set/PlaySection/Loop/Stop] | - | Jumps the playhead to a specific time within timecode (Formatted time string). When enabled, Ignore Tags allows the playhead to jump to a timecode point relative to the start of a track. If disconnected from disguise when creating this, define each transport using its UID or Name. |
| Transport Go To Track | Track [Select] | - | - | - | - | Jump to a specific track. If disconnected from disguise when creating this, define each transport using its UID or Name. |
| Transport Play | Transport(s) [Select] | - | - | - | - | Play aspecific Transport. If disconnected from disguise when creating this, define each transport using its UID or Name. |
| Transport Play Loop Section | Transport(s) [Select] | - | - | - | - | Play a specific loop section If disconnected from disguise when creating this, define each transport using its UID or Name. |
| Transport Play Section | Transport(s) [Select] | - | - | - | - | Play a specific section. If disconnected from disguise when creating this, define each transport using its UID or Name. |
| Transport Return To Start | Transport(s) [Select] | - | - | - | - | Returns the Playhead to the start of the transport. If disconnected from disguise when creating this, define each transport using its UID or Name. |
| Transport List Set Lists | - | - | - | - | - | Lists all Set Lists. |
| Transport Stop | Transport(s) [Select] | - | - | - | - | Stops specific transports. If disconnected from disguise when creating this, define each transport using its UID or Name. |
| Transport List Tracks | - | - | - | - | - | List all Tracks. |
| Transport Set Volume | Transport(s) [Select] | Level [0..1] | - | - | - | Set a volume for the selected transports. If disconnected from disguise when creating this, define each transport using its UID or Name. |
Troubleshooting
-
Ensure HTTP remote control is enabled within disguise and Ctrl Suite is targeting the correct IP address.
-
Ensure you are running disguise r23.2 or higher.
Additional Resources
The disguise API modules made their debut at the Integrated Systems Europe 2023 to control disguise's booth, virtual production demos & presentations.