Initializing a Meeting - Android
initialize()
To initialize the meeting, first you have to initialize the VideoSDK
.
You can initialize the VideoSDK
using initialize()
method provided by the SDK.
Parameters
- context: Context
Returns
void
VideoSDK.initialize(Context context)
config()
Now, you have to set token
property of VideoSDK
class.
By using config()
method, you can set the token
property of VideoSDK
class.
Please refer this documentation to generate a token.
Parameters
- token: String
Returns
void
VideoSDK.config(String token)
initMeeting()
- Now, you can initialize the meeting using a factory method provided by the SDK called
initMeeting()
. initMeeting()
will generate a newMeeting
class and the initiated meeting will be returned.
VideoSDK.initMeeting(
Context context,
String meetingId,
String name,
boolean micEnabled,
boolean webcamEnabled,
String participantId,
String mode,
boolean multiStream,
Map<String, CustomStreamTrack> customTracks
JSONObject metaData,
)
Parameters
context
Context of activity.
- type : Context
REQUIRED
meetingId
Unique Id of the meeting where that participant will be joining.
- type :
String
REQUIRED
- type :
Please refer this documentation to create a room.
name
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
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
REQUIRED
- 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
REQUIRED
- type:
participantId
Unique Id of the participant. If you passed
null
then SDK will create an Id by itself and will use that id.- type :
String
ornull
REQUIRED
- type :
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.
type :
String
ornull
defaultValue :
CONFERENCE
REQUIRED
multiStream
It will specify if the stream should send multiple resolution layers or single resolution layer.
- type:
boolean
REQUIRED
- type:
customTracks
If you want to use custom tracks from start of the meeting, you can pass map of custom tracks in this paramater.
- type :
Map<String, CustomStreamTrack>
ornull
REQUIRED
- type :
Please refer this documentation to know more about CustomTrack.
metaData
If you want to provide additional details about a user joining a meeting, such as their profile image, you can pass that information in this parameter.
- type:
JSONObject
REQUIRED
- type:
Returns
meeting
- After initializing the meeting,
initMeeting()
will return a newMeeting
instance.
Example
- Kotlin
- Java
VideoSDK.initialize(applicationContext)
// Configure the token
VideoSDK.config(token) // pass the token generated from VideoSDK Dashboard
// Initialize the meeting
var meeting = VideoSDK.initMeeting(
arrayOf(
this@MainActivity,
"abc-1234-xyz",
"John Doe",
true,
true,
null,
null,
false,
null,
null,
)
)
VideoSDK.initialize(getApplicationContext());
// Configure the token
VideoSDK.config(token); // pass the token generated from VideoSDK Dashboard
// Initialize the meeting
Meeting meeting = VideoSDK.initMeeting({
MainActivity.this,
"abc-1234-xyz",
"John Doe",
true,
true,
null,
null,
false,
null,
null,
});
Got a Question? Ask us on discord