livekit-android-sdk/io.livekit.android.room/ClientProtocolVersion

ClientProtocolVersion

enum ClientProtocolVersion : Enum<ClientProtocolVersion>

The protocol version this SDK advertises to peers (other participants) for client-to-client feature negotiation (RPC v2, etc.). Distinct from ProtocolVersion, which tracks the signaling protocol between client and server.

Sent to the server during the join handshake via the client_protocol connection query parameter and ClientInfo.client_protocol; the server then populates ParticipantInfo.client_protocol for other peers in the room to read.

Entries

DEFAULT

Initial client protocol. RPC v1 only (15 KB packet payload limit).

DATA_STREAM_RPC

RPC v2: request and success-response payloads are carried over text data streams instead of inline packets, lifting the 15 KB payload limit.

DATA_STREAM_V2

Data streams v2: the client understands single-packet data streams, where a small finite payload is carried inline in the stream header rather than as separate chunk and trailer packets.

Properties

entries

val entries: EnumEntries<ClientProtocolVersion>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

value

val value: Int

Functions

valueOf

fun valueOf(value: String): ClientProtocolVersion

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<ClientProtocolVersion>

Returns an array containing the constants of this enum type, in the order they're declared.