Pixotope CTS (Tracking) - API
Description
Pixotope CTS (Tracking) is a service that is responsible for interpreting tracking data from external sources, adding offsets or lens values and providing that tracking information to renderers. It always sends data to the CTSReceiver plugin in Editor.
Learn more about the Pixotope Tracking Service
Name
[MachineName]-CTS
for example "RenderMachine1-CTS"
The CTS
service is equivalent to the Tracking service PX_Tracking.exe
State
You most likely don’t want to call or change this state directly, but instead change the Chain-object on Store.
{
"State": {
"Meta" : {Program wide settings, currently only log verbosity.},
"Chains" : {
"chain_id_0" : {chain_object_0},
"chain_id_1" : {chain_object_1},
... more or fewer chains ...
}
}
}
Meta
The meta object contains global CTS settings. CTS status reports are sent regardless of these settings.
{
"Meta":
{
"FileLogVerbostiy" : "debug"/"log"/"warning"/"error",
"DirectorLogVerbosity" : one of the alternatives above
}
}
RPC
GetLensFileLocation
Returns the local path of the lens file folder.
STRING |
|
LensRequest
This command exists to let callers know which lens files are available in [Installation folder]/Services/Tracking/lensfiles
. Response is a simple list of lens file names as strings.
STRING ARRAY | Found lens files |
ProtocolRequest
Gives callers knowledge of supported protocols. It literally sends[Installation folder]/Services/Tracking/config/supportedProtocols.json
.
This is not updated every time the supportedProtocols.json
file is added to or has changed structure.
STRING | Supported tracking protocols object |
ReloadLensFile
Reloads the lens file of a the specified chain id.
Parameters
ChainId | STRING | ChainId |