Skip to main content

Module api

Module api 

Source
Expand description

Public API re-exported by client SDKs (surfaced to end users through the livekit crate).

Structs§

ByteStreamInfo
Information about a byte data stream.
ByteStreamReader
Reader for an incoming byte data stream.
ByteStreamWriter
Writer for an open byte data stream.
SendByteOptions
Options for send_bytes and send_file.
SendError
Error returned by the packet transport when a data-stream packet fails to send.
SendTextOptions
Options for send_text. Progress is reported once after the complete send is acknowledged.
StreamByteOptions
Options for stream_bytes, which never compresses or inlines content.
StreamCloser
Ends an incoming stream from outside its reader, for example while another task reads it.
StreamProgress
Progress of a data stream.
StreamProgressCallback
Receives outgoing send progress on the thread polling the send; callbacks should return quickly.
StreamTextOptions
Options for stream_text, which never compresses or inlines content.
TextStreamInfo
Information about a text data stream.
TextStreamReader
Reader for an incoming text data stream.
TextStreamWriter
Writer for an open text data stream.

Enums§

AnyStreamReader
OperationType
Operation type for text streams.
StreamError
Error type for data stream operations.

Traits§

StreamReader
Reader for an incoming data stream.
StreamWriter
Writer for an open data stream.

Type Aliases§

StreamResult
Result type for data stream operations.