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.
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.
optional id to track this command, will be returned in the response
['USB Camera VID:1133 PID:2075']
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
}
}Get a list of all the available replay commands..
optional id to track this command, will be returned in the response
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
}
}Removes an input from the armed inputs list. If there are no armed inputs, the Instant Replay will be disabled..
optional id to track this command, will be returned in the response
['USB Camera VID:1133 PID:2075']
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
}
}Does the same as starting the instant replay if there are any armed inputs..
optional id to track this command, will be returned in the response
0.5
GET /api/command/replay_enable HTTP/1.1
Host: 127.0.0.1:9022
Accept: */*
{
"result": {
"command": "replay_enable",
"reply": "replay_enable",
"success": true
}
}Turn scrubbing on or off. Note: When set to true will leave recording mode and enter replay mode..
optional id to track this command, will be returned in the response
True
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
}
}Enters Instant Replay playback mode if it is enabled..
optional id to track this command, will be returned in the response
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
}
}Exits Instant Replay playback mode..
optional id to track this command, will be returned in the response
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
}
}Get a list of available inputs that can be used for Instant Replay.
optional id to track this command, will be returned in the response
0.5
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
}
}Get some statistics about the current Instant Replay playback..
optional id to track this command, will be returned in the response
['USB Camera VID:1133 PID:2075']
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
}
}Get the current replay speed..
optional id to track this command, will be returned in the response
0.5
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
}
}Get the current settings. Callback will have a settings object..
optional id to track this command, will be returned in the response
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
}
}Get a boolean value indicating if Instant Replay has been properly licensed. Returns an object with a boolean named isTrial.
optional id to track this command, will be returned in the response
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
}
}If in replay mode, does the same as clicking the play arrow..
optional id to track this command, will be returned in the response
True
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
}
}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..
optional id to track this command, will be returned in the response
10.3
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
}
}Set the Instant Replay play-out point. Same as above..
optional id to track this command, will be returned in the response
10.3
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
}
}Change the replay speed.Note: The settings object uses playSpeed but this command uses speed to mean the same thing..
optional id to track this command, will be returned in the response
0.5
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
}
}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..
optional id to track this command, will be returned in the response
10.3
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
}
}Set new Instant Replay settings. Note: settings parameter should follow the same structure as the settings object from replay_get_settings.
optional id to track this command, will be returned in the response
{'armedPortList': [], 'bufferLength': 15, 'muteGraphicsOnReplay': True, 'playSpeed': 0.5, 'transIn': '', 'transOut': '', 'usesExternalSwitcher': False}
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
}
}Last updated