Skip to main content
Skip table of contents

Store API - Calls

Shows

ChangeShow

ChangeShow

Changes the open show. This can be a new one.

Params
ShowName STRINGName of show to change to.
CreateShow

CreateShow

Same as ChangeShow, but also sets the project path from the provided argument.

Params
ShowName STRINGName of the new show.
Project STRINGPath of .uproject file of the linked project.
CreateShowWithTemplate

CreateShowWithTemplate

Same as CreateShow but also copies all files from the "Template"-location to the "Project" location.

Params
ShowName STRINGName of the new show.
Project STRINGPath of folder the template project should be copied to (linked project).
Template STRINGPath of .uproject file of the template project.
Move BOOLEAN OPTIONALIf true, the template will be moved instead of being copied. Default: false.
RenameShow

RenameShow

Renames a show.

Params
ShowName STRINGName of the show to rename.
NewShowName STRINGNew name.
DuplicateShow

DuplicateShow

Duplicates a show.

Params
ShowName STRINGName of the show to duplicate.
DeleteShow

DeleteShow

Deletes the show from disk.

Params
ShowName STRINGName of show to delete.
GetStateForShow

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.

Params
Service STRINGName of the service.
ShowName STRINGName of the show.
GetAllStatesForShow

GetAllStatesForShow

Same as GetStateForShow, but returns the states of all services.

Params
ShowName STRINGName of the show.
GetAllStates

GetAllStates

Same as GetAllStatesForShow, using the current show.

No params.
GetShowFile

GetShowFile

Gets a complete show DB file in binary format.

Params
ShowName STRINGName of the show.

Tracking

AddCamera

AddCamera

Creates a new camera system object under a unique identifier. Use AddDefaultCamera when possible.

Params
Name STRINGName of the new camera system.
Fingerprint STRINGUnique identifier of the owner.
ObjectState OBJECTCamera object.
AddDefaultCamera

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 STRINGName of the new camera system.
Fingerprint STRINGUnique identifier of the owner.
DuplicateCamera

DuplicateCamera

Duplicates the camera system with the specified name and updates the fingerprint of the duplicate.

Params
Name STRINGName of the new camera system to duplicate.
Fingerprint STRINGUnique identifier of the new owner.
DeleCaemera

DeleCaemera

Removes camera object

Params
Name STRINGName of the new camera system to duplicate.
Fingerprint STRINGUnique identifier of the new owner.
CreateObjectWithUniqueID

CreateObjectWithUniqueID

Used for creating objects under unique identifiers in the database, used mostly internally (for example in AddCamera).

Params
Position STRING
ObjectState OBJECT
RouteTracking

RouteTracking

Params
Chain
ComputerName
IP
DerouteTracking

DerouteTracking

Params
Chain
ComputerName
RouteVideoIO

RouteVideoIO

Params
Chain
ComputerName
RouteCameraSystem

RouteCameraSystem

Params
ComputerName
Name
Camera
IOType
IP
RegisterServiceShutdown

RegisterServiceShutdown

Params
Service
GetMachineDefaultColor

GetMachineDefaultColor

Params
Machine STRING
IsServer BOOLEAN
SetCameraSet

SetCameraSet

Params
Number
AddCameraType

AddCameraType

Params
Number
ExportShowToString

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 STRINGOptional, the name of the show to export
ImportShowFromString

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 STRINGOptional, the name of the show to import
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.