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.

AvailableSRTPorts

Gets available SRT ports.

AvailableTools

Aggregates available tools from all connected DRM servers.

BackupNetworkCleanup

Information about backup network cleanup status.

BackupNetworkInfo

Information about the backup network configuration.

CameraTrackingProtocols

Lists available camera tracking protocols.

CaptureCameraImagesProgress

Progress information for camera image capture operations.

DaemonEvents

Information about daemon events in the system.

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

Calls

AddIOMedia

Adds IO media to specified machines.

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

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

DeleteMedia

Deletes media from a machine.

Params

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.

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.

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

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.

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

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

ResetKeyerParameters

Resets keyer parameters to defaults.

Params

ResetRoutingToProtocolDefaults

Resets routing to protocol defaults.

Params

ResetTimecode

Resets timecode.

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

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 video consistency test.

Params

SetupVideoIOTestOCIO

Sets up Video IO OCIO test.

No params.

SetupVideoIOTestRouting

Sets up Video IO routing test.

No params.

ShuffleColors

Development function to shuffle colors.

No params.

ShutdownPipelines

Shuts down all rendering pipelines.

No params.

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

SyncChanges

Synchronizes changes.

Params

SyncRenderMapping

Synchronizes render mapping.

No params.

TestAIKeyer

Tests the AI keyer functionality.

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.

UNFINISHED_TestVideoIOLatency

This test is unfinished.

No params.

UpdateBackupServer

Updates backup server configuration.

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.