us.zoom.sdk

Interface MeetingService

public interface MeetingService

ZOOM meeting service.

Field Summary

Fields

Modifier and Type	Field and Description
static int	USER_TYPE_API_USER API user.
static int	USER_TYPE_FACEBOOK User logins with Facebook account.
static int	USER_TYPE_GOOGLE_OAUTH User logins with Google authentication.
static int	USER_TYPE_SSO Single-sign-on user.
static int	USER_TYPE_UNKNOWN Unknown user type.
static int	USER_TYPE_ZOOM User logins with working email.

Method Summary

Modifier and Type	Method and Description
void	addDialOutListener(DialOutStatusListener listener) Register a listener for outgoing call status.
void	addListener(MeetingServiceListener listener) Register a listener for meeting service.
boolean	cancelDialOut(boolean isCallMe) Cancel to invite user by telephone.
void	configDSCP(int audio, int video, boolean reset) Configure DSCP(Differentiated Services Code Point) values.
boolean	dialOutUser(java.lang.String number, java.lang.String userName, boolean isCallMe) Invite user by telephone.
java.lang.String	getCurrentMeetingUrl() Get the URL of the current meeting.
java.lang.String	getCurrentRtcMeetingID() Get the unique ID of current meeting, in format like DVLObefSZizM0xQLhtrCQ==
long	getCurrentRtcMeetingNumber() Get current meeting number, in format like 123456789.
InviteRoomSystemHelper	getInviteRoomSystemHelper() Get the instance of InviteRoomSystemHelper.
MeetingStatus	getMeetingStatus() Get the current meeting status.
boolean	handZoomWebUrl(java.lang.String meetingUrl) Start or join a ZOOM meeting with zoom web url
boolean	isCurrentMeetingHost() Query if the current user is meeting host.
boolean	isCurrentMeetingLocked() Query if the current meeting is locked.
boolean	isDialOutInProgress() Query if the outgoing call is in progress at the moment.
boolean	isDialoutSupported() Query if it is able to dial out in the current meeting.
boolean	isInviteRoomSystemSupported() Query if it is able to invite room system in the current meeting.
int	joinMeetingWithParams(android.content.Context context, JoinMeetingParams param, JoinMeetingOptions opts) Start a ZOOM meeting with specified arguments.
void	leaveCurrentMeeting(boolean endIfPossible) Leave the current meeting.
void	notifyVideoConfInstanceDestroyed() notify conf is destroyed
void	pauseCurrentMeeting() Pause the current meeting and mute microphone and speaker.
void	removeDialOutListener(DialOutStatusListener listener) Unregister the listener.
void	removeListener(MeetingServiceListener listener) Unregister the listener.
void	removeMeetingNotification(android.content.Context context) Remove the notification of meeting.
void	resumeCurrentMeeting() Resume the current meeting.
void	returnToMeeting(android.content.Context context) Place the meeting window to foreground.
int	startInstantMeeting(android.content.Context context, MeetingOptions opts) Start a ZOOM meeting with specified arguments for logged-in user.
int	startMeetingWithParams(android.content.Context context, StartMeetingParams param, MeetingOptions opts) Start a ZOOM meeting with specified parameters.
boolean	tryRetrieveMicrophone() Try to retrieve microphone in the meeting

Field Detail

USER_TYPE_API_USER

static final int USER_TYPE_API_USER

API user.

See Also:

Constant Field Values

USER_TYPE_ZOOM

static final int USER_TYPE_ZOOM

User logins with working email.

See Also:

Constant Field Values

USER_TYPE_FACEBOOK

static final int USER_TYPE_FACEBOOK

User logins with Facebook account.

See Also:

Constant Field Values

USER_TYPE_GOOGLE_OAUTH

static final int USER_TYPE_GOOGLE_OAUTH

User logins with Google authentication.

See Also:

Constant Field Values

USER_TYPE_SSO

static final int USER_TYPE_SSO

Single-sign-on user.

See Also:

Constant Field Values

USER_TYPE_UNKNOWN

static final int USER_TYPE_UNKNOWN

Unknown user type.

See Also:

Constant Field Values

Method Detail

