Skip to main content
Version: 3.0.14

Replay

note

This resource allows user to control recording and replay. Detailed behavior of each command is described below.

GET​

/internal/commands/replay​

  • Return a list of all replay files in the current project.

  • Parameters
    • N/A
  • Return code
    • 200 OK

  • Example

$ curl -X GET 'http://localhost:9080/internal/commands/replay'
** Respond **
[
    "my-first-replay",
    "my-second-replay"
]

/internal/commands/replay-detail​

  • Return detailed information of the current running replay file. This will not return anything unless you are in replay mode and a replay is loaded.

  • Parameters
    • N/A
  • Return code
    • 200 OK
    • 400 BAD REQ

  • Example

$ curl -X GET 'http://localhost:9080/internal/commands/replay-detail'
** Respond **
{
    "frame_counts": 91,
    "curr_frame": 27
}

POST​

/internal/commands/replay/start​

  • Start playing the current replay file.

  • Parameters
    • name : Replay file name.
  • Return code
    • 200 OK
    • 400 BAD REQ
    • 500 INTERNAL SERVER ERR

  • Example

$ curl -X POST 'http://localhost:9080/internal/commands/replay/start?name=my-replay'

/internal/commands/replay/stop​

  • Stop playing the current replay file

  • Parameters
    • N/A
  • Return code
    • 200 OK
    • 400 BAD REQ

  • Example

$ curl -X POST 'http://localhost:9080/internal/commands/replay/stop'

/internal/commands/replay/pause​

  • Pause playing the current replay file (assuming it isn't already paused).

  • Parameters
    • N/A
  • Return code
    • 200 OK
    • 400 BAD REQ

  • Example

$ curl -X POST 'http://localhost:9080/internal/commands/replay/pause'

/internal/commands/replay/resume​

  • Resume playing the current replay file (assuming it is paused).

  • Parameters
    • N/A
  • Return code
    • 200 OK
    • 400 BAD REQ

  • Example

$ curl -X POST 'http://localhost:9080/internal/commands/replay/resume'

/internal/commands/replay/frame​

  • Jump to a specific frame in the replay.

  • Parameters
    • frame : Frame index to move.
  • Return code
    • 200 OK
    • 400 BAD REQ

  • Example

$ curl -X POST 'http://localhost:9080/internal/commands/replay/frame?frame=42'

DELETE​

/internal/commands/replay​

  • Delete a replay file.

  • Parameters
    • name : Replay file name.
  • Return code
    • 200 OK
    • 400 BAD REQ

  • Example

$ curl -X DELETE 'http://localhost:9080/internal/commands/replay?name=my-replay'

Logo
If you need access, please contact