Initializing a Meeting - iOS
config()
Before initializing the meeting, you will need to first provide token
. Please refer this documentation to generate a token.
//meeting configuration using VideoSDK
VideoSDK.config("<your token>");
You can initialize the meeting using a factory method provided by the SDK called initMeeting()
. By passing the parameters according to the need, it will generate a new Meeting
class and the initiated meeting will be returned.
initMeeting()
let meeting = VideoSDK.initMeeting(
meetingId: "abcd-efgh-xyzw",
participantId: "JD", // optional
participantName: "John Doe",
micEnabled: true,
webcamEnabled: true
customCameraVideoStream: customVideoStream, //optional
mode: .CONFERENCE //optional (default mode is conference)
);
Meeting Initialization Parameters
meetingId
Unique Id of the meeting where that participant will be joining.
- type :
String
REQUIRED
- type :
Please refer this documentation to create a room.
participantId
Unique Id of the participant. If not passed then SDK will create an Id by itself and will use that id.
- type :
String
OPTIONAL
- type :
participantName
Name of the participant who will be joining the meeting, this name will be displayed to other participants in the same meeting.
- type :
String
REQUIRED
- type :
micEnabled
Whether
mic
of the participant will be on while joining the meeting. If it is set tofalse
, then mic of that participant will bedisabled
by default, but can beenabled
ordisabled
later.- type:
Boolean
- defaultValue : true
OPTIONAL
- type:
webcamEnabled
Whether
webcam
of the participant will be on while joining the meeting. If it is set tofalse
, then webcam of that participant will bedisabled
by default, but can beenabled
ordisabled
later.- type:
Boolean
- defaultValue : true
OPTIONAL
- type:
customTracks:
If you want to set the initial custom tracks, then you can pass map of custom tracks in this paramater.
- It has to be of
CustomRTCMediaStream
type. - defaultValue :
nil
OPTIONAL
- It has to be of
mode:
There are 2 types of modes:
CONFERENCE
: Both audio and video streams will be produced and consumed in this mode.VIEWER
: Audio and video streams will not be produced or consumed in this mode.
It has to be of
String
type.If you passed
null
then by default VideoSDK will setCONFERENCE
mode.
Returns
meeting
- After initializing the meeting,
initMeeting()
will return a newMeeting
instance.
Got a Question? Ask us on discord