us.zoom.sdk.MeetingService Interface Reference

ZOOM meeting service. More...

Public Member Functions
void	addListener (MeetingServiceListener listener)
void	removeListener (MeetingServiceListener listener)
int	startMeetingWithParams (Context context, StartMeetingParams param, MeetingOptions opts)
int	startInstantMeeting (Context context, MeetingOptions opts)
int	joinMeetingWithParams (Context context, JoinMeetingParams param, JoinMeetingOptions opts)
boolean	handZoomWebUrl (String meetingUrl)
MeetingStatus	getMeetingStatus ()
void	leaveCurrentMeeting (boolean endIfPossible)
void	pauseCurrentMeeting ()
void	resumeCurrentMeeting ()
void	returnToMeeting (Context context)
String	getCurrentRtcMeetingID ()
long	getCurrentRtcMeetingNumber ()
String	getCurrentMeetingUrl ()
boolean	isCurrentMeetingLocked ()
boolean	isCurrentMeetingHost ()
boolean	isInviteRoomSystemSupported ()
InviteRoomSystemHelper	getInviteRoomSystemHelper ()
PhoneHelper	getPhoneHelper ()
boolean	tryRetrieveMicrophone ()
void	removeMeetingNotification (Context context)
void	configDSCP (int audio, int video, boolean reset)
void	notifyVideoConfInstanceDestroyed ()

Static Public Attributes
static final int	USER_TYPE_API_USER = 0
static final int	USER_TYPE_ZOOM = 1
static final int	USER_TYPE_FACEBOOK = 2
static final int	USER_TYPE_GOOGLE_OAUTH = 3
static final int	USER_TYPE_SSO = 4
static final int	USER_TYPE_UNKNOWN = -1

Detailed Description

ZOOM meeting service.

Author

Rui YANG

Definition at line 11 of file MeetingService.java.

Member Function Documentation

addListener()

void us.zoom.sdk.MeetingService.addListener

(

MeetingServiceListener

listener

)

Register a listener for meeting service.

Parameters

listener

The listener instance.

configDSCP()

void us.zoom.sdk.MeetingService.configDSCP	(	int	audio,
		int	video,
		boolean	reset )

Configure DSCP(Differentiated Services Code Point) values.

Parameters

audio	Configure DSCP value for audio.
video	Configure DSCP value for video.
reset	Reset DSCP values.

getCurrentMeetingUrl()

String us.zoom.sdk.MeetingService.getCurrentMeetingUrl

(

)

Get the URL of the current meeting.

Returns

Current meeting URL.

getCurrentRtcMeetingID()

String us.zoom.sdk.MeetingService.getCurrentRtcMeetingID

(

)

Get the unique ID of current meeting, in format like DVLObefSZizM0xQLhtrCQ==

Returns

Current meeting ID.

getCurrentRtcMeetingNumber()

long us.zoom.sdk.MeetingService.getCurrentRtcMeetingNumber

(

)

Get current meeting number, in format like 123456789.

Returns

Current meeting number.

getInviteRoomSystemHelper()

InviteRoomSystemHelper us.zoom.sdk.MeetingService.getInviteRoomSystemHelper

(

)

Get the instance of InviteRoomSystemHelper.

Returns

The shared instance of InviteRoomSystemHelper.

getMeetingStatus()

MeetingStatus us.zoom.sdk.MeetingService.getMeetingStatus

(

)

Get the current meeting status.

Returns

The status value defined in MeetingStatus.

Referenced by us.zoom.sdk.ZoomSDKRenderer.subscribe().

getPhoneHelper()

PhoneHelper us.zoom.sdk.MeetingService.getPhoneHelper

(

)

Get the instance of PhoneHelper.

Returns

The shared instance of PhoneHelper.

handZoomWebUrl()

boolean us.zoom.sdk.MeetingService.handZoomWebUrl

(

String

meetingUrl

)

Start or join a ZOOM meeting with zoom web url

Parameters

meetingUrl

zoom web meeting url

Returns

TRUE Success.

isCurrentMeetingHost()

boolean us.zoom.sdk.MeetingService.isCurrentMeetingHost

(

)

Query if the current user is meeting host.

Returns

TRUE means that the current user is the meeting host. FALSE not.

isCurrentMeetingLocked()

boolean us.zoom.sdk.MeetingService.isCurrentMeetingLocked

(

)

Query if the current meeting is locked. Once the meeting is locked, other users out of the meeting can no longer join it.

Returns

