LiveKit Swift Client SDK Documentation

Classes

LKSample​Handler
Room
Live​Kit

The open source platform for real-time communication.

Local​Participant
Participant
Remote​Participant
Local​Track​Publication
Remote​Track​Publication
Track​Publication
Multicast​Delegate

A class that allows to have multiple delegates instead of one.

Native​View

A simple abstraction of a View that is native to the platform. When built for iOS this will be a UIView. When built for macOS this will be a NSView.

Observable​Participant
Observable​Room
Audio​Manager
Buffer​Capturer

A VideoCapturer that can capture CMSampleBuffers.

Camera​Capturer
InApp​Screen​Capturer
Mac​OSScreen​Capturer
Mac​OSRunning​Application
Mac​OSWindow
Mac​OSDisplay
Video​Capturer
Local​Audio​Track
Local​Video​Track
Remote​Audio​Track
Remote​Video​Track
Track
Video​Capture​Interceptor
Audio​Encoding
Dimensions
Camera​Capture​Options
Screen​Share​Capture​Options
Buffer​Capture​Options
Audio​Capture​Options
Connect​Options

Options used when establishing a connection.

Video​Publish​Options
Audio​Publish​Options
Data​Publish​Options
Room​Options
Participant​Permissions
Participant​Track​Permission
Track​Stats
Video​Encoding
Video​Parameters
Video​View

Structures

Engine.​State
IPCMessage
IPCMessage.​Buffer
IPCMessage.​Buffer.​Video
IPCMessage.​Buffer.​Audio​App
IPCMessage.​Buffer.​Audio​Mic
Stopwatch
Stopwatch.​Entry
Swift​UIVideo​View

A VideoView that can be used in SwiftUI. Supports both iOS and macOS.

Audio​Manager.​State

Enumerations

Room​Error
Internal​Error
Engine​Error
Track​Error
Signal​Client​Error
Network​Error
Transport​Error
Connection​State​Obj​C
IPCMessage.​One​Of_Type
IPCMessage.​Buffer.​One​Of_Type
Subscription​State
Dispatch​Queue​Timer.​State
Audio​Manager.​Track​State
Screen​Share​Source
Mac​OSScreen​Capture​Preferred​Method
Mac​OSScreen​Capture​Method
Mac​OSScreen​Share​Source​Type
Video​Capturer.​Capturer​State
Track.​Kind
Track.​Track​State
Track.​Source
Track.​Publish​State
Connection​Quality
Reconnect​Mode
Connection​State
Disconnect​Reason
Reliability
Simulate​Scenario
Protocol​Version
Track​Publish​State

A enum that represents the published state of a LocalTrackPublication.

Stream​State
Video​View.​Layout​Mode

Specifies how to render the video withing the VideoView's bounds.

Video​View.​Mirror​Mode

Protocols

Live​Kit​Error
Loggable

Allows to extend with custom log method which automatically captures current type (class name).

Media​Encoding
Participant​Delegate

Delegate methods for a participant.

Room​Delegate​Obj​C

RoomDelegate receives room events as well as Participant events.

Room​Delegate
Track​Delegate
Video​Renderer
Video​View​Delegate
Audio​Track
Mac​OSScreen​Capture​Source
Video​Capturer​Protocol
Video​Capturer​Delegate
Local​Track
Remote​Track
Video​Track
Capture​Options
Video​Capture​Options
Publish​Options

Typealiases

Should​Configure​Audio​Session​Func

Function type for LiveKit.onShouldConfigureAudioSession.

Scoped​Metadata
Native​View​Type
Native​View​Type
Native​View​Representable​Type
Native​View​Representable​Type
Capture​Func
Intercept​Func
Sid
Video​Rotation
Native​Renderer​View

A NativeViewType that conforms to RTCVideoRenderer.

Extensions

AVCaptureDevice.Position
CGImage
CGImagePropertyOrientation
CIImage
CMSampleBuffer
CVPixelBuffer
Data
Double
RTCConfiguration
RTCDataChannelState
RTCPeerConnectionState
RTCRtpEncodingParameters
RTCVideoCapturerDelegate