pipecat-client-android/ai.pipecat.client/RTVIClient

RTVIClient

open class RTVIClient(transport: TransportFactory, callbacks: RTVIEventCallbacks, options: RTVIClientOptions)

An RTVI client. Connects to an RTVI backend and handles bidirectional audio and video streaming.

The client must be cleaned up using the release method when it is no longer required.

Parameters

transport

Transport for media streaming.

callbacks

Callbacks invoked when changes occur in the voice session.

options

Additional options for configuring the client and backend.

Constructors

RTVIClient

constructor(transport: TransportFactory, callbacks: RTVIEventCallbacks, options: RTVIClientOptions)

Types

Companion

object Companion

Properties

expiry

val expiry: Long?

The expiry time for the transport session, if applicable. Measured in seconds since the UNIX epoch (UTC).

isCamEnabled

val isCamEnabled: Boolean

Returns true if the camera is enabled, false otherwise.

isMicEnabled

val isMicEnabled: Boolean

Returns true if the microphone is enabled, false otherwise.

selectedCam

val selectedCam: MediaDeviceInfo?

Returns the selected video input device.

selectedMic

val selectedMic: MediaDeviceInfo?

Returns the selected audio input device.

state

val state: TransportState

The current state of the session.

thread

val thread: ThreadRef

The thread used by the VoiceClient for callbacks and other operations.

tracks

val tracks: Tracks

Returns a list of participant media tracks.

Functions

action

fun action(service: String, action: String, arguments: List<Option> = emptyList()): Future<Value, RTVIError>

Instruct a backend service to perform an action.

connect

fun connect(): Future<Unit, RTVIError>

Initiate an RTVI session, connecting to the backend.

describeActions

fun describeActions(): Future<List<ActionDescription>, RTVIError>

Returns a list of supported actions.

describeConfig

fun describeConfig(): Future<List<ServiceConfigDescription>, RTVIError>

Returns the expected structure of the server config.

disconnect

fun disconnect(): Future<Unit, RTVIError>

Disconnect an active RTVI session.

enableCam

fun enableCam(enable: Boolean): Future<Unit, RTVIError>

Enables or disables the video input device.

enableMic

fun enableMic(enable: Boolean): Future<Unit, RTVIError>

Enables or disables the audio input device.

getAllCams

fun getAllCams(): Future<List<MediaDeviceInfo>, RTVIError>

Returns a list of available video input devices.

getAllMics

fun getAllMics(): Future<List<MediaDeviceInfo>, RTVIError>

Returns a list of available audio input devices.

getConfig

fun getConfig(): Future<Config, RTVIError>

Gets the current config from the server.

initDevices

fun initDevices(): Future<Unit, RTVIError>

Initialize local media devices such as camera and microphone.

registerHelper

fun <E : RTVIClientHelper> registerHelper(service: String, helper: E): E

Registers a new helper with the client.

release

fun release()

Destroys this VoiceClient and cleans up any allocated resources.

sendMessage

fun sendMessage(msg: MsgClientToServer): Future<Unit, RTVIError>

Directly send a message to the bot via the transport.

unregisterHelper

fun unregisterHelper(service: String)

Unregisters a helper from the client.

updateCam

fun updateCam(camId: MediaDeviceId): Future<Unit, RTVIError>

Use the specified video input device.

updateConfig

fun updateConfig(update: List<ServiceConfig>): Future<Config, RTVIError>

Updates the config on the server.

updateMic

fun updateMic(micId: MediaDeviceId): Future<Unit, RTVIError>

Use the specified audio input device.