Skip to main content
Version: 1.2.x

Meeting Class Methods

join()

  • It is used to join a meeting.
  • After meeting initialization by initMeeting() it returns a new instance of Meeting. However by default, it will not automatically join the meeting. Hence, to join the meeting you should call join().

Events associated with join():

  • Local Participant will receive a onMeetingJoined event, when successfully joined.
  • Remote Participant will receive a [addParticipant] event with the newly joined Participant object from the event callback.

Returns

  • void

leave()

  • It is used to leave the current meeting.

Events associated with leave():

Returns

  • void

end()

  • It is used to end the current running session.
  • By calling end(), all joined participants including localParticipant of that session will leave the meeting.

Events associated with end():

Returns

  • void

enableWebcam()

Returns

  • void

disableWebcam()

Returns

  • void

unmuteMic()

Returns

  • void

muteMic()

Returns

  • void

startRecording()

Parameters

  • webhookUrl: String

Returns

  • void

Example

let webhookUrl = "https://webhook.your-api-server.com"

startRecording(webhookUrl: webhookUrl!)

stopRecording()

Returns

  • void

Example

stopRecording()

startLivestream()

  • It is used to start meeting livestreaming.
  • You will be able to start live stream meetings to other platforms such as Youtube, Facebook, etc. that support RTMP streaming.
  • All participants and localParticipant, will receive onLivestreamStarted event.

Parameters

  • outputs: [LivestreamOutput]

Returns

  • void

Example


startLivestream(outputs: outputs)

stopLivestream()

Returns

  • void

Example

stopLivestream();