Skip to main content

Module prelude

Module prelude 

Source
Expand description

use livekit::prelude::*; to import livekit types

Re-exports§

pub use crate::ConnectionState;
pub use crate::DataPacket;
pub use crate::DataPacketKind;
pub use crate::Room;
pub use crate::RoomError;
pub use crate::RoomEvent;
pub use crate::RoomOptions;
pub use crate::RoomResult;
pub use crate::RoomSdkOptions;
pub use crate::SipDTMF;
pub use crate::Transcription;
pub use crate::TranscriptionSegment;

Structs§

AudioProcessingOptions
Configuration options for audio processing (AEC, AGC, NS).
DataTrackFrame
A frame published on a data track, consisting of a payload and optional metadata.
DataTrackInfo
Information about a published data track.
DataTrackOptions
Options for publishing a data track.
DataTrackSid
SFU-assigned identifier uniquely identifying a data track.
DataTrackStream
A stream of DataTrackFrames received from a RemoteDataTrack.
DataTrackSubscribeOptions
Options for subscribing to a data track.
LocalAudioTrack
LocalParticipant
LocalTrackPublication
LocalVideoTrack
ParticipantIdentity
ParticipantSid
PerformRpcData
Parameters for performing an RPC call
PlatformAudio
Platform audio device management for microphone capture and speaker playout.
PlayoutDeviceId
Unique identifier for a playout (speaker) device.
PlayoutDeviceInfo
Information about a playout (speaker) device.
PublishTimingEvent
Timestamped native local video publish pipeline event.
PublishTimingEventStream
A stream of native local video publish-pipeline timing events.
PublishingLayer
A simulcast layer currently configured on a local video publisher.
PushFrameError
Frame could not be pushed to a data track.
RecordingDeviceId
Unique identifier for a recording (microphone) device.
RecordingDeviceInfo
Information about a recording (microphone) device.
RemoteAudioTrack
RemoteDataTrackPipelineOptions
Track-level options that configure how the incoming-frame pipeline reassembles packets for a RemoteDataTrack.
RemoteParticipant
RemoteTrackPublication
RemoteVideoTrack
RoomSid
RpcError
Specialized error handling for RPC methods.
RpcInvocationData
Data passed to method handler for incoming RPC invocations
SubscribeTimingEvent
Timestamped native remote video subscribe pipeline event.
SubscribeTimingEventStream
A stream of native remote video subscribe-pipeline timing events.
TrackDimension
TrackSid

Enums§

AudioError
Errors that can occur during audio operations.
AudioProcessingType
The type of audio processing being used.
AudioTrack
AudioTrackFeature
ConnectionQuality
DataTrackSubscribeError
DisconnectReason
LocalTrack
PacketTrailerFeature
Participant
PublishError
An error that can occur when publishing a data track.
PublishTimingStage
Stage reached by a native local video frame in the publish pipeline.
PublishingLayerQuality
Video quality for a publishing layer.
PushFrameErrorReason
Reason why a data track frame could not be pushed.
RemoteTrack
RpcErrorCode
RtcAudioSource
Audio source type for creating audio tracks.
StreamState
SubscribeTimingStage
Stage reached by a native remote video frame in the subscribe pipeline.
Track
TrackKind
TrackPublication
TrackSource
VideoTrack

Type Aliases§

AudioResult
Result type for audio operations.
LocalDataTrack
Data track published by the local participant.
RemoteDataTrack
Data track published by a remote participant.