Breadcrumbs

Store API - Non State Values

Service name: Store (singleton, one per network).

Non-state values

Endpoints for retrieving computed or runtime values that are not part of the persisted Store state tree.

ConnectedClients [GET]

ConnectedClients

Returns an array with all currently connected services (services that currently respond to heartbeats).

No parameters — message is always {}.



Value

Value

 OBJECT ARRAY

Array of connected service objects, each with a Name and Role.
Example - Read current value

Request (you send)

JSON
{
  "Type": "Get",
  "Target": "Store",
  "Name": "ConnectedClients",
  "RespondTo": "<Service>"
}
JSON
{}

Response (you receive)

JSON
{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "Store",
  "Name": "ConnectedClients"
}
JSON
{
  "Value": [
    {
      "Name": "Machine1-CTS",
      "Role": "CTS"
    }
  ]
}
Shows [GET]

Shows

Returns an array of all shows available on this Store (reads the files available on disk).

No parameters — message is always {}.



Value

Value

 STRING ARRAY

Array of show name strings.
Example - Read current value

Request (you send)

JSON
{
  "Type": "Get",
  "Target": "Store",
  "Name": "Shows",
  "RespondTo": "<Service>"
}
JSON
{}

Response (you receive)

JSON
{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "Store",
  "Name": "Shows"
}
JSON
{
  "Value": [
    "DefaultShow"
  ]
}
CurrentShow [GET]

CurrentShow

Returns the name of the currently open show.

No parameters — message is always {}.



Value

Value

 STRING

The name of the currently open show.
Example - Read current value

Request (you send)

JSON
{
  "Type": "Get",
  "Target": "Store",
  "Name": "CurrentShow",
  "RespondTo": "<Service>"
}
JSON
{}

Response (you receive)

JSON
{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "Store",
  "Name": "CurrentShow"
}
JSON
{
  "Value": "DefaultShow"
}
CameraTypes [GET]

CameraTypes

Returns the list of all camera types, including default and show-specific types.

No parameters — message is always {}.



Value

Value

 OBJECT ARRAY

Array of camera type objects with id, label, camera_name, width, and height.
Example - Read current value

Request (you send)

JSON
{
  "Type": "Get",
  "Target": "Store",
  "Name": "CameraTypes",
  "RespondTo": "<Service>"
}
JSON
{}

Response (you receive)

JSON
{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "Store",
  "Name": "CameraTypes"
}
JSON
{
  "Value": [
    {
      "id": 0,
      "label": "2/3inch - 16:9",
      "camera_name": "2/3inch - 16:9",
      "width": "9.59",
      "height": "5.39"
    }
  ]
}
DefaultKeyerParameters [GET]

DefaultKeyerParameters

Returns the default chroma keyer parameter values.

No parameters — message is always {}.



Value

Value

 OBJECT

The default keyer parameters object.
Example - Read current value

Request (you send)

JSON
{
  "Type": "Get",
  "Target": "Store",
  "Name": "DefaultKeyerParameters",
  "RespondTo": "<Service>"
}
JSON
{}

Response (you receive)

JSON
{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "Store",
  "Name": "DefaultKeyerParameters"
}
JSON
{
  "Value": {}
}
DefaultSharpenParameters [GET]

DefaultSharpenParameters

Returns the default sharpen parameter values for video I/O.

No parameters — message is always {}.



Value

Value

 OBJECT

The default sharpen parameters object.
Example - Read current value

Request (you send)

JSON
{
  "Type": "Get",
  "Target": "Store",
  "Name": "DefaultSharpenParameters",
  "RespondTo": "<Service>"
}
JSON
{}

Response (you receive)

JSON
{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "Store",
  "Name": "DefaultSharpenParameters"
}
JSON
{
  "Value": {}
}
InputOutputOptions [GET]

InputOutputOptions

Returns the list of available input/output types for video I/O configuration.

No parameters — message is always {}.



Value

Value

 STRING ARRAY

Array of supported input/output type strings.
Example - Read current value

Request (you send)

JSON
{
  "Type": "Get",
  "Target": "Store",
  "Name": "InputOutputOptions",
  "RespondTo": "<Service>"
}
JSON
{}

Response (you receive)

JSON
{
  "Type": "Update",
  "Target": "<Service>",
  "Source": "Store",
  "Name": "InputOutputOptions"
}
JSON
{
  "Value": [
    "AJA",
    "BMD",
    "File",
    "NDI"
  ]
}