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

initialize

  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

config

 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 new Meeting class and the initiated meeting will be returned.

initMeeting

   VideoSDK.initMeeting(
        Context context,
        String meetingId,
        String name,
        boolean micEnabled,
        boolean webcamEnabled,
        String participantId,
        String mode,
        boolean multiStream,
        Map<String, CustomStreamTrack> customTracks
        JSONObject metaData,
        String signalingBaseUrl,
        PreferredProtocol preferredProtocol
      )

Parameters

context

• Context of activity.

  • type : Context
  • REQUIRED

meetingId

• Unique Id of the meeting where that participant will be joining.

  • type : String
  • REQUIRED

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 to false, then mic of that participant will be disabled by default, but can be enabled or disabled later.

  • type: Boolean
  • REQUIRED

webcamEnabled

• Whether webcam of the participant will be on while joining the meeting. If it is set to false, then webcam of that participant will be disabled by default, but can be enabled or disabled later.

  • type: Boolean
  • REQUIRED

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 or null
  • REQUIRED

Modes

There are three modes available:

• SEND_AND_RECV: In this mode, both audio and video streams will be produced and consumed.

• SIGNALLING_ONLY: In this mode, no audio or video streams will be produced or consumed. It is used solely for signaling.

• RECV_ONLY: This mode allows only the consumption of audio and video streams without producing any.

Type: String or null
Default Value: SEND_AND_RECV

info

Important Changes Android SDK in Version v0.2.0

• The following modes have been deprecated:
• CONFERENCE has been replaced by SEND_AND_RECV
• VIEWER has been replaced by SIGNALLING_ONLY

Please update your implementation to use the new modes.

⚠️ Compatibility Notice:
To ensure a seamless meeting experience, all participants must use the same SDK version.
Do not mix version v0.2.0 + with older versions, as it may cause significant conflicts.

multiStream

• It will specify if the stream should send multiple resolution layers or single resolution layer.

  • type: boolean
  • REQUIRED

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> or null
  • REQUIRED

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

signalingBaseUrl

• If you want to use a proxy server with the VideoSDK, you can specify your baseURL here.

  • type: String
  • OPTIONAL

note

If you intend to use a proxy server with the VideoSDK, priorly inform us at support@videosdk.live

preferredProtocol

• If you want to provide a preferred network protocol for communication, you can specify that in PreferredProtocol, with options including UDP_ONLY, UDP_OVER_TCP, and TCP_ONLY.

  • type: PreferredProtocol
  • OPTIONAL

Returns

meeting

• After initializing the meeting, initMeeting() will return a new Meeting instance.

---

Example

Kotlin

initMeeting

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
  )
)

Java

initMeeting

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,
  null
});