Store API - Calls
Shows
ChangeShow
Changes the open show. This can be a new one.
Params| ShowName | STRING | Name of show to change to. |
CreateShow
Same as ChangeShow, but also sets the project path from the provided argument.
Params| ShowName | STRING | Name of the new show. |
| Project | STRING | Path of .uproject file of the linked project. |
CreateShowWithTemplate
Same as CreateShow but also copies all files from the "Template"-location to the "Project" location.
Params| ShowName | STRING | Name of the new show. |
| Project | STRING | Path of folder the template project should be copied to (linked project). |
| Template | STRING | Path of .uproject file of the template project. |
RenameShow
Renames a show.
Params| ShowName | STRING | Name of the show to rename. |
| NewShowName | STRING | New name. |
DuplicateShow
Duplicates a show.
Params| ShowName | STRING | Name of the show to duplicate. |
DeleteShow
Deletes the show from disk.
Params| ShowName | STRING | Name of show to delete. |
GetStateForShow
Will return the complete state of a specific service and show. This is useful when importing settings from another show and similar.
To get the current show, use a normal Get.
| Service | STRING | Name of the service. |
| ShowName | STRING | Name of the show. |
GetAllStatesForShow
Same as GetStateForShow, but returns the states of all services.
Params| ShowName | STRING | Name of the show. |
GetAllStates
Same as GetAllStatesForShow, using the current show.
No params.GetShowFile
Gets a complete show DB file in binary format.
Params| ShowName | STRING | Name of the show. |
Tracking
AddCamera
Creates a new camera system object under a unique identifier. Use AddDefaultCamera when possible.
Params| Name | STRING | Name of the new camera system. |
| Fingerprint | STRING | Unique identifier of the owner. |
| ObjectState | OBJECT | Camera object. |
AddDefaultCamera
Same as AddCamera, but the Camera/Chain-object is created based on defaults. This is the most common way of creating a camera.
Params| Name | STRING | Name of the new camera system. |
| Fingerprint | STRING | Unique identifier of the owner. |
DuplicateCamera
Duplicates the camera system with the specified name and updates the fingerprint of the duplicate.
Params| Name | STRING | Name of the new camera system to duplicate. |
| Fingerprint | STRING | Unique identifier of the new owner. |
DuplicateObjectTrackerGroup
Same as DuplicateCamera but for ObjectTrackerGroup.
Params| Group | STRING | Name of the new object tracker group to duplicate. |
| Fingerprint | STRING | Unique identifier of the owner. |
AddDefaultObjectTrackerGroup
Creates a new Object Tracker Group object under a unique identifier.
Params| Name | STRING | Name of the new object tracker group. |
| Fingerprint | STRING | Unique identifier of the owner. |
AddDefaultObjectTracker
Creates a new Tracker object under the provided Group ID.
Params| Group | STRING | Name of the object tracker group the object tracker should be added to. |
| Name | STRING | Name of the new object tracker. |
CreateObjectWithUniqueID
Used for creating objects under unique identifiers in the database, used mostly internally (for example in AddCamera).
Params| Position | STRING |
| ObjectState | OBJECT |
RouteTrackingOnly
Params| Chain |
| ComputerName |
| IP |
DerouteTrackingOnly
Params| Chain |
| ComputerName |
Video IO
AddVideoIO
Adds a new VideoIO object.
Params| ObjectState | OBJECT | VideoIO object. |
| Fingerprint | STRING | Unique identifier of the new owner. |
SetVideoKeyerValue
Params| VideoIOName |
| ParameterName |
| Value |
RouteVideoIOOnly
Params| VideoIO |
| Pipeline |
| Video |
RouteVideoIO
Routes a VideoIO object to the designated Pipeline (VideoIO service on a specific machine). If the VideoIO object is a camera, it also routes tracking information using the IP.
Params| VideoIO | OBJECT | VideoIO object. |
| Pipeline | STRING | Name of the VideoIO service (on a specific machine) the videoIO object should be routed to. |
| Video | STRING | Input/output address to use (for example sdi1 if using AJA or BMD). |
| IP | STRING | IP address of the target machine, in case the VideoIO is a Camera and tracking data needs to be sent. |
DerouteVideoIO
Removes a VideoIO routing from a Pipeline (VideoIO service).
Params| VideoIO | OBJECT | VideoIO object. |
| Pipeline | STRING | Name of the VideoIO service the videoIO object is routed to. |
Other
TargetRole
Relays an RPC message to all connected instances of a specific service (or all services).
Params| Topic | OBJECT | Topic of the message you want to relay
In the "Target" field you specify the services you want to target. Possible values: "DataHub" | "Store" | "DirectorAPI" | "VideoIO" | "Tracking" | "Director" | "Engine" | "All" |
| Message | OBJECT | Message you want to relay. |
RegisterServiceShutdown
Params| Service |
GetMachineDefaultColor
Params| Machine | STRING |
| IsServer | BOOLEAN |
SetCameraSet
Params| Number |