Rally Client

HTTP client for communicating with a local rally companion server. Sends recording cut commands and retrieves transcription results via REST API on localhost:27872.

Public API

Internals

Response Format

All API calls return a table with:

• ok - true on success, false on error
• error - error code/message string on failure
• client_msg - user-facing error message

Internal Helpers

How It Works

1. Uses socket.http module with a 0.5s timeout for non-blocking behavior
2. transcribe_recording_cut() POSTs to /recordings/actions/cut - tells the companion to cut and transcribe a recording segment
3. transcribe_transcripts_get(count) GETs from /transcripts/<count> - retrieves recent transcription results
4. Non-200 responses return {ok = false, error = <code>} with client_msg set

Usage Examples

local client = require('/lua/ge/extensions/gameplay/rally/client')

-- Cut the current recording
local resp = client.transcribe_recording_cut({ position = {x=100, y=200, z=50} })
if resp.ok then
  -- cut successful
end

-- Get latest transcriptions
local transcripts = client.transcribe_transcripts_get(5)

Notes

• The companion server is an external process (Python-based) that handles audio recording and speech-to-text
• Several endpoints are defined but commented out: recording_start, recording_stop, remote_audio_play_file, remote_audio_reset, remote_audio_queue_size
• Uses ltn12.sink.table and ltn12.source.string for HTTP body handling
• Short timeout prevents blocking the game loop if the server is unavailable

See Also

• Rally Audio Manager - Related reference
• Rally Camera Path Player - Related reference
• Rally Cut Capture - Related reference
• Gameplay Systems Guide - Guide