Session
Last updated
Last updated
Return type | Methods | Description | Parameters |
---|---|---|---|
Return type
Method
Description
Params
init()
The default initializer
SessionBuilder
withUsername(_ username: String) -> SessionBuilder
Specify the username
username - a display name
SessionBuilder
withDelegate(_ delegate: SessionDelegate) -> SessionBuilder
Subscribe a delegate for receiving callbacks
delegate - an instance for reporting callbacks
SessionBuilder
withCallbackQueue(_ queue: DispatchQueue) -> SessionBuilder
Register a queue for receiving callbacks
queue - a dispatch queue for reporting callbacks
SessionBuilder
withVideoCodec(_ codec: VideoCodec) -> SessionBuilder
Specify a video codec type
codec - a video codec type
SessionBuilder
withVideoRenderer(_ renderer: VideoRenderer) -> SessionBuilder
Specify a video renderer type
renderer - a video renderer type
Session
build() -> Session
Construct a session instance
LocalParticipant
localParticipant
Represents a local user
SessionDelegate?
delegate
An optional delegate for receiving callbacks
DispatchQueue
callbackQueue
A dispatch queue for receiving callbacks. The default queue is the main queue
SessionState
sessionState
Enum with current session state
void
connect(with token: String)
Connect a session
token - authentication token
void
disconnect()
Leave a room and teardown WebRTC session
UIViewController
createLogsViewController()
Return view controller with all Session logs
void
sendMessage(message: String)
sends message to all conference participants
message - text to send
void
forceDisconnect(participantId: String, message: String?)
kick partitipant by id from session
participantId -selected participant id
message - optional supplemental message(kick reason)
Return type
Methods
Description
Parameters
void
setMinLogLevel(_ logLevel: WTLogLevel)
Specify a log level
logLevel - a level for logs produced