Pixotope QueryServer - API

Description

QueryServer is, similar to Store and AssethubServer, a per-network service, so it can be accessed statically using the name "QueryServer". It contains a bunch of DH2 Queries which serve to make using DH2 easier, it also provides "Relays" which are GET/UPDATE-able endpoints that combine data from several places or transforms it in some other way. As both the Queries and Relays are parsed at startup, they can be expanded by anyone, even in a deployed installation. It is also open source and found here:

https://bitbucket.org/futureuniverse/open-python-services/src/master/

Name

QueryServer

State

QueryServer maintains no state

Relays (GET Endpoints)

QueryServer exposes several non-state fields that can be queried at runtime. These are automatically updated and provide information about the system.

ActivatedBackupMachines

Manages automatic failover by activating backup machines when main machines become unhealthy.

Return Type: List[Dict[str, Any]]

ActiveBackupServer

Returns active server, whether it is main or backup.

Return Type: Dict[str, Any]

AllSelectedGroupMachines

Returns all selected machines from grouped render machines.

Return Type: List[str]

AsyncComputeInfo

Returns default async compute info structure with inactive status.

Return Type: Dict[str, Any]

AutomaticFailover

Returns the automatic failover setting from the store.

Return Type: bool

AvailableServerBackups

Filters and aggregates available server backup machines.

Return Type: Dict[str, Any]

AvailableSRTPorts

Calculates available SRT ports for each machine based on used ports in Routing.

AvailableTools

Aggregates available tools from all connected DRM servers.

AvailableUDPPorts

Calculates available UDP ports for each machine based on used ports in LocalChains.

Return Type: Dict[str, Dict[str, Any]]

BackupMachineLoaders

Returns the loaders per machine.

Return Type: Dict[str, Dict[str, bool]]

BackupNetworkStatus

Returns the network status of the server backup.

Return Type: Dict[str, Any]

CaptureCameraImagesProgress

Tracks progress and blurriness metrics for camera image capture operation.

CameraSystems

Calls GetCameraSystems query with machines, cameras, and tracking statuses to aggregate camera system data.

Return Type: Dict[str, Any]

CameraTrackingProtocols

Retrieves supported camera tracking protocols from connected CTS.

CloudAsyncJobInfo

Aggregates cloud async compute job information including progress, queue, ETA, and upload status.

Return Type: Dict[str, Any]

ColorMatchingInProgress

Checks if any color matching operation is currently in progress.

Return Type: Dict[str, bool]

ColorMatchingProfiles

Retrieves available color matching profiles from AR/XR pipelines.

Return Type: Dict[str, Any]

ColorMatchingProgress

Tracks the progress percentage of ongoing color matching operations.

Return Type: Dict[str, int]

ColorMatchingStatuses

Aggregates color matching calibration status, progress, and state for all pipelines.

Return Type: Dict[str, Dict[str, Any]]

CombinedEngineWorlds

Aggregates current world information from all ready engines.

Return Type: Dict[str, Any]

CombinedMatroxAdapters

Aggregates Matrox adapter information from all connected Matrox services.

Return Type: Dict[str, Any]

CombinedNMOSConfig

Aggregates NMOS persistent state configuration from all connected Matrox services.

Return Type: Dict[str, Any]

CombinedNMOSConnStatus

Aggregates NMOS connection status from all connected Matrox services.

Return Type: Dict[str, Any]

ComputeAsyncJobsUsage

Calculates total cloud async compute jobs used in the current month.

Return Type: Dict[str, int]

ConnectedBackupHandler

Returns connected BackupHandler service.

Return Type: str

ConnectedClientMachines

Returns list of connected client machines (non-server machines).

Return Type: List[str]

ConnectedCTS

Returns list of connected CTS (Camera Tracking System) services filtered by running daemons.

Return Type: List[str]

ConnectedDaemons

Returns list of connected Daemon services.

Return Type: List[str]

ConnectedDiagnostics

Returns list of connected Diagnostics services filtered by running daemons.

Return Type: List[str]

ConnectedEngines

Returns list of connected Engine services filtered by running daemons.

