rtvi-client-android/ai.rtvi.client.types

Package-level declarations

Types

@Serializable

data class ActionDescription(val service: String, val action: String, val arguments: List<OptionDescription>, val result: Type)

Config

data class Config(val config: List<ServiceConfig>)

MediaDeviceId

data class MediaDeviceId(val id: String)

A unique identifier for a media device.

MediaDeviceInfo

data class MediaDeviceInfo(val id: MediaDeviceId, val name: String)

Information about a media device.

MediaTrackId

data class MediaTrackId(val id: String)

An identifier for a media track.

Option

@Serializable

data class Option(val name: String, val value: Value)

OptionDescription

@Serializable

data class OptionDescription(val name: String, val type: Type)

Participant

data class Participant(val id: ParticipantId, val name: String?, val local: Boolean)

Information about a session participant.

ParticipantId

data class ParticipantId(val id: String)

A unique identifier for a session participant.

ParticipantTracks

data class ParticipantTracks(val audio: MediaTrackId?, val video: MediaTrackId?)

Media tracks associated with a participant.

PipecatMetrics

@Serializable

data class PipecatMetrics(val processing: List<PipecatMetricsData>? = null, val ttfb: List<PipecatMetricsData>? = null)

Metrics received from a Pipecat instance.

PipecatMetricsData

@Serializable

data class PipecatMetricsData(val processor: String, val value: Double)

Metrics data received from a Pipecat instance.

ServiceConfig

@Serializable

data class ServiceConfig(val service: String, val options: List<Option>)

ServiceConfigDescription

@Serializable

data class ServiceConfigDescription(val name: String, val options: List<OptionDescription>)

ServiceRegistration

@Serializable

data class ServiceRegistration(val service: String, val value: String)

Tracks

data class Tracks(val local: ParticipantTracks, val bot: ParticipantTracks?)

Media tracks for the local user and remote bot.

Transcript

@Serializable

data class Transcript(val text: String, val final: Boolean, val timestamp: String, val userId: String)

A written transcript of some spoken words.

TransportState

enum TransportState : Enum<TransportState>

The current state of the session transport.

Type

@Serializable

enum Type : Enum<Type>

Value

@Serializable(with = ValueSerializer::class)

sealed interface Value