Help Center/ Meeting/ Client SDK Reference/ Android SDK/ API Reference/ Notification Reference/ Customizing UI Behavior Notifications in a Meeting
Updated on 2023-03-23 GMT+08:00

Customizing UI Behavior Notifications in a Meeting

You can configure listeners for notifications related to meeting UI changes.

The UI is created when you join a meeting and destroyed when you leave the meeting.

Application Scenarios

Joining a meeting: onConfDetailNotify

Ending or leaving a meeting: onConfEnded or onLeaveConf

Ending a P2P call: onCallEnded

Precautions

sdkConfig takes effect only when this configuration is passed during SDK initialization.

Sample Code

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
public class CustomNotifyHandler implements CLMNotifyHandler {
    /**
     * A notification is sent when a call ends.
     * @param callInfo Indicates the call information.
     */
    @Override
    public void onCallEnded(CallInfo callInfo) {
        Log.i(TAG, "The call ends.");
    }
 
    @Override
    public void onConfDetailNotify(ConfInfo confInfo) {
        Log.i(TAG, "confInfo: confId" + confInfo.getConfId() + ", Subject:" + confInfo.getConfSubject());
    }
 
    /**
     * A notification is sent when a meeting ends.
     * @param result Indicates the error code returned after the meeting ends.
     */
    @Override
    public void onConfEnded(ConfEndedReason result) {
        Log.i(TAG, "The meeting has ended.");
    }
 
    @Override
    public void onLeaveConf(int result) {
        Log.i(TAG, "You've left the meeting.");
    }
}
sdkConfig.setNotifyHandler(new CustomNotifyHandler());

Notification for Leaving a Meeting

API Description

A notification is sent when a user proactively leaves a meeting, fails to join a meeting, or fails to be called again.

Method Definition

1
2
3
4
    /**
     * Receives a notification when the user leaves the meeting.
     */
    void onLeaveConf(int result);

Parameter Description

Table 1 Parameter description

Parameter

Mandatory

Type

Description

result

Yes

int

Reason for leaving the meeting.

Constants.LEAVE_CONF_MODE.LEAVE_NORMAL = 7; // The user proactively leaves the meeting.

Constants.LEAVE_CONF_MODE.LEAVE_OF_NOSTREAM = 8; // Reconnection failure upon no stream.

Constants.LEAVE_CONF_MODE.LEAVE_OF_OUTNET = 9; // Reconnection failure upon network interruption.

Constants.LEAVE_CONF_MODE.LEAVE_OF_TLS_UNESTABLISH = 10; // TLS intermittent disconnection.

Constants.LEAVE_CONF_MODE.LEAVE_OF_OUTNET_TIMEOUT = 14; // Network reconnection timeout.

Return Values

None

Meeting End Notification

API Description

A notification is sent when a meeting ends.

Method Definition

1
2
3
4
5
6
    /**
     * Receives a notification when the meeting ends.
     *
     * @param reason Indicates the error code returned after the meeting ends.
     */
    void onConfEnded(ConfEndedReason reason);

Parameter Description

Table 2 Parameter description

Parameter

Mandatory

Type

Description

reason

Yes

ConfEndedReason

Enumerated values of error codes.

Return Values

None

Parameter Extension

Table 3 ConfEndedReason parameters

Parameter

Type

Description

LEAVE_CONF_HANGUP

enum

The user leaves the meeting.

STOP_CONF_HANDUP

enum

The meeting has been ended.

REMOVE_BY_CHAIRMAN_HANDUP

enum

The user is removed by the host.

TIMEOUT

enum

Network interrupted.

NO_STREAM_HANDUP

enum

Network error.

CORP_CONFERENCE_RESOURCE_HAS_BEEN_RUN_OUT

enum

The amount of enterprise resources has reached the upper limit.

UNKONWN

enum

Unknown reason.

Meeting Details Notification

API Description

A notification is sent when a user attempts to obtain the meeting details or joins a meeting.

Method Definition

1
2
3
4
5
6
    /**
     * Receives a notification about meeting details.
     *
     * @param confInfo
     */
    void onConfDetailNotify(ConfInfo confInfo);

Parameter Description

Table 4 Parameter description

Parameter

Mandatory

Type

Description

confInfo

Yes

ConfInfo

Meeting details.

Return Values

None

Parameter Extension

Table 5 ConfInfo parameters

Parameter

Mandatory

Type

Description

confSubject

Yes

String

Meeting topic.

confId

Yes

String

Meeting ID.

vmrConferenceId

Yes

String

Personal meeting ID.

confPwd

No

String

Guest password.

confAccessNum

Yes

String

Access code.

confChairPwd

Yes

String

Host password.

confGuestUri

Yes

String

URI for guests to join the meeting.

confStartTime

Yes

String

Meeting start time.

confEndTime

Yes

String

Meeting end time.

confScheduserName

Yes

String

Scheduler name.

confOrgId

Yes

String

Whether the user is an external user.

mediaType

Yes

int

Meeting type.

CONF_MEDIA_TYPE_AUDIO = 1; voice

CONF_MEDIA_TYPE_VIDEO = 2; video

CONF_MEDIA_TYPE_HDVIDEO = 4; HD video

CONF_MEDIA_TYPE_DATA = 16; data

Call End Notification

API Description

A notification is sent when a P2P call ends.

Method Definition

1
2
3
4
5
6
    /**
     * Receives a notification when the call ends.
     *
     * @param callInfo Indicates the call information.
     */
    void onCallEnded(CallInfo callInfo);

Parameter Description

Table 6 Parameter description

Parameter

Mandatory

Type

Description

callInfo

Yes

CallInfo

Call information.

Return Values

None

Parameter Extension

Table 7 CallInfo parameters

Parameter

Mandatory

Type

Description

peerInfo

Yes

PeerInfo

Information about the peer party in a P2P call.

startTime

Yes

long

Start time.

endTime

Yes

long

End time.

callType

Yes

int

Call type.

  • 0: voice call.
  • 1: video call.

callState

No

int

Call status.

  • 1: called.
  • 2: calling.

isCallSuccess

Yes

boolean

Whether the call is set up.

missReason

Yes

int

Cause of call setup failure.

  • 0: The called party does not answer the call.
  • 1: The called party rejects the call.

isEncryptCall

No

boolean

Whether audio and video data is encrypted.

isCalleeBusy

Yes

boolean

Whether the called party is busy.

Table 8 PeerInfo parameter description

Parameter

Mandatory

Type

Description

peerName

Yes

String

Name of the peer party.

peerNumber

Yes

String

Number of the peer party.

peerAccount

No

String

Account of the peer party.

peerUuid

No

String

UUID of the peer party.

peerThirdAccount

No

String

Third-party account.