Return Type: List[str]

ConnectedGateways

Returns list of connected Gateway services filtered by running daemons.

Return Type: List[str]

ConnectedLicenseDRMs

Returns list of connected License DRM services filtered by running daemons.

Return Type: List[str]

ConnectedMachines

Returns list of machine names extracted from connected daemons.

Return Type: List[str]

ConnectedPipelines

Returns list of connected Pipeline services filtered by running daemons.

Return Type: List[str]

ConnectedZones

Returns list of connected ZoneServer services filtered by running daemons.

Return Type: List[str]

CurrentDaemon

Returns the daemon service of the current machine.

Return Type: str

CurrentGateway

Returns the gateway service of the current machine.

Return Type: str

CurrentLicenseDRM

Returns the license DRM service of the current machine.

Return Type: str

CurrentMachineTools

Returns available tools from the current machine.

Return Type: List[Any]

CustomDirectors

Aggregates custom director information (name, color, title) for all daemons.

Return Type: Dict[str, Dict[str, Any]]

DaemonEvents

Aggregates EngineIsStarting events from all connected daemons.

DaemonInfos

Aggregates daemon information including machine info, meta info, custom directors, and network details.

Return Type: Dict[str, Dict[str, Any]]

DaemonIsBusy

Aggregates daemon is busy information from all daemons.

Return Type: Dict[str, Any]

DirectorInfos

Aggregates director startup information from all daemons.

Return Type: Dict[str, Any]

DynamicCameras

Provides dynamic query data for cameras including name, type, tracking protocol, and camera set.

Return Type: Dict[str, Any]

DynamicIOBotEntities

Provides dynamic query data for Pixotope Space IOBot entities.

Return Type: Dict[str, Any]

DynamicIOBotPresets

Provides dynamic query data for Pixotope Space IOBot presets grouped by entity.

Return Type: Dict[str, Any]

DynamicLevels

Provides dynamic query data for available levels across all projects.

Return Type: Dict[str, Any]

DynamicMachines

Provides dynamic query data for machines including hostname, name, IP, color, render group, and server status.

Return Type: Dict[str, Any]

DynamicNDISources

Provides dynamic query data for available NDI sources from all pipelines.

Return Type: Dict[str, Any]

DynamicProjects

Provides dynamic query data for available projects across all machines.

Return Type: Dict[str, Any]

DynamicVideoInputs

Provides dynamic query data for video input routing items.

Return Type: Dict[str, Any]

DynamicVideoOutputs

Provides dynamic query data for video output routing items.

Return Type: Dict[str, Any]

DynamicWebcamSources

Provides dynamic query data for available webcam sources from all pipelines.

Return Type: Dict[str, Any]

EnabledBackupClient

Returns the enabled backup client info.

Return Type: Dict[str, Dict[str, Any]]

Endpoints

Exposes information about all available endpoints and calls. This can be called at runtime and is automatically updated.

Return Type: Object containing:

• State: boolean

• PersistentState: boolean

• Calls: Object mapping call names to their parameters

• Fields: Object mapping relay names to their descriptions

EngineCameraPreviews

Aggregates engine camera preview data from all ready engines.

Return Type: Dict[str, Any]

EngineOptions

Aggregates DLSS availability status for all ready engines.

Return Type: Dict[str, Dict[str, bool]]

EngineStates

Aggregates engine state including pixel streaming enabled, engine starting, and engine running status for all machines.

Return Type: Dict[str, Dict[str, Any]]

FailoverController

Controls failover process by activating backup machines and updating machine groups and XR mappings.

Return Type: bool

GroupedRenderMachines

Groups render machines by machine groups with selected and available machines for main and backup.

Return Type: Dict[str, Dict[str, Any]]

HealthThresholds

Returns configured health thresholds and default threshold values.

Return Type: Dict[str, Dict[str, Any]]

HealthyEngines

Returns list of machines that have healthy engine metrics.

Return Type: List[str]

HealthyMachines

Returns list of unique machine names from connected pipelines.

Return Type: List[str]

HealthySystemInfo

