Synaptic.Voice (synaptic v0.3.0-alpha.12)

View Source

Unified voice session API for headless and realtime integrations.

OpenAI realtime sessions preserve legacy behavior unless callers pass experience: :realtime_2_1 or a non-nil profile:. Explicit experience selection always wins.

GPT-Live is opt-in with mode: :realtime, experience: :live. Supply the browser's SDP offer in provider_opts: [realtime: [sdp: offer]]. Its transport returns an SDP answer instead of a client secret. See docs/voice-live.md.

Summary

Functions

approve_capability(session_id, capability_name)

Grants one-shot approval for a capability that emitted :capability_confirmation_required in this session.

attach_run(run_id, opts \\ [])
cancel_output(session_id)
client_connected(session_id, meta \\ %{})
client_disconnected(session_id, meta \\ %{})
end_turn(session_id, opts \\ [])
ingest_provider_event(session_id, payload)
inspect_session(session_id)
playback_drained(session_id)
push_audio(session_id, audio_chunk, opts \\ [])
push_text(session_id, text, opts \\ [])
start_session(workflow_module, input \\ %{}, opts \\ [])
stop_session(session_id, reason \\ :normal)
subscribe_session(session_id)
unsubscribe_session(session_id)

Functions

approve_capability(session_id, capability_name)

Grants one-shot approval for a capability that emitted :capability_confirmation_required in this session.

attach_run(run_id, opts \\ [])

@spec attach_run(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

cancel_output(session_id)

client_connected(session_id, meta \\ %{})

client_disconnected(session_id, meta \\ %{})

end_turn(session_id, opts \\ [])

ingest_provider_event(session_id, payload)

inspect_session(session_id)

playback_drained(session_id)

push_audio(session_id, audio_chunk, opts \\ [])

@spec push_audio(binary(), any(), any()) :: any()

push_text(session_id, text, opts \\ [])

start_session(workflow_module, input \\ %{}, opts \\ [])

@spec start_session(module(), map(), keyword()) :: {:ok, map()} | {:error, term()}

stop_session(session_id, reason \\ :normal)

subscribe_session(session_id)

unsubscribe_session(session_id)