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. |
| Move | BOOLEAN OPTIONAL | If true, the template will be moved instead of being copied. Default: false. |
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. |
CreateObjectWithUniqueID
Used for creating objects under unique identifiers in the database, used mostly internally (for example in AddCamera).
Params| Position | STRING |
| ObjectState | OBJECT |
RouteTracking
Params| Chain |
| ComputerName |
| IP |
DerouteTracking
Params| Chain |
| ComputerName |
RouteVideoIO
Params| Chain |
| ComputerName |
RouteCameraSystem
Params| ComputerName |
| Name |
| Camera |
| IOType |
| IP |
RegisterServiceShutdown
Params| Service |
GetMachineDefaultColor
Params| Machine | STRING |
| IsServer | BOOLEAN |
SetCameraSet
Params| Number |
AddCameraType
Params| Number |
ExportShowToString
Export the show file of input Name (if no Name sent, uses current) to a .txt file, default folder is "Exports" next to the show files
Params| Name | STRING | Optional, the name of the show to export |
ImportShowFromString
Imports a .txt file based on show of Name (if no Name sent, uses current), likely a file that has previously been created via ExportShowToString, default folder is "Exports" next to the show files
Params| Name | STRING | Optional, the name of the show to import |