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.
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.
DuplicateObjectTrackerGroup

DuplicateObjectTrackerGroup

Same as DuplicateCamera but for ObjectTrackerGroup.

Params
Group STRINGName of the new object tracker group to duplicate.
Fingerprint STRINGUnique identifier of the owner.
AddDefaultObjectTrackerGroup

AddDefaultObjectTrackerGroup

Creates a new Object Tracker Group object under a unique identifier.

Params
Name STRINGName of the new object tracker group.
Fingerprint STRINGUnique identifier of the owner.
AddDefaultObjectTracker

AddDefaultObjectTracker

Creates a new Tracker object under the provided Group ID.

Params
Group STRINGName of the object tracker group the object tracker should be added to.
Name STRINGName of the new object tracker.
CreateObjectWithUniqueID

CreateObjectWithUniqueID

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

Params
Position STRING
ObjectState OBJECT
RouteTrackingOnly

RouteTrackingOnly

Params
Chain
ComputerName
IP
DerouteTrackingOnly

DerouteTrackingOnly

Params
Chain
ComputerName

Video IO

AddVideoIO

AddVideoIO

Adds a new VideoIO object.

Params
ObjectState OBJECTVideoIO object.
Fingerprint STRINGUnique identifier of the new owner.
SetVideoKeyerValue

SetVideoKeyerValue

Params
VideoIOName
ParameterName
Value
RouteVideoIOOnly

RouteVideoIOOnly

Params
VideoIO
Pipeline
Video
RouteVideoIO

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 OBJECTVideoIO object.
Pipeline STRINGName of the VideoIO service (on a specific machine) the videoIO object should be routed to.
Video STRINGInput/output address to use (for example sdi1 if using AJA or BMD).
IP STRINGIP address of the target machine, in case the VideoIO is a Camera and tracking data needs to be sent.
DerouteVideoIO

DerouteVideoIO

Removes a VideoIO routing from a Pipeline (VideoIO service).

Params
VideoIO OBJECTVideoIO object.
Pipeline STRINGName of the VideoIO service the videoIO object is routed to.

Other

TargetRole

TargetRole

Relays an RPC message to all connected instances of a specific service (or all services).

Params
Topic OBJECTTopic 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 OBJECTMessage you want to relay.
RegisterServiceShutdown

RegisterServiceShutdown

Params
Service
GetMachineDefaultColor

GetMachineDefaultColor

Params
Machine STRING
IsServer BOOLEAN
JavaScript errors detected

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

If this problem persists, please contact our support.