Instant Replay Commands

Captivate includes instant replay functionality, allowing you to grab previously recorded content and play it back as if it were live. All commands here allow you to grab, set, and playout instant replays.

replay_arm_inputs

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_arm_inputs

Arms a list of inputs and immediately starts the Instant Replay buffer. You can see the list of available inputs by using replay_get_inputs.

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

inputsarrayOptional

['USB Camera VID:1133 PID:2075']

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_arm_inputs

HTTPcURLJavaScriptPython

GET /api/command/replay_arm_inputs HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_arm_inputs",
    "reply": "replay_arm_inputs",
    "success": true
  }
}

replay_commands

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_commands

Get a list of all the available replay commands..

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_commands

HTTPcURLJavaScriptPython

GET /api/command/replay_commands HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_commands",
    "commands": [
      "replay_is_trial_mode"
    ],
    "reply": "replay_commands",
    "success": true
  }
}

replay_disarm_inputs

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_disarm_inputs

Removes an input from the armed inputs list. If there are no armed inputs, the Instant Replay will be disabled..

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

inputsarrayOptional

['USB Camera VID:1133 PID:2075']

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_disarm_inputs

HTTPcURLJavaScriptPython

GET /api/command/replay_disarm_inputs HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_disarm_inputs",
    "reply": "replay_disarm_inputs",
    "success": true
  }
}

replay_enable

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_enable

Does the same as starting the instant replay if there are any armed inputs..

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

speednumberOptional

0.5

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_enable

HTTPcURLJavaScriptPython

GET /api/command/replay_enable HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_enable",
    "reply": "replay_enable",
    "success": true
  }
}

replay_enable_scrubbing

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_enable_scrubbing

Turn scrubbing on or off. Note: When set to true will leave recording mode and enter replay mode..

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

enablebooleanOptional

True

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_enable_scrubbing

HTTPcURLJavaScriptPython

GET /api/command/replay_enable_scrubbing HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_enable_scrubbing",
    "reply": "replay_enable_scrubbing",
    "success": true
  }
}

replay_enter_playback

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_enter_playback

Enters Instant Replay playback mode if it is enabled..

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_enter_playback

HTTPcURLJavaScriptPython

GET /api/command/replay_enter_playback HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_enter_playback",
    "reply": "replay_enter_playback",
    "success": true
  }
}

replay_exit_playback

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_exit_playback

Exits Instant Replay playback mode..

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_exit_playback

HTTPcURLJavaScriptPython

GET /api/command/replay_exit_playback HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_exit_playback",
    "reply": "replay_exit_playback",
    "success": true
  }
}

replay_get_inputs

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_get_inputs

Get a list of available inputs that can be used for Instant Replay.

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

speednumberOptional

0.5

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_get_inputs

HTTPcURLJavaScriptPython

GET /api/command/replay_get_inputs HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_get_inputs",
    "inputs": [
      {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ],
    "reply": "replay_get_inputs",
    "success": true
  }
}

replay_get_play_info

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_get_play_info

Get some statistics about the current Instant Replay playback..

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

inputsarrayOptional

['USB Camera VID:1133 PID:2075']

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_get_play_info

HTTPcURLJavaScriptPython

GET /api/command/replay_get_play_info HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_get_play_info",
    "frameRate": 29.97,
    "replayDuration": 0,
    "replayEnd": 0,
    "replayScrubStart": 0,
    "replayStart": 0,
    "replayTime": 15,
    "reply": "replay_get_play_info",
    "success": true
  }
}

replay_get_replay_speed

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_get_replay_speed

Get the current replay speed..

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

speednumberOptional

0.5

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_get_replay_speed

HTTPcURLJavaScriptPython

GET /api/command/replay_get_replay_speed HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_get_replay_speed",
    "reply": "replay_get_replay_speed",
    "speed": 0.5,
    "success": true
  }
}

replay_get_settings

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_get_settings

Get the current settings. Callback will have a settings object..

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_get_settings

HTTPcURLJavaScriptPython

GET /api/command/replay_get_settings HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_get_settings",
    "reply": "replay_get_settings",
    "settings": {
      "armedPortList": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "bufferLength": 15,
      "muteGraphicsOnReplay": true,
      "playSpeed": 0.5,
      "transIn": "",
      "transOut": "",
      "usesExternalSwitcher": true
    },
    "success": true
  }
}

replay_is_trial_mode

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_is_trial_mode

Get a boolean value indicating if Instant Replay has been properly licensed. Returns an object with a boolean named isTrial.

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_is_trial_mode

HTTPcURLJavaScriptPython

GET /api/command/replay_is_trial_mode HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_is_trial_mode",
    "isTrial": true,
    "reply": "replay_is_trial_mode",
    "success": true
  }
}

replay_play_pause

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_play_pause

If in replay mode, does the same as clicking the play arrow..

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

enablebooleanOptional

True

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_play_pause

HTTPcURLJavaScriptPython

GET /api/command/replay_play_pause HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_play_pause",
    "reply": "replay_play_pause",
    "success": true
  }
}

replay_set_in_point

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_set_in_point

Set the Instant Replay play-in point. Takes a position parameter just like the previous command, but can be usedwhether replay mode is active or not..

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

positionnumberOptional

10.3

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_set_in_point

HTTPcURLJavaScriptPython

GET /api/command/replay_set_in_point HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_set_in_point",
    "reply": "replay_set_in_point",
    "success": true
  }
}

replay_set_out_point

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_set_out_point

Set the Instant Replay play-out point. Same as above..

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

positionnumberOptional

10.3

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_set_out_point

HTTPcURLJavaScriptPython

GET /api/command/replay_set_out_point HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_set_out_point",
    "reply": "replay_set_out_point",
    "success": true
  }
}

replay_set_replay_speed

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_set_replay_speed

Change the replay speed.Note: The settings object uses playSpeed but this command uses speed to mean the same thing..

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

speednumberOptional

0.5

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_set_replay_speed

HTTPcURLJavaScriptPython

GET /api/command/replay_set_replay_speed HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_set_replay_speed",
    "error": "invalid params",
    "reply": "replay_set_replay_speed",
    "success": true
  }
}

replay_set_scrub_position

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_set_scrub_position

If in replay mode, sets the scrub position according to seconds in the replay buffer. If the replay buffer is 20 seconds long, a position value of 10 will put the scrub bar in the center of the buffer..

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

positionnumberOptional

10.3

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_set_scrub_position

HTTPcURLJavaScriptPython

GET /api/command/replay_set_scrub_position HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_set_scrub_position",
    "reply": "replay_set_scrub_position",
    "success": true
  }
}

replay_set_settings

get

http://{captivate_ip}:{port}https://controllers.newbluefx.com/tunnel/{tunnel_id}

/api/command/replay_set_settings

Set new Instant Replay settings. Note: settings parameter should follow the same structure as the settings object from replay_get_settings.

Query parameters

requestIdstringOptional

optional id to track this command, will be returned in the response

settingsobjectOptional

{'armedPortList': [], 'bufferLength': 15, 'muteGraphicsOnReplay': True, 'playSpeed': 0.5, 'transIn': '', 'transOut': '', 'usesExternalSwitcher': False}

Responses

200

successful operation

application/json

400

bad request

get

/api/command/replay_set_settings

HTTPcURLJavaScriptPython

GET /api/command/replay_set_settings HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*

{
  "result": {
    "command": "replay_set_settings",
    "reply": "replay_set_settings",
    "success": true
  }
}