Evaluates machines health to determine if they have critical issues.

Return Type: Dict[str, Dict[str, bool]]

IOEffects

Aggregates IO effects (sharpen, visualizer, depth/normal generation, BPE) for all machine media.

Return Type: List[Dict[str, Any]]

InputSources

Aggregates formatted input sources (NDI, AJA cards, webcams) from all connected pipelines.

Return Type: Dict[str, Dict[str, List[Any]]]

InstallerInfos

Aggregates installer type information from all connected daemons.

Return Type: Dict[str, Dict[str, Any]]

LicenseInfos

Aggregates license information including user email and activated license names from DRM servers.

Return Type: Dict[str, Dict[str, Any]]

LOWPRIO_CombinedSystemInfo

Aggregates system information from all connected clients with low priority updates.

Return Type: Dict[str, Any]

MachineFeatures

Returns machine features supported by each machine tool.

Return Type: Dict[str, Dict[str, bool]]

MachineGroups

Maps connected machines to their default, custom, and feature group memberships.

Return Type: Dict[str, Dict[str, Any]]

MachineOutputtingKey

Determines which machines are outputting keyed video based on chromakey settings.

Return Type: Dict[str, Dict[str, bool]]

MachinesHealth

Processes and aggregates machine health metrics from diagnostics, pipeline, and engine services.

Return Type: Dict[str, Dict[str, Any]]

MainServerInfo

Returns the main server idle info.

Return Type: Dict[str, Any]

ManageIOBotConnection

Manages IOBot connection/disconnection based on stored connection info.

Return Type: bool

ManageNetworkGroups

Manages Pixotope Network client groups by updating server group info.

Return Type: bool

NetworkAdapters

Aggregates network adapter information from all connected daemons.

Return Type: Dict[str, Any]

NetworkFeatures

Returns network features supported by the server machine.

Return Type: Dict[str, bool]

ParameterThresholds

Returns parameter thresholds for machine health monitoring from store.

Return Type: Dict[str, Any]

PathsInfo

Aggregates path information (machine paths and synced paths) from all daemons.

Return Type: Dict[str, Any]

PipelineTrackingStatuses

Aggregates tracking statuses for all connected pipelines.

Return Type: Dict[str, Any]

PixotopeSpaceConnectiomStatus

Returns IOBot connection status for the current daemon.

Return Type: Dict[str, Any]

PixotopeSpaceConnectionInfo

Returns stored Pixotope Space IOBot connection information (IP and port).

Return Type: Dict[str, Any]

PixotopeSpaceEntities

Returns IOBot entities from the current daemon.

Return Type: Dict[str, Any]

PixotopeSpacePresets

Returns IOBot presets grouped by entity from the current daemon.

Return Type: Dict[str, Any]

PixotopeVersions

Aggregates Pixotope version information from all connected daemons.

Return Type: Dict[str, str]

Presets

Returns all presets from the store.

ProjectsInfos

Aggregates project paths, projects, and favourite shows from all connected daemons.

Return Type: Dict[str, Dict[str, Any]]

ReadyEngines

Filters connected engines to return only those that are ready.

Return Type: List[str]

RenderClientsGroupInfo

Combines grouped render machines with detailed machine info for selected and available machines.

Return Type: Dict[str, Dict[str, Any]]

RenderClientsMachineInfo

Aggregates render client machine information including color and machine group memberships.

Return Type: Dict[str, Dict[str, Any]]

RenderClientsMappingInfo

Aggregates render client mapping information for main and backup machines in each group.

Return Type: Dict[str, Dict[str, Any]]

RenderGroupMachines

Aggregates render group machines including host, clients, grouped machines, and available machine names.

Return Type: Dict[str, Any]

RenderMachineGroups

Processes render machine groups by filtering routing lengths and checking for out-of-sync states.

Return Type: Dict[str, Dict[str, Any]]

RenderMappingUsedSources

Returns all used videohub sources and destinations from render machine groups.

Return Type: Dict[str, List[int]]

ResetMachinesGroupsMapping

Resets machine group routings based on video outputs and connected machines.

Return Type: bool