addListener

void addListener(MeetingServiceListener listener)

Register a listener for meeting service.

Parameters:

listener - The listener instance.

removeListener

void removeListener(MeetingServiceListener listener)

Unregister the listener.

Parameters:

listener - The listener instance.

addDialOutListener

void addDialOutListener(DialOutStatusListener listener)

Register a listener for outgoing call status.

Parameters:

listener - The listener instance.

removeDialOutListener

void removeDialOutListener(DialOutStatusListener listener)

Unregister the listener.

Parameters:

listener - The listener instance.

startMeetingWithParams

int startMeetingWithParams(android.content.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.

startInstantMeeting

int startInstantMeeting(android.content.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.

joinMeetingWithParams

int joinMeetingWithParams(android.content.Context context,
                          JoinMeetingParams param,
                          JoinMeetingOptions opts)

Start a ZOOM meeting with specified arguments.

Parameters:

context - Android context.

param - Parameters to join meeting, see JoinMeetingParams.

opts - Other options. It should be an instance of JoinMeetingOptions. Default options will be enabled if it is null.

Returns:

Contents defined in MeetingError

handZoomWebUrl

boolean handZoomWebUrl(java.lang.String meetingUrl)

Start or join a ZOOM meeting with zoom web url

Parameters:

meetingUrl - zoom web meeting url

Returns:

TRUE Success.

getMeetingStatus

MeetingStatus getMeetingStatus()

Get the current meeting status.

Returns:

The status value defined in MeetingStatus.

leaveCurrentMeeting

void 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.

pauseCurrentMeeting

void pauseCurrentMeeting()

Pause the current meeting and mute microphone and speaker.

resumeCurrentMeeting

void resumeCurrentMeeting()

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

returnToMeeting

void returnToMeeting(android.content.Context context)

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

Parameters:

context - Android context.

getCurrentRtcMeetingID

java.lang.String getCurrentRtcMeetingID()

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

Returns:

Current meeting ID.

getCurrentRtcMeetingNumber

long getCurrentRtcMeetingNumber()

Get current meeting number, in format like 123456789.

Returns:

Current meeting number.

getCurrentMeetingUrl

java.lang.String getCurrentMeetingUrl()

Get the URL of the current meeting.

Returns:

Current meeting URL.

isCurrentMeetingLocked

boolean 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.

isCurrentMeetingHost

boolean isCurrentMeetingHost()

Query if the current user is meeting host.

Returns:

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

dialOutUser

boolean dialOutUser(java.lang.String number,
                    java.lang.String userName,
                    boolean isCallMe)

Invite user by telephone.

Parameters:

number - Phone number of invitee.

userName - Screen name of invitee who joins the meeting when the API isCallMe is true.

isCallMe - Set to invite others or the current user himself.

Returns:

TRUE means calling successfully. FALSE not.

cancelDialOut

boolean cancelDialOut(boolean isCallMe)

Cancel to invite user by telephone.

Parameters:

isCallMe - Set to invite others or the current user himself.

Returns:

TRUE means calling the function successfully. FALSE not.

isDialOutInProgress

boolean isDialOutInProgress()

Query if the outgoing call is in progress at the moment.

Returns:

TRUE means that the outgoing call is in progress. FALSE not.

isDialoutSupported

boolean isDialoutSupported()

Query if it is able to dial out in the current meeting.

Returns:

TRUE means able. FALSE not.

isInviteRoomSystemSupported

boolean isInviteRoomSystemSupported()

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

Returns:

TRUE means able. FALSE not.

getInviteRoomSystemHelper

InviteRoomSystemHelper getInviteRoomSystemHelper()

Get the instance of InviteRoomSystemHelper.

Returns:

The shared instance of InviteRoomSystemHelper.

tryRetrieveMicrophone

boolean tryRetrieveMicrophone()

Try to retrieve microphone in the meeting

Returns:

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

removeMeetingNotification

void removeMeetingNotification(android.content.Context context)

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

Parameters:

context - See Context

configDSCP

void 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.

notifyVideoConfInstanceDestroyed

void notifyVideoConfInstanceDestroyed()

notify conf is destroyed