SippoConference
public protocol SippoConference
Represents a conference
-
True if the user was invited to the room
Declaration
Swift
var invited: Bool
-
Delegate to manage SippoConference changes
Declaration
Swift
var delegate: SippoConferenceDelegate?
-
Current remote participants in SippoConference
Declaration
Swift
var remoteParticipants: [String]
-
Current participants with their shared constraints
Declaration
Swift
var remoteParticipantsConstraints: [String: [ConferenceConstraint]]
-
Allows the user to join the conference.
Declaration
Swift
func join(for constraints: [ConferenceConstraint]?,
Parameters
constraints
List of media that the user wants to share.
configuration
Provides info about fps,format,camera position and codes used in conference
task
Async result
-
Invite a participant to the conference
Declaration
Swift
func invite(participant: String, for constraints: [ConferenceConstraint], invitationID: String?,
Parameters
participant
Participant to invite
constraints
List of media that the caller wants the participant to share. The participant can accept it or provide another one when joining to or updating the conference.
invitationID
Provide invitationID if the invite is an InvitationRequest answer
task
Async result
-
Cancel an invitation to participant
Declaration
Swift
func cancelInvitation(for participant: String)
-
Expel a participant from a conference
Declaration
Swift
func expel(participant: String, task: @escaping (SippoTask<Bool, ConferenceError>) -> ())
Parameters
participant
Participant to expel
task
Async result
-
Leave a conference
Declaration
Swift
func leave(task: ((SippoTask<Bool, ConferenceError>) -> ())?)
Parameters
task
Async result
-
Decline an invitation
Declaration
Swift
func declineInvitation()
-
Update a conference with new media, this override current media
Declaration
Swift
func update(constraints: [ConferenceConstraint], task: @escaping (SippoTask<Bool, ConferenceError>) -> ())
Parameters
constraints
New shared media
-
Start recording conference
Declaration
Swift
func startRecording(task: @escaping (SippoTask<Bool, ConferenceError>) -> ())
Parameters
task
Async result
-
Stop recording conference
Declaration
Swift
func stopRecording(task: @escaping (SippoTask<Bool, ConferenceError>) -> ())
Parameters
task
Async result
-
View rendering local video if user is sharing video
Declaration
Swift
func userView(frame rect: CGRect) -> UIView?
Parameters
rect
Rect for UIView
Return Value
UIView rendering local video
-
View rendering remote video if participant is sharing video
Declaration
Swift
func viewFor(participant: String, frame rect: CGRect) -> UIView?
Parameters
participant
Participant
rect
Rect for UIView
Return Value
UIView rendering participant video
-
join(task:)
Extension methodAllows the user to join the conference. If user was invited takes media constraints from invitation, in other case video and audio is set as default.
- task: Async result
Declaration
Swift
func join(task: @escaping (SippoTask<Bool, ConferenceError>) -> ())