Roles

Aggregates role information from all connected daemons.

Return Type: Dict[str, Any]

RunningPipeline

Returns the currently running pipeline, either current or first connected.

Return Type: str

ServerBackupClients

Filters and aggregates server backup client information with daemon details.

Return Type: Dict[str, Any]

ServerBackupInProgress

Returns the loading status, backup handler loaders, and backup machine loaders.

Return Type: Dict[str, Dict[str, bool]]

ServerBackups

Aggregates server backup information for all client machines.

Return Type: Dict[str, Dict[str, Any]]

ServerBackupsInfo

Aggregates server backup information for all client machines.

Return Type: Dict[str, Any]

TimecodeReport

Generates timecode report from engine system information.

TotalDataSources

Returns count of total data sources in the data mapper.

Return Type: Dict[str, int]

TriggerGetCloudJobUsage

Generates a unique UUID to trigger cloud job usage refresh.

Return Type: Dict[str, str]

ValidInvalidMachines

Calculates valid and invalid machines based on health metrics and critical failover settings.

Return Type: Dict[str, Any]

ValidRenderMachineGroups

Filters and returns valid render machine groups based on connected machines.

Return Type: Dict[str, Any]

VideehubUpdates

Generates Videohub routing updates for failover scenarios and out-of-sync corrections.

Return Type: List[Dict[str, Any]]

VideoFilesInfo

Aggregates video file information (folder, loopback, running, stopped status) for all machine routings.

Return Type: Dict[str, Dict[str, Dict[str, Any]]]

VideoInputs

Aggregates all video routing items (both inputs and outputs) from all machines.

Return Type: List[Dict[str, Any]]

VideoIOInputs

Filters VideoInputs to return only input-type video routing items.

Return Type: List[Dict[str, Any]]

VideoIOOutputs

Filters VideoInputs to return only output-type video routing items.

Return Type: List[Dict[str, Any]]

VideoOptions

Retrieves video format options (colorspaces, formats, resolutions, framerates) from running pipeline.

Return Type: Dict[str, Any]

VideoOutputsPerMachine

Aggregates video outputs grouped by machine name.

Return Type: Dict[str, List[Dict[str, Any]]]

VideohubAutoConnect

Manages Videohub auto-connect by connecting or disconnecting based on stored settings.

Return Type: bool

VideohubConnectionInfo

Returns Videohub connection information including auto-connect setting and IP address.

Return Type: Dict[str, Any]

VideohubConnectionStatus

Returns Videohub server connection status from the current daemon.

Return Type: Dict[str, Any]

VideohubController

Syncs Videohub routings when automatic failover is enabled and Videohub is connected.

Return Type: bool

VideohubSources

Returns Videohub input/output sources and their state including routing and lock status.

Return Type: Dict[str, Any]

VideohubState

Returns Videohub state including input/output labels, locks, and routing from current daemon.

Return Type: Dict[str, Any]

WebRTCNetworkConfig

Aggregates WebRTC network configuration from store machines.

Return Type: dict[str, dict[str, Any]]

ZoneCameraFormat

Monitors and relays image settings (FPS, resolution, etc.) for multiple cameras from Store routing data. Outputs data in format compatible with ApplicationModel::setImageSource.

Return Type: Dict[str, Dict[str, Any]]

ZoneMachineScenes

Retrieves all zone scenes per machine.

Return Type: Dict[str, List[Dict[str, Any]]]

ZoneMachines

Returns list of connected ZoneServer machine names.

Return Type: List[str]

ZoneScenes

Retrieves all zone scenes.

Return Type: Dict[str, Dict[str, Any]]

Calls

AddIOMedia

Adds IO media (Input/Output) to specified machines with auto-generated unique names.

Params

AddMachineGroup

Adds a new machine group.

No params.

AdjustmentPreset

Manages adjustment presets.

Params

AwaitCamerasCleared

Waits for all cameras to be cleared.

No params.

CalculateXRARLatency

Calculates XR/AR latency.

No params.

CancelCaptureImage

Cancels an ongoing camera image capture operation.

No params.