TRUE means that the current meeting is locked. FALSE not.

isInviteRoomSystemSupported()

boolean us.zoom.sdk.MeetingService.isInviteRoomSystemSupported

(

)

Query if it is able to invite room system in the current meeting.

Returns

TRUE means able. FALSE not.

joinMeetingWithParams()

int us.zoom.sdk.MeetingService.joinMeetingWithParams	(	Context	context,
		JoinMeetingParams	param,
		JoinMeetingOptions	opts )

Start a ZOOM meeting with specified arguments.

Parameters

context	Android context.
param	Parameters to join meeting.
opts	Other options. It should be an instance of JoinMeetingOptions. Default options will be enabled if it is null.

Returns

Contents defined in MeetingError

leaveCurrentMeeting()

void us.zoom.sdk.MeetingService.leaveCurrentMeeting

(

boolean

endIfPossible

)

Leave the current meeting.

Parameters

endIfPossible

If it is TRUE and the current user is the meeting host, the meeting ends directly.

notifyVideoConfInstanceDestroyed()

void us.zoom.sdk.MeetingService.notifyVideoConfInstanceDestroyed

(

)

notify conf is destroyed

pauseCurrentMeeting()

void us.zoom.sdk.MeetingService.pauseCurrentMeeting

(

)

Pause the current meeting and mute microphone and speaker.

removeListener()

void us.zoom.sdk.MeetingService.removeListener

(

MeetingServiceListener

listener

)

Unregister the listener.

Parameters

listener

The listener instance.

removeMeetingNotification()

void us.zoom.sdk.MeetingService.removeMeetingNotification

(

Context

context

)

Remove the notification of meeting. Use for zoom integration UI Only.

resumeCurrentMeeting()

void us.zoom.sdk.MeetingService.resumeCurrentMeeting

(

)

Resume the current meeting. Call this function once you have called pauseCurrentMeeting.

returnToMeeting()

void us.zoom.sdk.MeetingService.returnToMeeting

(

Context

context

)

Place the meeting window to foreground. Do not use it in custom meeting UI solution.

Parameters

context

Android context.

startInstantMeeting()

int us.zoom.sdk.MeetingService.startInstantMeeting	(	Context	context,
		MeetingOptions	opts )

Start a ZOOM meeting with specified arguments for logged-in user.

Parameters

context	Android context.
opts	Other options. It should be an instance of MeetingOptions or InstantMeetingOptions. Default options will be enabled if it is null.

Returns

Contents defined in MeetingError.

startMeetingWithParams()

int us.zoom.sdk.MeetingService.startMeetingWithParams	(	Context	context,
		StartMeetingParams	param,
		MeetingOptions	opts )

Start a ZOOM meeting with specified parameters.

Parameters

context	Android context.
param	Parameters for starting a meeting, such as StartMeetingParams4NormalUser ,StartMeetingParamsWithoutLogin.
opts	Other options. It should be an instance of StartMeetingOptions. Default options will be enabled if it is null.

Returns

Contents defined in MeetingError.

tryRetrieveMicrophone()

boolean us.zoom.sdk.MeetingService.tryRetrieveMicrophone

(

)

Try to retrieve microphone in the meeting

Returns

TRUE means that API calls the function successfully. FALSE not.

Field Documentation

USER_TYPE_API_USER

final int us.zoom.sdk.MeetingService.USER_TYPE_API_USER = 0

static

API user.

Definition at line 16 of file MeetingService.java.

USER_TYPE_FACEBOOK

final int us.zoom.sdk.MeetingService.USER_TYPE_FACEBOOK = 2

static

User logins with Facebook account.

Definition at line 26 of file MeetingService.java.

USER_TYPE_GOOGLE_OAUTH

final int us.zoom.sdk.MeetingService.USER_TYPE_GOOGLE_OAUTH = 3

static

User logins with Google authentication.

Definition at line 31 of file MeetingService.java.

USER_TYPE_SSO

final int us.zoom.sdk.MeetingService.USER_TYPE_SSO = 4

static

Single-sign-on user.

Definition at line 36 of file MeetingService.java.

USER_TYPE_UNKNOWN

final int us.zoom.sdk.MeetingService.USER_TYPE_UNKNOWN = -1

static

Unknown user type.

Definition at line 41 of file MeetingService.java.

USER_TYPE_ZOOM

final int us.zoom.sdk.MeetingService.USER_TYPE_ZOOM = 1

static

User logins with working email.

Definition at line 21 of file MeetingService.java.