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

Package-level declarations

Types

DataTrackFrame

class DataTrackFrame(val payload: ByteArray, val userTimestamp: Long? = null)

A single unit of application data sent or received over a data track.

DataTrackFrameEncoding

sealed class DataTrackFrameEncoding

Encoding of the frames sent over a data track.

DataTrackFrameFormat

data class DataTrackFrameFormat(val frameEncoding: DataTrackFrameEncoding, val schema: DataTrackSchemaId? = null)

Describes the frames on a data track.

DataTrackInfo

data class DataTrackInfo(val sid: DataTrackSid, val name: String, val usesE2ee: Boolean, val schema: DataTrackSchemaId?, val frameEncoding: DataTrackFrameEncoding?)

Metadata describing a published data track.

DataTrackPublishException

sealed class DataTrackPublishException : Exception

An error raised while publishing a LocalDataTrack.

DataTrackPublishOptions

data class DataTrackPublishOptions(val frameFormat: DataTrackFrameFormat? = null)

Options for publishing a data track.

DataTrackPushFrameException

sealed class DataTrackPushFrameException : Exception

The reason a frame could not be pushed via LocalDataTrack.tryPush.

DataTrackSchemaEncoding

sealed class DataTrackSchemaEncoding

Encoding of a data track schema definition.

DataTrackSchemaException

sealed class DataTrackSchemaException : Exception

An error raised while storing or resolving a data track schema via io.livekit.android.room.participant.LocalParticipant.defineSchema / io.livekit.android.room.participant.LocalParticipant.getSchema.

DataTrackSchemaId

data class DataTrackSchemaId(val name: String, val encoding: DataTrackSchemaEncoding)

Identifies the schema describing a data track's frames.

DataTrackSid

@Serializable

@JvmInline

value class DataTrackSid(val value: String)

A server-assigned data track identifier.

DataTrackStream

class DataTrackStream : AutoCloseable

A stream of frames received from a subscribed RemoteDataTrack.

DataTrackSubscribeException

sealed class DataTrackSubscribeException : Exception

An error raised while subscribing to a RemoteDataTrack.

IncomingDataTrackManager

interface IncomingDataTrackManager

LocalDataTrack

class LocalDataTrack : DataTrackFrameSink

A data track published by the local participant. Obtain one from io.livekit.android.room.participant.LocalParticipant.publishDataTrack, then push frames with tryPush or send.

RemoteDataTrack

class RemoteDataTrack

A data track published by a remote participant.