CancelColorMatching

Cancels the color matching process.

No params.

CancelComputeJobs

Cancels all running compute jobs.

No params.

CaptureCameraImages

Captures images from a specified camera.

Params

CleanRoutings

Cleans routings for a specific machine.

Params

CleanServerBackups

Cleans server backups by disabling all active servers and removing backup network configurations.

No params.

Return Type: bool

CleanupTestVideoConsistency

Params

ClearAllKeyerPresets

Clears all keyer presets of a specific type.

Params

ClearDigitalTwin

Clears the digital twin data.

No params.

ClearKeyerPreset

Clears a specific keyer preset.

Params

ClearMachineGroupsMapping

Clears all machine group mappings.

No params.

ClearRoutings

Clears all routings.

No params.

CloudAsyncGeometry

Runs cloud async geometry computation.

Params

ColorMatching

Initiates color matching process.

No params.

CompareAgainstBlackB64

Compares a base64 image against black.

Params

ConnectToVideohub

Connects to a Videohub device.

Params

CreateZoneScene

Creates a new zone scene for a specific camera.

Params

DeleteMedia

Deletes media from a machine.

Params

DeleteZoneScene

Deletes a zone scene for a specific camera.

Params

Return Type: dict

DetermineBlurrinessOfB64

Analyzes the blurriness of a base64 image.

Params

DetermineBrightnessOfB64

Analyzes the brightness of a base64 image.

Params

DiffB64Images

Calculates the difference between two base64 images.

Params

DisableVideohubAutoconnect

Disables automatic Videohub connection.

No params.

DisableServerBackup

Disables server backup for a machine and removes backup network configuration.

Params

Return Type: bool

DisconnectFromVideohub

Disconnects from the Videohub.

No params.

DispatchMetaCall

Dispatches a given method to a given service on the target machines. This is a meta-call function that allows dynamic invocation of methods across multiple machines in the system.

Params

Target Machines Special Syntax

The TargetMachines parameter supports several patterns:

1. Explicit names: ["Machine1", "Machine2"] - Targets specific machines

2. Wildcard: ["*"] - Targets all machines with connected Daemon services

3. Machine groups: ["Groups.Default.AR","Groups.Custom.MyCustomGroup"] - Targets all machines in the "Engines" group as defined in State.MachineGroupings

4. Mixed: ["Machine1", "Groups.Default.AR", "Machine2"] - Combines explicit names and groups

Response Structure

The query returns an array of result objects, one for each target machine:

[
    {
        "Machine": "string",  // Name of the target machine
        "Error": "string | null",  // Error message if the call failed, null on success
        "Result": "any | null"  // The actual result from the service, null on error or async calls
    }
]

Examples

{
    "Type": "Call",
    "Target": "QueryServer",
    "RespondTo": "Explorer",
    "Method": "DispatchMetaCall",
    "ID": "1"
}

{
    "Params": {
        "Service": "CTS",
        "Endpoint": "LensRequest",
        "Params": {},
        "TargetMachines": ["Machine1"],
    }
}

{
    "Result": [
        {
            "Machine": "Machine1",
            "Error": null,
            "Result": [
                "Canon CR-N500 & -N700.cts",
                "HJ14ex4.3B_IASE.cts",
                "Panasonic AW-UE100.cts",
                "Panasonic AW-UE150.cts",
                "Sony AM7.cts",
                "Sony BRC-X1000 & -H800.cts",
                "Sony SELP 28-135 compensated breathing.cts",
                "Template Linear.cts",
                "Template Static.cts"
            ]
        }
    ]
}

{
    "Type": "Call",
    "Target": "QueryServer",
    "RespondTo": "Explorer",
    "Method": "DispatchMetaCall",
    "ID": "2"
}

{
    "Params": {
        "Service": "CTS",
        "Endpoint": "RandomEndpoint",
        "Params": {},
        "TargetMachines": ["Machine1"],
        "IsAsync": false
    }
}

{
    "Result": [
        {
            "Machine": "Machine1",
            "Error": "Service Machine1-CTS on machine Machine1 returned a failure: Unrecognized method name",
            "Result": null
        }
    ]
}

