Protocol
RealtimeSDKProtocol
public protocol RealtimeSDKProtocol: AnyObject Relationships
Conforms To
AnyObject
Requirements
onRoomInitialized(room:)
func onRoomInitialized(room: Room) Joined the the room
Parameters
| Name | Type | Description |
|---|---|---|
| room | Room |
room with roomId, name, remote participants list etc., |
onRoomInitError(error:)
func onRoomInitError(error: Error) Error encountered while joining the room
Parameters
| Name | Type | Description |
|---|---|---|
| error | Error |
description of the error |
onRoomLeft(room:)
func onRoomLeft(room: Room) Raised when local participant successfully left room.
Parameters
| Name | Type | Description |
|---|---|---|
| room | Room |
room description |
onParticipantJoined(room:participant:)
func onParticipantJoined(room: Room, participant: RemoteParticipant) Raised when a remote participant joined the room. Even though the participant has successfully joined, its media stream is not yet being streamed. The onRemoteStreamUpdated will indicate that.
Parameters
| Name | Type | Description |
|---|---|---|
| room | Room |
room description |
| participant | RemoteParticipant |
remote participant |
onParticipantLeft(room:participant:)
func onParticipantLeft(room: Room, participant: RemoteParticipant) Participant left event.
Parameters
| Name | Type | Description |
|---|---|---|
| room | Room |
room description |
| participant | RemoteParticipant |
Remote participant |
onLocalStreamUpdated(room:participant:)
func onLocalStreamUpdated(room: Room, participant: LocalParticipant) Raised when the local stream is added, removed or changed.
Parameters
| Name | Type | Description |
|---|---|---|
| room | Room |
room description |
| participant | LocalParticipant |
Local participant |
onRemoteStreamUpdated(room:participant:)
func onRemoteStreamUpdated(room: Room, participant: RemoteParticipant) Raised when the remote stream is added, removed or changed.
Parameters
| Name | Type | Description |
|---|---|---|
| room | Room |
Room |
| participant | RemoteParticipant |
Remote participant |