LiveKit Swift Client SDK Documentation

Class Connect​Options 

@objc
public class ConnectOptions: NSObject

Options used when establishing a connection.

%133 ConnectOptions ConnectOptions NSObject NSObject ConnectOptions->NSObject

Conforms To

NSObject

Initializers

init() 

@objc
    public override init()

init(auto​Subscribe:​rtc​Configuration:​publish​Only​Mode:​protocol​Version:​) 

@objc
    public init(autoSubscribe: Bool = true,
                rtcConfiguration: RTCConfiguration? = nil,
                publishOnlyMode: String? = nil,
                protocolVersion: ProtocolVersion = .v8)

Properties

auto​Subscribe 

@objc
    public let autoSubscribe: Bool

Automatically subscribe to RemoteParticipant's tracks. Defaults to true.

rtc​Configuration 

@objc
    public let rtcConfiguration: RTCConfiguration

publish​Only​Mode 

@objc
    public let publishOnlyMode: String?

Providing a string will make the connection publish-only, suitable for iOS Broadcast Upload Extensions. The string can be used to identify the publisher.

protocol​Version 

@objc
    public let protocolVersion: ProtocolVersion

LiveKit server protocol version to use. Generally, it's not recommended to change this.

hash 

public override var hash: Int

Methods

copy​With(auto​Subscribe:​rtc​Configuration:​protocol​Version:​) 

func copyWith(autoSubscribe: Bool? = nil,
                  rtcConfiguration: RTCConfiguration? = nil,
                  protocolVersion: ProtocolVersion? = nil) -> ConnectOptions

is​Equal(_:​) 

public override func isEqual(_ object: Any?) -> Bool