{
    "Type": "Call",
    "Target": "QueryServer",
    "RespondTo": "Explorer",
    "Method": "DispatchMetaCall",
    "ID": "3"
}

{
    "Params": {
        "Service": "CTS",
        "Endpoint": "LensRequest",
        "Params": {},
        "TargetMachines": ["Machine1"],
        "IsAsync": true
    }
}

{
    "Result": [
        {
            "Machine": "Machine1",
            "Error": null,
            "Result": null
        }
    ]
}

{
    "Params": {
        "Service": "Engine",
        "Endpoint": "GetEngineStatus",
        "Params": {},
        "TargetMachines": ["Groups.Custom.Engines", "Machine1"],
    }
}

{
    "Params": {
        "Service": "Daemon",
        "Endpoint": "GetSystemInfo",
        "Params": {},
        "TargetMachines": ["*"],
    }
}

Notes

1. Service Naming: The query automatically constructs the full service name using the pattern {MachineName}-{ServiceName} (e.g., "Machine1-CTS").

2. Connection Validation: Before dispatching calls, the query verifies that the target service is connected. If not, it returns an error for that machine without attempting the call.

3. Sequential vs Parallel: When IsAsync is false, calls are executed sequentially, which can take time if targeting many machines. Use IsAsync: true for fire-and-forget operations.

4. Error Handling: Each machine's result is tracked independently. If one machine fails, others will still be processed. Check the Error field for each result to identify failures.

5. Group Resolution: Machine groups are resolved from State.MachineGroupings in the Store. If a group doesn't exist or is not a list, it's silently skipped.

DuplicateCurrentShow

Duplicates the currently open show.

No params.

EncoderDetectStart

Initiates encoder limit detection on a camera.

Params

Return Type: dict

EncoderDetectStop

Stops encoder limit detection on a camera.

Params

Return Type: dict

FailoverMachineSwitch

Switches failover to a different machine.

Params

FailoverMachineSwitched

Notification that failover machines have switched.

Params

GetAliveIP

Gets the alive IP address.

No params.

GetCameraSystems

Gets information about camera systems.

Params

GetColorDiagram

Gets color diagram

Params

GetDefaultVideoInput

Gets the default video input for a machine, returns SRT port if mobile, empty string otherwise.

Return Type: str

GetFromRole

Gets information from a specific role.

Params

GetImageForRouting

Gets an image for a routing.

Params

GetImportShowState

Gets the import state for a show.

Params

GetMachineNames

Retrieves the names of all machines in the system.

No params.

GetSystemDump

Gets a complete system dump for diagnostics.

No params.

GetVideoIONodes

Gets all video IO nodes in the system.

No params.

GetZoneTrackingTemplates

Gets the zone tracking templates.

No params.

Return Type: List[Dict[str, Any]]

GiveJakobNewName

Development/debug function.

No params.

ImportComputedMesh

Imports a computed mesh.

Params

Increment

Increments a value.

Params

LaunchEngineLevel

Launches a specific Unreal Engine level.

Params

LoadKeyerPreset

Loads a keyer preset.

Params

LockRenderMachineRow

Locks a render machine row in the Videohub.

Params

MeasureStoreLatency

Measures Store latency.

No params.

NestedStoreState

Tests nested store state.

No params.

NetworkHealthCheck

Performs a health check on a specified network target.

Params

NetworkInstall

Installs from a specified network path. After the Pixotope_Installer.exe is synced, a Powershell command is executed Start-Process -FilePath "Synced Config/AutoInstaller/Pixotope_Installer.exe" -ArgumentList /SILENT -Wait

Params

Return

Returns true when installation is completed or false if it fails.

PauseDedicatedVideo

Pauses dedicated video.

Params

PauseVideo

Pauses video playback.

Params

PhaseOffsetDetection

No params.

PixotopeSpaceCuePreset

Cues a preset.

Params

PixotopeSpaceGetPreset

Gets a specific preset.

Params

PixotopeSpaceGetPresets

Gets all presets for an entity.

Params

