disguise Service API
Released to Beta
Control of the disguise media server Service API compatible with disguise release r23.0 and later using HTTP. This Module allows control over functionality provided by the d3service runtime and are available whenever disguise is installed on a machine.
To control the d3 session that is currently open, use the disguise session 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: 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 either a disguise server or disguise 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 | Notes |
|---|---|---|---|---|
| Project Start Local Project | Project Path [File Directory] | Solo Mode [True/False] | Allow Upgrade [True/False] | Start a disguise project. |
| Project Restart Local Project | - | - | - | Restart an active disguise project. |
| Project Quit Local Project | - | - | - | Quit an active disguise project. |
| Project Force Quit Local Project. | - | - | - | Force quit an active disguise project. |
| System Detect Systems | - | - | - | List all remote disguise machines and local machine system info. |
| System Detect GPU Outputs | - | - | - | List all GPU Outputs (only works on d3 servers). |
| System Network Adaptors | - | - | - | List all Network Adapters. |
| System List Projects | - | - | - | List all project files on the disguise server. |
| System List VFCs | - | - | - | Lists all VFC Cards installed within a system. |
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.