Skip to content

RAPD TCP protocol reference

Note

Read the connection guide to find out how to create a connection to the RAPD tcp server.

Note

Find a list of player states in the player states list

Ping packet

{
  "command": "ping",
  "params": [],
  "client_name": "test"
}

{
  "message": "RAPD server is up! pong",
  "timestamp": "000",
  "failed": false
}

Play file packet

{
  "command": "play_file",
  "params": ["file_path", "should_loop"],
  "client_name": "test"
}

{
  "message": "Started audio playback",
  "timestamp": "000",
  "failed": false
}

Player state packet

{
  "command": "player_state",
  "params": [],
  "client_name": "test"
}

{
  "message": "[PLAYER STATE IS HERE]",
  "timestamp": "000",
  "failed": false
}

Player stop packet

{
  "command": "player_stop",
  "params": [],
  "client_name": "test"
}

{
  "message": "Stopped player",
  "timestamp": "000",
  "failed": false
}

Player toggle pause packet

{
  "command": "player_toggle_pause",
  "params": [],
  "client_name": "test"
}

{
  "message": "Toggled pause for player, is_paused = true/false",
  "timestamp": "000",
  "failed": false
}

Player length packet

{
  "command": "player_length",
  "params": [],
  "client_name": "test"
}

{
  "message": {
    "hour": 0,
    "min": 0,
    "second": 0
  },
  "timestamp": "000",
  "failed": false
}

Player time packet

{
  "command": "player_time",
  "params": [],
  "client_name": "test"
}

{
  "message": {
    "hour": 0,
    "min": 0,
    "second": 0
  },
  "timestamp": "000",
  "failed": false
}

Player file packet

{
  "command": "player_file",
  "params": [],
  "client_name": "test"
}

{
  "message": "/path/to/file",
  "timestamp": "000",
  "failed": false
}