PixotopeSpacePlayLoopPreset

Plays a preset in loop mode.

Params

PixotopeSpacePlayPreset

Plays a preset.

Params

PixotopeSpaceStopPreset

Stops a playing preset.

Params

PlayVideo

Plays video on a routing.

Params

RecordDedicatedVideo

Records dedicated video to a specific file.

Params

RecordVideo

Records video from a routing.

Params

RemoveMachineGroup

Removes a machine group.

Params

RenameCamera

Renames a camera.

Params

RenameKeyerPreset

Renames a keyer preset.

Params

RenameMachineGroup

Renames a machine group.

Params

RenameMedia

Renames video media.

Params

RenameZoneScene

Renames a zone scene for a specific camera.

Params

ResetKeyerParameters

Resets keyer parameters to defaults.

Params

ResetRoutingToProtocolDefaults

Resets routing to protocol defaults.

Params

ResetTimecode

Resets timecode.

Params

ResetZoneTrackingTemplate

Resets the template for a specific scene.

Params

RestartMachines

Restarts specified machines in the system.

Params

RestartPipelines

Restarts all rendering pipelines.

No params.

RestartVideo

Restarts video playback.

Params

RouteCameraSystem

Routes a camera system.

Params

RouteLocalCamera

Routes a local camera.

Params

SaveKeyerPreset

Saves the current keyer settings as a preset.

Params

SaveZoneTrackingState

Saves the tracking state for a specific machine.

Params

Return Type: bool

SaveZoneTrackingTemplate

Saves the template for a specific scene.

Params

SetCalibratedLag

Sets calibrated lag for a component.

Params

SetTimecode

Configures timecode settings.

Params

SetTrackingProtocol

Sets the tracking protocol for a camera.

Params

SetupTestIO

Sets up test IO configuration.

Params

SetupTestVideoColorMatchingOutput

Sets up test video color matching output.

No params.

SetupTestVideoConsistency

Sets up test video routing with NDI or SRT input for consistency testing.

Params

SetupVideoIOTestOCIO

Sets up Video IO OCIO test.

No params.

SetupVideoIOTestRouting

Sets up Video IO routing test.

No params.

SetZoneConfiguration

Sets the configuration for zone service of a specific machine.

Params

Return Type: bool

ShuffleColors

Development function to shuffle colors.

No params.

ShutdownPipelines

Shuts down all rendering pipelines.

No params.

StartingEngines

Validates that engines are starting correctly.

Params

Return Type: bool

StopDedicatedVideo

Stops dedicated video.

Params

StopVideo

Stops video playback.

Params

StoreState

Tests store state functionality.

No params.

Swap

Swaps two values.

Params

SwitchCameraGroup

Switches to a different camera group.

Params

SwitchServerBackup

Switches server backup to a specified machine and configures backup network info.

Params

Return Type: bool

SyncChanges

Synchronizes changes.

Params

SyncRenderMapping

Synchronizes render mapping.

No params.

TestAwait

Tests await functionality.

No params.

TestExternalKey

Tests external keying.

No params.

TestIOBotConnection

Tests the IO Bot connection.

No params.

TestKeyer

Tests the keyer functionality.

No params.

TestSharpening

Tests image sharpening.

No params.

TestSpamSettingsChange

Tests rapid settings changes.

No params.

TestStorePerformance

Tests Store performance.

No params.

ToggleLockZoneScreen

Toggles the lock zone screen for a specific machine.

Params

Return Type: bool

UNFINISHED_TestVideoIOLatency

This test is unfinished.

No params.

UpdateMachineGroupMapping

Updates machine group mapping.

Params

UpdateMachineGroupSelection

Updates machine selection for a group.

Params

VideohubTestConnection

Tests the Videohub connection.

No params.

WaitForEngineToLaunch

Waits for an engine instance to launch.

No params.

WaitForEnginesToBeReady

Waits for all Unreal Engine instances to be ready.

No params.

WaitForMainServicesToStart

Waits for main services to start.

No params.

WaitForPipelinesToFinishBuilding

Waits for all pipelines to finish building.

No params.