sdk interface reference (android) · ec platform cloud sdk interface reference (android) h issue 01...
TRANSCRIPT
EC Platform Cloud
SDK Interface Reference (Android)
Issue 01
Date 2016-08-24
HUAWEI TECHNOLOGIES CO., LTD.
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
i
Copyright © Huawei Technologies Co., Ltd. 2016. All rights reserved.
No part of this document may be reproduced or transmitted in any form or by any means without prior
written consent of Huawei Technologies Co., Ltd.
Trademarks and Permissions
and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd.
All other trademarks and trade names mentioned in this document are the property of their respective
holders.
Notice
The purchased products, services and features are stipulated by the contract made between Huawei and
the customer. All or part of the products, services and features described in this document may not be
within the purchase scope or the usage scope. Unless otherwise specified in the contract, all statements,
information, and recommendations in this document are provided "AS IS" without warranties, guarantees or
representations of any kind, either express or implied.
The information in this document is subject to change without notice. Every effort has been made in the
preparation of this document to ensure accuracy of the contents, but all statements, information, and
recommendations in this document do not constitute a warranty of any kind, express or implied.
Huawei Technologies Co., Ltd.
Address: Huawei Industrial Base
Bantian, Longgang
Shenzhen 518129
People's Republic of China
Website: http://e.huawei.com
EC Platform Cloud
SDK Interface Reference (Android) About This Document
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
ii
About This Document
Purpose
This document describes the interfaces, data structures, and return codes provided by the EC
Platform Cloud (ECPC) conference component (SDK) for the secondary development
personnel of the independent software vendor (ISV).
Product Version
Product Name Version
EC Platform Cloud V100R001C00
Intended Audience
This document is intended for:
ISV secondary development architecture designers
ISV secondary software engineers
Symbol Conventions
The symbols that may be found in this document are defined as follows.
Symbol Description
Indicates an imminently hazardous situation which, if not
avoided, will result in death or serious injury.
Indicates a potentially hazardous situation which, if not
avoided, could result in death or serious injury.
Indicates a potentially hazardous situation which, if not
avoided, may result in minor or moderate injury.
EC Platform Cloud
SDK Interface Reference (Android) About This Document
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
iii
Symbol Description
Indicates a potentially hazardous situation which, if not
avoided, could result in equipment damage, data loss,
performance deterioration, or unanticipated results.
NOTICE is used to address practices not related to personal
injury.
Calls attention to important information, best practices and
tips.
NOTE is used to address information not related to personal
injury, equipment damage, and environment deterioration.
Change History
Changes between document issues are cumulative. The latest document issue contains all the
changes made in earlier issues.
Issue 01 (2013-03-20)
Issue 02 (2016-08-24)
EC Platform Cloud
SDK Interface Reference (Android) Contents
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
iv
Contents
About This Document .................................................................................................................... ii
1 System Overview .......................................................................................................................... 1
1.1 Product Overview ......................................................................................................................................................... 1
1.2 Conventions .................................................................................................................................................................. 1
2 Android Java Methods ................................................................................................................. 2
2.1 Description of the TupConf JAR Package Class .......................................................................................................... 2
2.2 Description of the HME-Audio JAR Package Class..................................................................................................... 3
2.3 Description of the HME-Video JAR Package Class ..................................................................................................... 3
2.3.1 CreateLocalRenderer ................................................................................................................................................. 3
2.3.2 CreateRenderer .......................................................................................................................................................... 4
2.3.3 getIndexOfSurface ..................................................................................................................................................... 5
2.3.4 setSurfaceNull............................................................................................................................................................ 6
2.4 Description of the Conference Class ............................................................................................................................. 6
2.4.1 initSDK ...................................................................................................................................................................... 6
2.4.2 initIsv ......................................................................................................................................................................... 7
2.4.3 exitSDK ..................................................................................................................................................................... 7
2.4.4 setDpi ......................................................................................................................................................................... 8
2.4.5 setLogLevel ............................................................................................................................................................... 8
2.4.6 setPath ........................................................................................................................................................................ 9
2.4.7 setCaneraName .......................................................................................................................................................... 9
3 Description of the Android ConfInstance Class ................................................................... 11
3.1 Conference Control ..................................................................................................................................................... 11
3.1.1 conf_New ................................................................................................................................................................. 11
3.1.2 conf_Release ............................................................................................................................................................ 12
3.1.3 conf_Join ................................................................................................................................................................. 12
3.1.4 conf_Terminate ........................................................................................................................................................ 14
3.1.5 conf_Leave .............................................................................................................................................................. 14
3.1.6 conf_HeartBeat ........................................................................................................................................................ 16
3.1.7 conf_Mute ................................................................................................................................................................ 16
3.1.8 conf_LoadComponent ............................................................................................................................................. 17
3.2 Visitor ......................................................................................................................................................................... 18
3.2.1 conf_User_Kickout .................................................................................................................................................. 18
EC Platform Cloud
SDK Interface Reference (Android) Contents
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
v
3.2.2 conf_User_SetRole .................................................................................................................................................. 19
3.3 Desktop or Application Sharing .................................................................................................................................. 21
3.3.1 as_SetOwner ............................................................................................................................................................ 21
3.3.2 as_Start .................................................................................................................................................................... 22
3.3.3 as_Stop ..................................................................................................................................................................... 23
3.3.4 as_SetPrivilege ........................................................................................................................................................ 24
3.3.5 as_InputMsg ............................................................................................................................................................ 26
3.3.6 as_ViewCreate ......................................................................................................................................................... 27
3.3.7 as_ViewDestroy ....................................................................................................................................................... 27
3.3.8 as_ViewUpdate ........................................................................................................................................................ 27
3.3.9 as_ViewUpdateData................................................................................................................................................. 28
3.4 Document Sharing ...................................................................................................................................................... 28
3.4.1 ds_Open ................................................................................................................................................................... 28
3.4.2 ds_Close ................................................................................................................................................................... 31
3.4.3 ds_SetCurrentPage ................................................................................................................................................... 32
3.5 Whiteboard ................................................................................................................................................................. 34
3.5.1 wb_NewDoc ............................................................................................................................................................ 34
3.5.2 wb_SetCurrentPage ................................................................................................................................................. 35
3.5.3 wb_NewPage ........................................................................................................................................................... 37
3.6 Annotation .................................................................................................................................................................. 39
3.6.1 annot_CreateStart .................................................................................................................................................... 39
3.6.2 annot_CreateDrawingUpdate ................................................................................................................................... 40
3.6.3 annot_CreateCustomerUpdate ................................................................................................................................. 41
3.6.4 annot_CreateDone ................................................................................................................................................... 41
3.6.5 annot_HittestPoint ................................................................................................................................................... 42
3.6.6 annot_Delete ............................................................................................................................................................ 43
3.7 Video ........................................................................................................................................................................... 44
3.7.1 video_GetDeviceCount ............................................................................................................................................ 44
3.7.2 video_GetDeviceInfo ............................................................................................................................................... 45
3.7.3 video_Open .............................................................................................................................................................. 46
3.7.4 video_Close ............................................................................................................................................................. 47
3.7.5 video_Pause ............................................................................................................................................................. 48
3.7.6 video_Resume.......................................................................................................................................................... 49
3.7.7 video_SetParam ....................................................................................................................................................... 50
3.7.8 video_GetParam ...................................................................................................................................................... 50
3.7.9 video_Attach ............................................................................................................................................................ 51
3.7.10 video_Detach ......................................................................................................................................................... 52
3.7.11 video_SetCaptureRotate ........................................................................................................................................ 53
3.7.12 video_SetEncodeMaxResolution ........................................................................................................................... 54
3.8 Audio .......................................................................................................................................................................... 54
3.8.1 audio_SetParam ....................................................................................................................................................... 54
3.8.2 audio_OpenMic ....................................................................................................................................................... 56
EC Platform Cloud
SDK Interface Reference (Android) Contents
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
vi
3.8.3 audio_CloseMic ....................................................................................................................................................... 57
3.8.4 audio_MuteMic........................................................................................................................................................ 58
3.8.5 audio_UnMuteMic ................................................................................................................................................... 59
3.8.6 audio_OpenSpeaker ................................................................................................................................................. 60
3.8.7 audio_CloseSpeaker ................................................................................................................................................ 61
3.8.8 audio_MuteSpeaker ................................................................................................................................................. 61
3.8.9 audio_UnMuteSpeaker ............................................................................................................................................ 62
3.9 Instant Message .......................................................................................................................................................... 62
3.9.1 chat_SendMsgEx ..................................................................................................................................................... 62
4 Return Code ................................................................................................................................. 64
5 Callback Messages of the Java Class ....................................................................................... 81
5.1 Description .................................................................................................................................................................. 81
5.2 Conference Management ............................................................................................................................................ 81
5.3 User Management ....................................................................................................................................................... 82
5.4 Video Module ............................................................................................................................................................. 83
5.5 Audio Module ............................................................................................................................................................. 83
5.6 Desktop or Application Program Sharing ................................................................................................................... 85
5.7 Document Sharing ...................................................................................................................................................... 85
5.8 Whiteboard ................................................................................................................................................................. 87
5.9 IM ............................................................................................................................................................................... 88
6 Callback Class Description ....................................................................................................... 89
6.1 Conference Control ..................................................................................................................................................... 89
6.1.1 ConfExtendParamMsg ............................................................................................................................................. 89
6.1.2 ConfExtendUserDataMsg ........................................................................................................................................ 89
6.1.3 ConfExtendUserInfoMsg ......................................................................................................................................... 89
6.2 Screen Sharing ............................................................................................................................................................ 90
6.2.1 ConfExtendAsChannelMsg ..................................................................................................................................... 90
6.2.2 ConfExtendAsMouseMsg ........................................................................................................................................ 90
6.2.3 ConfExtendAsParamMsg ........................................................................................................................................ 90
6.2.4 ConfExtendAsPrivilegeMsg .................................................................................................................................... 91
6.2.5 ConfExtendAsScreenSizeMsg ................................................................................................................................. 91
6.2.6 ConfExtendAsSessionMsg ...................................................................................................................................... 91
6.3 Whiteboard Sharing .................................................................................................................................................... 91
6.3.1 ConfExtendDsNewDocMsg .................................................................................................................................... 91
6.3.2 ConfExtendFlowControlMsg ................................................................................................................................... 92
6.4 File Transfer ................................................................................................................................................................ 92
6.4.1 ConfExtendFtFileInfoMsg ....................................................................................................................................... 92
6.5 Audio .......................................................................................................................................................................... 93
6.5.1 ConfExtendMaxVoiceMsg ....................................................................................................................................... 93
6.6 Video ........................................................................................................................................................................... 93
6.6.1 ConfExtendVideoDeviceInfoMsg ............................................................................................................................ 93
EC Platform Cloud
SDK Interface Reference (Android) Contents
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd.
vii
6.6.2 ConfExtendVideoParamMsg ................................................................................................................................... 93
EC Platform Cloud
SDK Interface Reference (Android) 1 System Overview
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
1
1 System Overview
1.1 Product Overview
The ECPC terminal components are separated from the user interface and operating system
and use the asynchronous programming method to implement the cross-platform and high
integration features. This document describes the interfaces provided by the ECPC terminal
components for the third-party application development personnel.
1.2 Conventions In the parameter description part of this document, (IN) indicates input parameters,
(OUT) indicates output parameters, and (IN&OUT) indicates both the input and output
parameters.
The conference handles involved in this document are returned by interface conf_New
for users to identify conferences.
EC Platform Cloud
SDK Interface Reference (Android) 2 Android Java Methods
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
2
2 Android Java Methods
2.1 Description of the TupConf JAR Package Class
Class (com.huawei.meeting)
Description
Conference Conference component Java Native Interface (JNI) class.
This class is a single-instance class used for basic
information initialization.
ConfInstance Conference class.
This class is invoked in the XML format and can be directly
used.
ConfGLView Class of rendering desktop or application program sharing,
document sharing, and whiteboard in the conference
component.
ConfMsg Class of enumerating callback messages in the conference
component.
The enumeration value is the same as that on Windows or
iOS.
ConfExtendXXX Callback data structure class.
Different callback messages belong to different classes.
ConfOper Class of enumerating operations in the conference
component.
This class is used for confHandleMsg.
IConferenceUI Callback interface class.
The application layer must implement the class and register
the interface with ConfInstance class.
ConfDefines Class of defining constants in the conference component.
ConfInfo Class only for internal use in the conference component.
EC Platform Cloud
SDK Interface Reference (Android) 2 Android Java Methods
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
3
2.2 Description of the HME-Audio JAR Package Class
The .jar package of the Huawei Media Engine (HME) contains only one class:
AudioDeviceAndroidService, used to start a service.
The service start must be invoked in the main thread before the audio component is loaded.
The service is started by the .jar package of the HME at the Java layer.
Example:
Intent intent = new Intent(context, AudioDeviceAndroidService.class);
context.startService(intent);
The service stops after the HME stops. The service stop is also invoked in the main thread.
Example
Intent intent = new Intent(this, AudioDeviceAndroidService.class);
stopService(intent);
2.3 Description of the HME-Video JAR Package Class
Class
(com.huawei.hme_video_conf) Description
ViERenderer Class used to display video in a window
2.3.1 CreateLocalRenderer
Interface Description
Creates a local renderer to display local video.
Interface Definition
static SurfaceView CreateLocalRenderer(Context context);
Parameter Description
Parameter Type Description
context Context Pointer of an activity
Return Value
SurfaceView: A view window is returned to display video.
EC Platform Cloud
SDK Interface Reference (Android) 2 Android Java Methods
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
4
Example
private SurfaceView svLocalSurfaceView = null;
private LinearLayout mLlLocalSurface = null;
mLlLocalSurface = (LinearLayout) findViewById(R.id.LocalView);
svLocalSurfaceView = ViERenderer.CreateLocalRenderer(this);
//Delete a local renderer.
mLlLocalSurface.removeView(svLocalSurfaceView);
//Display a local renderer.
mLlLocalSurface.addView(svLocalSurfaceView);
//Release resources of a local renderer.
ViERenderer.FreeLocalRenderResource();
Use the CreateLocalRenderer interface to create the renderer for local video. The video data is collected
only after the video frame is bound to the video view through the addView function.
2.3.2 CreateRenderer
Interface Description
Creates a remote renderer to display remote video.
Interface Definition
static SurfaceView CreateRenderer(Context context);
Parameter Description
Parameter Type Description
context Context Pointer of an activity
Return Value
SurfaceView: A view window is returned to display video.
Example
private SurfaceView remoteSurfaceView = null;
private LinearLayout mLlRemoteSurface = null;
mLlRemoteSurface = (LinearLayout) findViewById(R.id.RemoteView);
EC Platform Cloud
SDK Interface Reference (Android) 2 Android Java Methods
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
5
remoteSurfaceView = ViERenderer.CreateRenderer(this, useOpenGLES2);
//Obtain the index of the renderer handle, which is transmitted through the JNI.
int indexOfSurface = ViERenderer.getIndexOfSurface(remoteSurfaceView);
conf.VideoAttach(indexOfSurface); //Transmit the window handle index.
//Add a remote renderer.
mLlRemoteSurface.addView(remoteSurfaceView);
//Delete a local renderer.
mLlRemoteSurface.removeView(remoteSurfaceView);
//Release resources of a remote renderer. (The method is invoked when the renderer handle is
transmitted through the index.)
ViERenderer.setSurfaceNull(remoteSurfaceView);
2.3.3 getIndexOfSurface
Interface Description
Obtains the handle index of each video window when multiple video windows for displaying
remote video are created.
Interface Definition
static int getIndexOfSurface(SurfaceView render);
Parameter Description
Parameter Type Description
SurfaceView render Window view
Return Value
The handle index of the video window is returned.
Example
//Obtain the index of the renderer handle, which is transmitted through the JNI.
private SurfaceView remoteSurfaceView = null;
int indexOfSurface = ViERenderer.getIndexOfSurface(remoteSurfaceView);
conf.VideoAttach(indexOfSurface); //Transmit the window handle index.
EC Platform Cloud
SDK Interface Reference (Android) 2 Android Java Methods
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
6
2.3.4 setSurfaceNull
Interface Description
Clears video in the window.
Interface Definition
void setSurfaceNull(SurfaceView render);
Parameter Description
Parameter Type Description
SurfaceView render Window view
Return Value
None.
Example
private SurfaceView remoteSurfaceView = null;
//Release resources of a remote renderer. (The method is invoked when the renderer handle is
transmitted through the index.)
ViERenderer.setSurfaceNull(remoteSurfaceView);
2.4 Description of the Conference Class
This class is JNI class of the conference component and is used to initialize basic information.
The external interfaces are as follows:
2.4.1 initSDK
Interface Description
Initializes the SDK.
Interface Definition
void initSDK(boolean bSelfThread, int devType)
EC Platform Cloud
SDK Interface Reference (Android) 2 Android Java Methods
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
7
Parameter Description
Parameter Type Description
bSelfThread Boolean Indicates whether the independent thread is
enabled for processing message loop of the
component.
devType Int Device type
Return Value
None.
2.4.2 initIsv
Interface Description
Initializes ISV information, including the ISV account and private key.
Interface Definition
void initIsv(String isvAccount,String rsaKey,String keyPath)
Parameter Description
Parameter Type Description
isvAccount String ISV account
rsaKey String Private key
The parameter can be empty.
keyPath String Private key storage path
If the private key is empty, the private key is
directly read from the path. The file name of the
private key to be read is rsa_private_key.pem.
Return Value
None.
2.4.3 exitSDK
Interface Description
Exits the SDK.
EC Platform Cloud
SDK Interface Reference (Android) 2 Android Java Methods
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
8
Interface Definition
void exitSDK()
Parameter Description
None.
Return Value
None.
2.4.4 setDpi
Interface Description
Sets device dots per inch (DPI).
Interface Definition
setDpi(float xdpi, float ydpi)
Parameter Description
Parameter Type Description
xdpi Float DPI on the x-axis of the screen
ydpi Float DPI on the y-axis of the screen
Return Value
None.
2.4.5 setLogLevel
Interface Description
Sets the log level.
Interface Definition
setLogLevel(int media_level, int sdk_level)
EC Platform Cloud
SDK Interface Reference (Android) 2 Android Java Methods
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
9
Parameter Description
Parameter Type Description
media_leve int Media library log level
sdk_level int SDK library log level
Return Value
None.
2.4.6 setPath
Interface Description
Sets the log directory and temporary directory.
Interface Definition
void setPath(String logpath, String temppath)
Parameter Description
Parameter Type Description
logpath String Log file write directory
temppath String Temporary file write directory
Return Value
None.
2.4.7 setCaneraName
Interface Description
Sets the names of the front-facing camera (FFC) and rear-facing camera (RFC).
Interface Definition
void setCaneraName(String backCamera, String frontCanmera)
EC Platform Cloud
SDK Interface Reference (Android) 2 Android Java Methods
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
10
Parameter Description
Parameter Type Description
backCamera String RFC name
frontCanmera String FFC name
Return Value
None.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
11
3 Description of the Android ConfInstance Class
3.1 Conference Control
3.1.1 conf_New
Interface Description
Creates a conference and returns the unique ID of the conference.
Interface Definition
boolean conf_New(ConfInfo cinfo)
Parameter Description
Parameter Type Description
cinfo ConfInfo Conference information
Return Value
If the return value is true, the conference is successfully created. If the return value is false,
the conference fails to be created.
Reference
conf_Release
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
12
3.1.2 conf_Release
Interface Description
Releases a conference.
This interface must be in the same thread as the conf_New interface.
You are advised to invoke this interface when exiting a program, for example, the last moment when
exiting the main thread.
You are not advised to invoke this interface immediately after invoking the conf_Leave interface;
otherwise, you cannot leave the conference because some messages are not sent.
You are not advised to invoke this interface immediately fatter invoking the conf_Terminate interface;
otherwise, the conference cannot be terminated because some messages are not sent or the components
may break down. You are advised to invoke this interface after receiving a termination confirmation
message.
Interface Definition
void conf_Release()
3.1.3 conf_Join
Interface Description
Joins a conference.
Interface Definition
int conf_Join()
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
CONF_MSG_
ON_CONFER
ENCE_JOIN
Notification of
joining a conference.
Recipient: user who
invokes the interface
TcResult
result
N/A NULL
CONF_MSG_
USER_ON_E
NTER_IND
Notification of
joining conference
successfully.
Recipient: all users
1: A user
joins the
conference
.
0: The user
is already in the
User role "<?xml
version=\"1.0\"
encoding=\"UT
F-8\"
standalone=\"ye
s\"?> \
<MSG type =
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
13
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
conference
.
\"%s\"> \
<version>%d</
version> \
<userid>%u</u
serid> \
<devicetype>%
d</devicetype>
\
<ostype>%d</o
stype> \
<user_presence
_flag>%d</user
_presence_flag>
\
<user_capabilit
y>%d</user_ca
pability> \
<user_status>%
d</user_status>
\
<user_name>%
s</user_name>
\
<user_alt_uri>
%s</user_alt_ur
i> \
<user_join_flag
>%d</user_join
_flag> \
</MSG>"
CONF_MSG_
USER_ON_H
OST_CHAN
GE_IND
Notification of
changing the
moderator received
when the moderator
joins the conference.
Recipient: all users
User ID of the
original
moderator
User ID of
the new
moderator
N/A
CONF_MSG_
USER_ON_P
RESENTER_
CHANGE_IN
D
Notification of
changing the
presenter received
when the presenter
joins the conference.
Recipient: all users
User ID of the
original
presenter
User ID of
the new
presenter
N/A
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
14
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
Reference
conf_Leave
3.1.4 conf_Terminate
Interface Description
Terminates a conference.
This interface is invoked to ask the conference server to release conference resources. All participants
receive the conference termination notification. You will receive a message indicating that the
conference is terminated when you join the conference after it is terminated.
Interface Definition
int conf_Terminate()
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
CONF_MSG_ON_CO
NFERENCE_TERMIN
ATE
Notification of
terminating a
conference.
Recipient: all
users
TcResult
result
N/A NULL
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
3.1.5 conf_Leave
Interface Description
Leaves a conference.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
15
Interface Definition
int conf_Leave()
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
CONF_MSG_
USER_ON_LE
AVE_IND
Notification of
a data user
leaving a
conference.
Recipient: other
users in the
conference
except the user
who leaves the
conference
N/A N/A "<?xml
version=\"1.0\"
encoding=\"UTF-8\"
standalone=\"yes\"?
> \
<MSG type =
\"%s\"> \
<version>%d</versi
on> \
<userid>%u</userid
> \
<devicetype>%d</d
evicetype> \
<ostype>%d</ostyp
e> \
<user_presence_flag
>%d</user_presence
_flag> \
<user_capability>%
d</user_capability>
\
<user_status>%d</u
ser_status> \
<user_name>%s</us
er_name> \
<user_alt_uri>%s</u
ser_alt_uri> \
<user_join_flag>%d
</user_join_flag> \
</MSG>"
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
16
Reference
conf_Join
3.1.6 conf_HeartBeat
Interface Description
Provides heartbeat for message driving.
The ISV application layer drives message loop to ensure that the message loop is in the main
thread.
It is recommended that the interface is invoked in the main thread.
Interface Definition
void conf_HeartBeat()
3.1.7 conf_Mute
Interface Description
Mutes a participant that joins the conference on a phone or PC.
Only the moderator can mute or unmute a conference.
Interface Definition
int conf_Mute(boolean bMute)
Parameter Description
Parameter Type Description
bMute boolean Conference muting flag
The options are as follows:
true: mute
false: unmute
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
17
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
CONF_MSG_ON
_MUTE
Notification of
muting a
participant.
Recipient: all
participants can
receive the
notification
bMute:
1: Mute a
participant.
0: Unmute a
participant.
0 NULL
3.1.8 conf_LoadComponent
Interface Description
Loads specified components.
Interface Definition
int conf_LoadComponent(int nComps)
Parameter Description
Parameter Type Description
coms int Component ID
The value is the enumeration type of
COMPONENT_IID.
Return Value
If TC_OK is returned, the interface is successfully invoked. You need to view the
CONF_MSG_ON_COMPONENT_LOAD callback message to check whether the
components are successfully loaded.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
18
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (pvoid)
CONF_MSG_O
N_COMPONE
NT_LOAD
Notification of loading
specified component
successfully.
Recipient: user who
invokes the interface
Return value Component ID NULL
3.2 Visitor
3.2.1 conf_User_Kickout
Interface Description
Kicks out a user.
Interface Definition
int conf_User_Kickout(int nUserID)
Parameter Description
Parameter Type Description
nUserID uint32 User ID
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
CONF_MSG
_ON_CONF
ERENCE_LE
AVE
Notification
of kicking out
a user.
Recipient:
user who is
kicked out
TC_IMCC_R
EASON_USE
R_EJECTED
Invalid NULL
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
19
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
CONF_MSG
_USER_ON_
LEAVE_IND
Notification
of a data user
leaving the
conference.
Recipient:
other users in
the
conference
except the
user who is
kicked out
N/A N/A "<?xml
version=\"1.0\"
encoding=\"UTF-8\"
standalone=\"yes\"?> \
<MSG type = \"%s\">
\
<version>%d</versio
n> \
<userid>%u</userid>
\
<devicetype>%d</dev
icetype> \
<ostype>%d</ostype>
\
<user_presence_flag>
%d</user_presence_fl
ag> \
<user_capability>%d
</user_capability> \
<user_status>%d</use
r_status> \
<user_name>%s</use
r_name> \
<user_alt_uri>%s</us
er_alt_uri> \
<user_join_flag>%d</
user_join_flag> \
</MSG>"
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
3.2.2 conf_User_SetRole
Interface Description
Assigns a role to a user.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
20
Interface Definition
int conf_User_SetRole(int nUserID, int nRole)
Parameter Description
Parameter Type Description
nUserID int User ID
nRole int User role
The options are as follows:
CONF_ROLE_HOST: moderator
CONF_ROLE_PRESENTER: presenter
CONF_ROLE_GENERAL: common
participant
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
CONF_MSG_US
ER_ON_HOST_
GIVE_IND
Notification of
assigning the role
of moderator.
Recipient: user to
whom the role is
assigned
ID of the user to
whom the role is
assigned
N/A N/A
CONF_MSG_US
ER_ON_HOST_
GIVE_CFM
Result of
assigning the role
of moderator.
Recipient: user
who assigns the
role to another
user
TC_OK:
operation success
N/A N/A
CONF_MSG_US
ER_ON_HOST_C
HANGE_IND
Notification of
changing the
moderator.
Recipient: all
users
User ID of the
original
moderator
User ID of
the new
moderator
N/A
CONF_MSG_US
ER_ON_PRESEN
TER_GIVE_IND
Notification of
assigning the role
of presenter.
Recipient: user to
whom the role is
ID of the user to
whom the role is
assigned
N/A N/A
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
21
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
assigned
CONF_MSG_US
ER_ON_PRESEN
TER_GIVE_CFM
Result of
assigning the role
of presenter.
Recipient: user
who assigns the
role to another
user
TC_OK:
operation success
N/A N/A
CONF_MSG_US
ER_ON_PRESEN
TER_CHANGE_I
ND
Notification of
changing the
presenter.
Recipient: all
users
User ID of the
original presenter
User ID of
the new
presenter
N/A
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
3.3 Desktop or Application Sharing
3.3.1 as_SetOwner
Interface Description
Assigns the desktop sharing permission to a user.
When this interface is invoked, the desktop sharing permission of the original user is automatically
canceled and the ongoing sharing stops.
Interface Definition
int as_SetOwner(int userid, int action)
Parameter Description
Parameter Type Description
userid int User ID ranging from 1 to 2147483647
If the user ID is invalid, the interface fails to be invoked.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
22
Parameter Type Description
action int Operation type
The options are as follows:
AS_ACTION_DELETE: Release the permission.
AS_ACTION_ADD: Obtain the permission.
If the operation type is invalid, the interface fails to be invoked.
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
Callback Message
Message ID
Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (pvoid)
COMPT_M
SG_AS_ON
_SHARING
_SESSION
Notification of
updating the
sharing status.
Recipient: all
users
AS_SESSIO
N_OWNER
0 (ID of the current
sharer) "<?xml
version=\"1.0\"
encoding=\"UTF-8\"
standalone=\"yes\"?> \
<MSG type = \"%s\"> \
<version>%d</version
> \
<userid>%u</userid> \
</MSG>"
3.3.2 as_Start
Interface Description
Starts to share the desktop or application programs.
Prerequisites
Interface as_SetOwner() is successfully invoked to assign the desktop sharing permission to a
user.
Interface Definition
int as_Start()
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
23
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_MSG
_AS_ON_SHA
RING_STATE
Notification
of updating
the sharing
status.
Recipient: all
users
SHSHARING
TYPE_DESK
TOP
SHSHARING
TYPE_APP
AS_STATE_ST
ART
"<?xml
version=\"1.0\"
encoding=\"UTF-8
\"
standalone=\"yes\"
?> \
<MSG type =
\"%s\"> \
<version>%d</ver
sion> \
<action>%lu</acti
on> \
</MSG>"
The options of
action are as
follows:
AS_STATE_S
UB_NORMAL
AS_STATE_S
UB_CONTRO
L
AS_STATE_S
UB_ANNOTA
TION
3.3.3 as_Stop
Interface Description
Stops sharing the desktop or application programs.
Prerequisites
A user is sharing the desktop or application programs.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
24
Interface Definition
int as_Stop()
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
Callback Message
Message ID
Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_
MSG_AS
_ON_SH
ARING_S
TATE
Notification
of updating
the sharing
status.
Recipient: all
users
SHSHARINGTY
PE_DESKTOP
SHSHARINGTY
PE_APP
AS_
STATE_NULL
"<?xml
version=\"1.0\"
encoding=\"UTF-8\"
standalone=\"yes\"?> \
<MSG type = \"%s\">
\
<version>%d</versio
n> \
<action>%lu</action>
\
</MSG>"
The options of action
are as follows:
AS_STATE_SUB
_NORMAL
AS_STATE_SUB
_CONTROL
AS_STATE_SUB
_ANNOTATION
3.3.4 as_SetPrivilege
Interface Description
Assigns or revokes the remote control permission.
The assignment or revocation automatically takes effective and is not reported to the upper
level.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
25
Interface Definition
int as_SetPrivilege(long userid, int privilege, int action)
Parameter Description
Parameter Type Description
userid int User ID ranging from 1 to 2147483647
If the user ID is invalid, the interface fails to be
invoked.
privilege int Permission type
The options are as follows:
AS_PRIVILEGETYPE_CONTROL: remote control
AS_PRIVILEGETYPE_ANNOTATION: annotation
If the operation type is invalid, the interface fails
to be invoked.
action int Operation type
The options are as follows:
AS_ACTION_DELETE
AS_ACTION_ADD
AS_ACTION_MODIFY
AS_ACTION_REJECT
If the operation type is invalid, the interface fails
to be invoked.
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
26
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_MS
G_AS_ON_P
RIVILEGE
Notification of
updating the
permission
status.
Recipient: all
users in the
conference
AS_PRIVILE
GETYPE_CO
NTROL
AS_PRIVILE
GETYPE_AN
NOTATION
AS_ACTION_
DELETE
AS_ACTION_
ADD
AS_ACTION_
MODIFY
AS_ACTION_R
EJECT
ID of the user
whose permission
is changed
"<?xml
version=\"1.0\"
encoding=\"UTF-8
\"
standalone=\"yes\"
?> \
<MSG type =
\"%s\"> \
<version>%d</ver
sion> \
<userid>%u</useri
d> \
</MSG>"
3.3.5 as_InputMsg
Interface Description
Inputs mouse and keyboard messages for remote control.
The current screen component supports remote control events, including click, double-click,
right-click, scrolling the mouse wheel, and pressing character keys (special function keys
excluded, such as Alt, Ctrl, Windows key, and Print). The screen component does not
support combined keys. The combination of messages or events must be considered when this
interface is invoked.
Interface Definition
int as_InputMsg(int msgid,int wparam,int lparam)
Parameter Description
Parameter Type Description
msgid int Message type
wparam int Message parameter
lparam int Message parameter
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
27
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
3.3.6 as_ViewCreate
Interface Description
Creates a view for limiting the collection range.
This interface is used for sharing Android applications.
Interface Definition
void as_ViewCreate(int nWidth,int nHeight,int nBitCount)
Parameter Description
Parameter Type Description
nWidth int Width of the view to be collected
nHeight int Height of the view to be collected
nBitCount int Bit width of the view to be collected
3.3.7 as_ViewDestroy
Interface Description
Deletes the view created from the as_ViewCreate interface.
This interface is used for sharing Android applications.
Interface Definition
void as_ViewDestroy()
3.3.8 as_ViewUpdate
Interface Description
Updates a view.
This interface is used for sharing Android applications.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
28
Interface Definition
void as_ViewUpdate(int nWidth,int nHeight,int nBitCount)
Parameter Description
Parameter Type Description
nWidth int Width of the view to be collected
nHeight int Height of the view to be collected
nBitCount int Bit width of the view to be collected
3.3.9 as_ViewUpdateData
Interface Description
Updates view image data.
This interface is used for sharing Android applications.
Interface Definition
void as_ViewUpdateData(int[] bmpData)
Parameter Description
Parameter Type Description
bmpData int[] View image data
3.4 Document Sharing
3.4.1 ds_Open
Interface Description
Opens a document to share.
When the document is uploaded to the server, other participants can receive the document.
The document ID is asynchronously returned by the COMPT_MSG_DS_XML_ON_OPEN
callback message.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
29
Interface Definition
int ds_Open(String strFileName)
Parameter Description
Parameter Type Description
strFileName String Absolute path of the document to be shared
The parameter cannot be set to NULL.
Return Value TC_OK: success
TC_NULL_POINT: The conference is not created, or parameters are incorrectly set.
TC_DS_ERROR_DOC_NO_INIT: The document sharing module is not initialized.
TC_DS_ERROR_DOC_NO_SINK: The callback object is not set.
TC_DS_ERROR_DOC_NO_SESSION_JOIN: The current user has not joined the
session of the document sharing component.
TC_DS_ERROR_DOC_USER_OFFLINE: A user is disconnected.
TC_DS_ERROR_DOC_ALREADY_OPEN: The document is already shared and
cannot be shared again.
TC_ERROR: other errors
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_MSG
_DS_XML_O
N_OPEN
Notification of
returning the
document ID.
Recipient: user who
invokes the
interface
Document ID N/A NULL
COMPT_MSG
_DS_ON_DO
CLOAD_STA
RT
Notification
received when a
document is opened,
which indicates
importing data into
the application from
a file.
Recipient: user who
invokes the
interface
Document ID Page number NULL
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
30
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_MSG
_DS_ON_DO
C_NEW
Notification that a
document is
successfully opened
or the header of a
document is
downloaded.
Recipient: all users
Document ID N/A The value
NULL or
document name
"<?xml
version=\"1.0\"
encoding=\"UT
F-8\"
standalone=\"ye
s\"?> \
<MSG type =
\"%s\"> \
<version>%d</v
ersion> \
<fileName>%s<
/fileName> \
</MSG>"
COMPT_MSG
_DS_ON_PAG
E_NEW
Notification that a
page is successfully
loaded or the header
of a page is
downloaded.
Recipient: all users
Document ID Page ID NULL
COMPT_MSG
_DS_ON_PAG
E_LOADED
Notification
received when a
document is opened,
which indicates
importing a page
into the application
from a file.
Recipient: user who
invokes the
interface
Document ID Page ID NULL
COMPT_MSG
_DS_ON_DO
CLOAD_FINI
SH
Notification
received when a
document is opened,
which indicates that
a document is
successfully
imported from a
file.
Recipient: user who
invokes the
interface
Document ID Document
loading
result
For details,
see the
definition in
TcResult.
NULL
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
31
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_MSG
_DS_ON_CU
RRENT_PAG
E_IND
Notification that the
current document or
page changes.
Recipient: all users
Document ID Page ID NULL
3.4.2 ds_Close
Interface Description
Closes a document.
All other participants will receive a message of closing a document.
Interface Definition
int ds_Close(int nDocID)
Parameter Description
Parameter Type Description
nDocID int ID of the document to be closed
Return Value TC_OK: success
TC_NULL_POINT: The conference is not created.
TC_DS_ERROR_DOC_NO_INIT: The document sharing module is not initialized.
TC_DS_ERROR_DOC_NO_SINK: The callback object is not set.
TC_DS_ERROR_DOC_NO_SESSION_JOIN: The current user has not joined the
session of the document sharing component.
TC_DS_ERROR_DOC_USER_OFFLINE: A user is disconnected.
TC_ERROR: other errors
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
32
Callback Message
Message ID
Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (pvoid)
COMPT_M
SG_DS_O
N_DOC_D
EL
Notification of
deleting a
document
being shared.
Recipient: all
users
Document ID N/A The value NULL or
document name
"<?xml version=\"1.0\"
encoding=\"UTF-8\"
standalone=\"yes\"?> \
<MSG type = \"%s\"> \
<version>%d</version
> \
<fileName>%s</fileNa
me> \
</MSG>"
COMPT_M
SG_DS_O
N_PAGE_
DEL
Notification of
deleting a page
of a document.
Recipient: all
users except
the user who
deletes the
page
Document ID Page ID NULL
COMPT_M
SG_DS_O
N_CURRE
NT_PAGE_
IND
Notification
that the current
document or
page changes.
Recipient: all
users
Document ID Page ID NULL
3.4.3 ds_SetCurrentPage
Interface Description
Sets the current page.
After this interface is invoked, the current page is switched to a specified page. If the
specified document ID is valid and the page ID is 0, the current page is switched to the page
that was displayed at the previous time. This interface includes synchronous and
asynchronous settings. During the synchronous setting, other participants will receive the
message of page switch and related operations are executed. During the asynchronous setting,
only the local setting changes.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
33
Interface Definition
int ds_SetCurrentPage(int nDocID, int nPageID)
Parameter Description
Parameter Type Description
nDocID int ID of the document being shared
nPageID int Page ID
Return Value TC_OK: success
TC_NULL_POINT: The conference is not created.
TC_DS_ERROR_DOC_NO_INIT: The document sharing module is not initialized.
TC_DS_ERROR_DOC_NO_SINK: The callback object is not set.
TC_DS_ERROR_DOC_NO_SESSION_JOIN: The current user has not joined the
session of the document sharing component.
TC_DS_ERROR_DOC_USER_OFFLINE: A user is disconnected.
TC_ERROR: other errors
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
34
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_MS
G_DS_ON_C
URRENT_PA
GE_IND
Notification of
synchronously turning
pages.
The underlying layer
does not turn the pages
after receiving the
message and requires
the upper layer to
specify the page to be
turned to.
Other participants may
receive the message and
cannot invoke the
synchronous page
switch interface again.
Recipient: If bSync is 1,
all users receive this
message. If bSync is 0,
all users do not receive
this message.
Document ID Page ID NULL
COMPT_MS
G_DS_ON_C
URRENT_PA
GE
Notification that the
current document or
page changes.
Recipient: If bSync is 0,
the user who invokes
the interface receives
this message.
Document ID Page ID NULL
3.5 Whiteboard
3.5.1 wb_NewDoc
Interface Description
Creates a blank whiteboard document.
All participants will receive a notification of creating a blank whiteboard document. The
document ID is asynchronously returned by the COMPT_MSG_WB_XML_ON_NEW_DOC
callback message.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
35
Interface Definition
int wb_NewDoc()
Return Value TC_OK: success
TC_NULL_POINT: The conference is not created, or parameters are incorrectly set.
TC_DS_ERROR_DOC_NO_INIT: The whiteboard module is not initialized.
TC_DS_ERROR_DOC_NO_SINK: The callback object is not set.
TC_DS_ERROR_DOC_NO_SESSION_JOIN: The current user has not joined the
session of the whiteboard component.
TC_DS_ERROR_DOC_USER_OFFLINE: A user is disconnected.
TC_ERROR: other errors
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_MS
G_WB_XML_
ON_NEW_D
OC
Notification of returning
the ID of the new
whiteboard document.
Document ID 0 NULL
COMPT_MS
G_WB_ON_D
OC_NEW
Notification that a
whiteboard document is
successfully created or
the header of a
whiteboard document is
downloaded.
Recipient: all users
Document ID 0 NULL
3.5.2 wb_SetCurrentPage
Interface Description
Sets the current page.
After this interface is invoked, the current page is switched to a specified page. If the
specified document ID is valid and the page ID is 0, the current page is switched to the page
that was displayed at the previous time.
Interface Definition
int wb_SetCurrentPage(int nDocID, int nPageID)
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
36
Parameter Description
Parameter Type Description
nDocID Int Whiteboard document ID
nPageID int Page ID
Return Value TC_OK: success
TC_NULL_POINT: The conference is not created.
TC_DS_ERROR_DOC_NO_INIT: The document sharing module is not initialized.
TC_DS_ERROR_DOC_NO_SINK: The callback object is not set.
TC_DS_ERROR_DOC_NO_SESSION_JOIN: The current user has not joined the
session of the document sharing component.
TC_DS_ERROR_DOC_USER_OFFLINE: A user is disconnected.
TC_ERROR: other errors
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (pvoid)
COMPT_MSG_
WB_ON_CURR
ENT_PAGE_IN
D
Notification of
synchronously turning
pages.
The underlying layer
does not turn the
pages after receiving
the message and
requires the upper
layer to specify the
page to be turned to.
Other participants
may receive the
message and cannot
invoke the
synchronous page
switch interface again.
Recipient: If bSync is
1, all users receive
this message.
Document ID Page ID NULL
COMPT_MSG_
WB_ON_CURR
ENT_PAGE
Notification that the
current document or
page changes.
Recipient: If bSync is
0, the user who
invokes the interface
Document ID Page ID NULL
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
37
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (pvoid)
receives this message.
COMPT_MSG_
WB_ON_DRA
W_DATA_NOT
IFY
Notification of
updating the user
interface.
The current user may
receive the message
when the user
interface is updated.
After receiving the
message, the upper
layer invokes the
conf_wb_get_surface
bmp interface to
obtain data for user
interface rendering.
Recipient: all users
Document ID Page ID NULL
3.5.3 wb_NewPage
Interface Description
Creates a whiteboard page in a specified whiteboard document.
If the whiteboard page is successfully created, it will be the last page of the document. All
participants will receive a notification of creating a whiteboard page. The ID of the page to be
created is asynchronously returned by the COMPT_MSG_WB_XML_ON_NEW_PAGE
callback message.
Interface Definition
int wb_NewPage(int nDocID,int nWidth,int nHeight)
Parameter Description
Parameter Type Description
nDocID int Whiteboard document ID
nWidth int Width of the page to be created (unit: twip)
nHeight int Height of the page to be created (unit: twip)
Return Value TC_OK: success
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
38
TC_NULL_POINT: The conference is not created.
TC_DS_ERROR_DOC_NO_INIT: The document sharing module is not initialized.
TC_DS_ERROR_DOC_NO_SINK: The callback object is not set.
TC_DS_ERROR_DOC_NO_SESSION_JOIN: The current user has not joined the
session of the document sharing component.
TC_DS_ERROR_DOC_USER_OFFLINE: A user is disconnected.
TC_ERROR: other errors
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_MSG_
WB_XML_ON_
NEW_PAGE
Notification of
returning the ID of the
new page.
Document ID Page ID NULL
COMPT_MSG_
WB_ON_PAGE_
NEW
Notification that a
page is successfully
created or the header
of a page is
downloaded.
Recipient: all users
Document ID Page ID NULL
COMPT_MSG_
WB_ON_DRAW
_DATA_NOTIFY
Notification of
updating the user
interface.
After receiving the
message, the upper
layer invokes the
conf_wb_get_surfaceb
mp interface to obtain
data for user interface
rendering.
Recipient: all users
Document ID Page ID NULL
COMPT_MSG_
WB_ON_CURRE
NT_PAGE_IND
Notification that the
current document or
page changes.
Recipient: all users
Document ID Page ID NULL
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
39
3.6 Annotation
3.6.1 annot_CreateStart
Interface Description
Starts to create an annotation.
The DS_ANNOT_TYPE_DRAWING and DS_ANNOT_TYPE_CUSTOMER annotations
are supported and created through this interface.
Interface Definition
int Annot_CreateStart(int ciid, int docid, int pageid, int type, int subType, float x, float y)
Parameter Description
Parameter Type Description
ciid COMPON
ENT_IID
Component ID
Currently, only the document sharing and whiteboard
components support the annotation function.
docid int ID of the document where an annotation is to be created
pageid int ID of the page where an annotation is to be created
type int Main annotation type
Currently, only DS_ANNOT_TYPE_DRAWING and
DS_ANNOT_TYPE_CUSTOMER are supported.
subType int Annotation sub type, including sub types of
DS_ANNOT_TYPE_DRAWING and types registered
through the Annot_RegCustomerType interface
x float Horizontal coordinate of the start point for creating an
annotation
The start point is the mouse clicking point or the upper left
corner of a picture annotation. The unit of the point is twip.
The value of the point is obtained when the page is not
zoomed in or out.
The values of the offset downward and rightward are
positives.
y float Vertical coordinate of the start point for creating an
annotation
The start point is the mouse clicking point or the upper left
corner of a picture annotation. The unit of the point is twip.
The value of the point is obtained when the page is not
zoomed in or out.
The values of the offset downward and rightward are
positives.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
40
Return Value TC_OK: success
TC_NULL_POINT: The conference is not created, or parameters are incorrectly set.
TC_DS_ERROR_DOC_NO_INIT: The document sharing module is not initialized.
TC_DS_ERROR_DOC_NO_SINK: The callback object is not set.
TC_DS_ERROR_DOC_NO_SESSION_JOIN: The current user has not joined the
session of the document sharing component.
TC_DS_ERROR_DOC_USER_OFFLINE: A user is disconnected.
TC_DS_ERROR_DOC_NOTEXIST: The document does not exist.
TC_DS_ERROR_PAGE_NOTEXIST: The page does not exist.
TC_ANNOT_ERROR_CUSTOMERTYPE_NOTEXIST: The annotation type is not
defined.
TC_ERROR: other errors
3.6.2 annot_CreateDrawingUpdate
Interface Description
Updates data of the DS_ANNOT_TYPE_DRAWING annotations during annotation creation.
After the interface is invoked, the component layer updates the dotted box during annotation
creation and reports the changed interface data to the application layer.
Interface Definition
int Annot_CreateDrawingUpdate(int ciid, float x, float y)
Parameter Description
Parameter Type Description
ciid COMPONENT_II
D
Component ID
Currently, only the document sharing and
whiteboard components support the annotation
function.
x float Horizontal coordinate
Y float Vertical coordinate
Return Value TC_OK: success
TC_NULL_POINT: The conference is not created, or parameters are incorrectly set.
TC_ERROR: other errors
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
41
3.6.3 annot_CreateCustomerUpdate
Interface Description
Updates customized data of the DS_ANNOT_TYPE_DRAWING annotations during
annotation creation.
After the interface is invoked, the component layer updates the dotted box during annotation
creation and reports the changed interface data to the application layer.
Interface Definition
int annot_CreateCustomerUpdate(int ciid, int localIndex, int picFormat, int left, int right, int top, int bottom, String filename)
Parameter Description
Parameter Type Description
ciid int Component ID
Currently, only the document sharing and
whiteboard components support the annotation
function.
localIndex int Localized image index
picFormat int Image format
left int Horizontal coordinate of the upper left corner
right int Vertical coordinate of the upper left corner
top int Horizontal coordinate of the lower right corner
bottom int Vertical coordinate of the lower right corner
filename String Image name
Return Value TC_OK: success
TC_NULL_POINT: The conference is not created, or parameters are incorrectly set.
TC_ERROR: other errors
3.6.4 annot_CreateDone
Interface Description
Finishes creating an annotation.
The DS_ANNOT_TYPE_DRAWING and DS_ANNOT_TYPE_CUSTOMER annotations
are supported and the creation finishes only after this interface is invoked. All other participants will receive a notification of creating an annotation.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
42
Interface Definition
int annot_CreateDone(int ciid, boolean bCancel)
Parameter Description
Parameter Type Description
ciid int Component ID
Currently, only the document sharing and whiteboard
components support the annotation function.
bCancel int Creation cancellation or completion
The options are as follows:
0: creation completion
1: creation cancellation
When an annotation is created, it is added to the creation
page. When the annotation creation cancels, the annotation
is deleted.
Return Value TC_OK: success
TC_NULL_POINT: The conference is not created.
TC_ERROR: other errors
3.6.5 annot_HittestPoint
Interface Description
Tests whether a point falls on an annotation.
If the point falls on the annotation, the annotation ID, type, and location of the point are
returned.
Interface Definition
int annot_HittestPoint(int ciid, int docId, int pageId, int x, int y, int hitMode, int userId, int reDraw)
Parameter Description
Parameter Type Description
ciid int Component ID
Currently, only the document sharing and whiteboard
components support the annotation function.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
43
Parameter Type Description
Docid Int Document ID
Pageid Int Page ID
(x,y) Int Test point (unit: twip)
The coordinate of the point must be tested when the
page is not zoomed in or out.
hitMode int Test condition
userId int User ID
This parameter is valid only when hitMode is set to
DS_HITTEST_MODE_OTHERS or
DS_HITTEST_MODE_SOMEONE.
reDraw int Indicates whether to redraw the annotation.
Return Value TC_OK: success
TC_NULL_POINT: The conference is not created.
TC_ERROR: other errors
3.6.6 annot_Delete
Interface Description
Deletes an annotation.
Interface Definition
int annot_Delete(int ciid)
Parameter Description
Parameter Type Description
ciid int Component ID
Currently, only the document sharing and whiteboard
components support the annotation function.
Return Value TC_OK: success
TC_NULL_POINT: The conference is not created.
TC_DS_ERROR_DOC_NO_INIT: The document sharing module is not initialized.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
44
TC_DS_ERROR_DOC_NO_SINK: The callback object is not set.
TC_DS_ERROR_DOC_NO_SESSION_JOIN: The current user has not joined the
session of the document sharing component.
TC_DS_ERROR_DOC_USER_OFFLINE: A user is disconnected.
TC_DS_ERROR_DOC_NOTEXIST: The document does not exist.
TC_DS_ERROR_PAGE_NOTEXIST: The page does not exist.
TC_ERROR: other errors
3.7 Video
3.7.1 video_GetDeviceCount
Interface Description
Asynchronously returns the number of video devices through the
COMPT_MSG_VIDEO_ON_GETDEVICE_NUM callback message.
As a reference for the video_GetDeviceInfo interface, the interface obtains the number of
video devices owned by the current user.
This interface can be used to obtain the number of video devices owned by the current user after the
video module has been loaded.
Interface Definition
int video_GetDeviceCount()
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_MSG_VID
EO_ON_GETDEVIC
E_NUM
Notification of
returning the
number of video
devices.
Number of
video devices.
0 NULL
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
45
3.7.2 video_GetDeviceInfo
Interface Description
Asynchronously obtains the device information list through the
COMPT_MSG_VIDEO_ON_GETDEVICE_INFO callback message. This interface obtains
the information about video devices owned by the current user.
This interface can be used to obtain the number of video devices owned by the current user after the
video module has been loaded.
Interface Definition
int video_GetDeviceInfo()
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked. \
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_MSG
_VIDEO_ON_
GETDEVICE_
INFO
Notification of
returning the
number of
video devices.
Index Device ID "<?xml
version=\"1.0\"
encoding=\"UTF-8\"
standalone=\"yes\"?>
\
<MSG type =
\"%s\"> \
<version>%d</versio
n> \
<userid>%u</userid
> \
<deviceID>%u</devi
ceID> \
<deviceName>%s</d
eviceName> \
<status>%d</status>
\
</MSG>"
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
46
3.7.3 video_Open
Interface Description
Enables the current user's camera.
Interface Definition
int video_Open(int nDeviceID)
Parameter Description
Parameter Type Description
dwDeviceID int Video device ID
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (pvoid)
COMPT_MS
G_VIDEO_O
N_SWITCH
Notification
of video
change on the
video
devices.
Recipient: all
users
0: The video
is closed.
1: The video
is being
played.
2: The paused
video is
resumed.
4: The video
is paused.
User ID Device ID
"<?xml
version=\"1.0\"
encoding=\"UTF-8\"
standalone=\"yes\"?
> \
<MSG type =
\"%s\"> \
<version>%d</versi
on> \
<deviceID>%u</dev
iceID> \
</MSG>"
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
47
3.7.4 video_Close
Interface Description
Disables the current user's camera.
Interface Definition
int video_Close(int nDeviceID,boolean bCloseAll)
Parameter Description
Parameter Type Description
dwDeviceID int Video device ID
bCloseAll boolean Indicates whether to disable all cameras.
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
Callback Message
Message ID
Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (pvoid)
COMPT_M
SG_VIDEO
_ON_SWIT
CH
Notification of
video change
on the video
devices.
Recipient: all
users
0: The video is
closed.
1: The video is
being played.
2: The paused
video is
resumed.
4: The video is
paused.
User ID Device ID
"<?xml
version=\"1.0\"
encoding=\"UTF-8\
"
standalone=\"yes\"?
> \
<MSG type =
\"%s\"> \
<version>%d</vers
ion> \
<deviceID>%u</de
viceID> \
</MSG>"
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
48
3.7.5 video_Pause
Interface Description
Pauses a video feed of the current user or another user. If the current's user's video is paused,
video collection for the current user stops. If the video of another user is paused, the current
user stops receiving video data from the specified video device of another user.
Interface Definition
int video_Pause(int nUserID,int nDeviceID)
Parameter Description
Parameter Type Description
nUserID int User ID ranging from 1 to 2147483647
dwDeviceID int ID of the device on which the video is paused
bWizPause BOOL TRUE: video pause during the video
navigation
FALSE: video pause when the video
navigation is not enabled
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (pvoid)
COMPT_MS
G_VIDEO_O
N_SWITCH
Notification
of video
change on
the video
devices.
Recipient: all
users
0: The video
is closed.
1: The video
is being
played.
2: The
paused
video is
resumed.
4: The video
is paused.
User ID Device ID
"<?xml
version=\"1.0\"
encoding=\"UTF-8\"
standalone=\"yes\"?> \
<MSG type = \"%s\">
\
<version>%d</versio
n> \
<deviceID>%u</devi
ceID> \
</MSG>"
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
49
Reference
conf_video_resume
3.7.6 video_Resume
Interface Description
Resumes a paused video feed of the current user or another user.
Interface Definition
int video_Resume(int nUserID,int nDeviceID)
Parameter Description
Parameter Type Description
nUserID int User ID ranging from 1 to 2147483647
dwDeviceID int ID of the device on which the video is resumed
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (pvoid)
COMPT_MSG
_VIDEO_ON_
SWITCH
Notification
of video
change on the
video
devices.
Recipient: all
users
0: The video
is closed.
1: The video
is being
played.
2: The
paused video
is resumed.
4: The video
is paused.
User ID Device ID
"<?xml
version=\"1.0\"
encoding=\"UTF-8\"
standalone=\"yes\"?
> \
<MSG type =
\"%s\"> \
<version>%d</versi
on> \
<deviceID>%u</de
viceID> \
</MSG>"
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
50
3.7.7 video_SetParam
Interface Description
Sets video parameters.
The video parameters must be set before a video is opened; otherwise, the video parameters
are automatically set to the default values.
Interface Definition
int video_SetParam(int devicdID,int xRes, int yRes, int nFrame)
Parameter Description
Parameter Type Description
dwDeviceID int Device ID
xRes int Video width
yRes int Video height
nFrame int Video frame rate
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
3.7.8 video_GetParam
Interface Description
Obtains video parameters through the callback message.
The video parameters can be obtained only after an engine is successfully created.
Interface Definition
int video_GetParam(int nUserID,int nDeviceID)
Parameter Description
Parameter Type Description
nUserID int User ID
nDeviceID int Device ID
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
51
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_MS
G_VIDEO_G
ETPARAM
Notification
of returning
the number
of video
devices.
Device ID 0 "<?xml version=\"1.0\"
encoding=\"UTF-8\"
standalone=\"yes\"?> \
<MSG type = \"%s\"> \
<version>%d</version>
\
<deviceID>%u</device
ID> \
<xResolution>%d</xRe
solution> \
<yResolution>%d</yRe
solution> \
<nFrameRate>%d</nFr
ameRate> \
<nBitRate>%d</nBitRa
te> \
<nRawtype>%d</nRaw
type> \
<nFecValue>%d</nFec
Value> \
</MSG>"
3.7.9 video_Attach
Interface Description
Binds a specified user's video to the window. If the current user's video is bound to the
window, the current user can preview the video. If another user's video is bound to the
window, the current user is connected to another user's video channels to watch the video in
the window.
Interface Definition
int video_Attach(int userid, int deviceid,int IndexWnd,int bHigh,int showmode)
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
52
Parameter Description
Parameter Type Description
userid int User ID ranging from 1 to 2147483647
deviceid int Device ID
IndexWnd int Window handle
bHigh int Indicates whether to connect the current user to
high-bit-rate or low-bit-rate video channels. (The
current user is connected to high-bit-rate
channels by default.)
showmode int Video display mode
The options are as follows:
0: Display video in full window.
1: Display video based on the video ratio.
Other parts are displayed in black.
2: Crop video with reference to the window
size.
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
3.7.10 video_Detach
Interface Description
Unbinds a specified user's video from the window.
Interface Definition
int video_Detach(int userid, int deviceid,boolean leavechannel)
Parameter Description
Parameter Type Description
userid int User ID ranging from 1 to 2147483647
deviceid int Device ID
IndexWnd int Window handle
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
53
Parameter Type Description
leavechannel boolean Indicates whether to disconnect the video
channels from the user when a specified user's
video is unbound from the window. (The video
channels are disconnected by default.)
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
3.7.11 video_SetCaptureRotate
Interface Description
Sets the video rotation angle.
This interface applies only to the mobile client.
Interface Definition
int video_SetCaptureRotate(int nUserID,int nDeviceID,int rotate)
Parameter Description
Parameter Type Description
dwDeviceID uint32 Device ID
iPicRotate int Device rotation angle
enum{
VIDEO_ROTATE_0 = 0 , //The
video does not rotate.
VIDEO_ROTATE_90 = 90 , //The
video rotates 90° counterclockwise.
VIDEO_ROTATE_180 = 180, //The
video rotates 180° counterclockwise.
VIDEO_ROTATE_270 = 270 //The video
rotates 270° counterclockwise.};
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
54
3.7.12 video_SetEncodeMaxResolution
Interface Description
Sets the maximum encoding resolution.
If the maximum encoding resolution is not set, retain the default setting. The resolution is set
to 640 x 480 on the Android operating system.
Interface Definition
int video_SetEncodeMaxResolution(int xResolution,int yResolution)
Parameter Description
Parameter Type Description
xResolution int Width of the maximum encoding resolution
yResolution int Height of the maximum encoding resolution
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
3.8 Audio
3.8.1 audio_SetParam
Interface Description
Sets audio parameters.
Interface Definition
int audio_SetParam(int mix,int codec)
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
55
Parameter Description
Parameter Type Description
mix int Audio mixing mode
The options are as follows:
1: client audio mixing
2: server audio mixing
Codec int If mix is set to 1, Codec is set to AUDIO_CODEC_iLBC
by default. If mix is set to 2, Codec is set to
AUDIO_CODEC_PCMA by default.
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_MSG
_AUDIO_ON_
AUDIO_DEVI
CE_STATUS_
CHANGE
Callback
message received
by other
participants
when a
participant of a
conference
performs an
operation on the
local
microphone.
New participants
receive a
notification
about the status
of devices of
other participants
who have joined
the conference
earlier.
int value
(device type):
AUDIO_MIC
= 0 or
AUDIO_SPEA
KER = 1
long value
(device status):
AUDIO_STATU
S_OPEN = 0,
AUDIO_ST
ATUS_CLOSE=
1,
AUDIO_ST
ATUS_MUTE=2
,
AUDIO_ST
ATUS_NO_DE
VICE=3
ID of the user
whose device
status
changes
"<?xml
version=\"1.0\
"
encoding=\"U
TF-8\"
standalone=\"
yes\"?> \
<MSG type =
\"%s\"> \
<version>%d
</version> \
<devicetype>
%d</devicety
pe> \
<devicestatus
>%d</devices
tatus> \
<userID>%u
</userID> \
</MSG>"
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
56
When the audio engine is initialized, the local client detects the number of local devices. When the
number of microphones is 0, the message
COMPT_MSG_AUDIO_ON_AUDIO_DEVICE_STATUS_CHANGE is sent to notify other clients that
no local microphones are available. When the number of microphones exceeds 0, the message
COMPT_MSG_AUDIO_ON_AUDIO_DEVICE_STATUS_CHANGE is sent to notify other clients that
the local microphone is disabled.
3.8.2 audio_OpenMic
Interface Description
Enables an audio input device.
Two modes, synchronous and asynchronous, are available. If the
conf_audio_set_max_open_devic interface is invoked, or the
COMPT_MSG_AUDIO_ON_AUDIO_MAX_OPEN_DEVICE callback message is reported,
the synchronous mode is used; otherwise, the asynchronous mode is used.
Interface Definition
int audio_OpenMic(int micID)
Parameter Description
Parameter Type Description
micID int ID of the audio input device
Return Value
In synchronous mode, if TC_OK is returned, the interface is successfully invoked. If other
values are returned, the interface fails to be invoked.
In asynchronous mode, if TC_OK is returned, the asynchronous operation is successfully sent,
and whether the interface is successfully invoked is determined by the callback message. If
other values are returned, the interface fails to be invoked.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
57
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_MS
G_AUDIO_O
N_AUDIO_D
EVICE_STA
TUS_CHAN
GE
Callback message
received by other
participants when
a participant of a
conference
performs an
operation on the
local microphone.
New participants
receive a
notification about
the status of
devices of other
participants who
have joined the
conference earlier.
Recipient: all
users
int value
(device type):
AUDIO_MIC
= 0 or
AUDIO_SPE
AKER = 1
long value
(device status):
AUDIO_STAT
US_OPEN = 0,
AUDIO_S
TATUS_CLOS
E=1,
AUDIO_S
TATUS_MUT
E=2,
AUDIO_S
TATUS_NO_D
EVICE=3
ID of the user
whose device
status changes
"<?xml
version=\"1.0\"
encoding=\"UTF
-8\"
standalone=\"yes
\"?> \
<MSG type =
\"%s\"> \
<version>%d</v
ersion> \
<devicetype>%d
</devicetype> \
<devicestatus>%
d</devicestatus>
\
<userID>%u</us
erID> \
</MSG>"
COMPT_MS
G_AUDIO_O
N_AUDIO_O
PEN_MIC
Callback message
of asynchronously
opening a
microphone.
Only when the
maximum number
of opened
microphones is
restricted, the
asynchronous
operation can be
performed.
Recipient: user
who invokes the
interface
int value
For details,
see the
definition in
TcResult.
N/A N/A
3.8.3 audio_CloseMic
Interface Description
Disables an audio input device.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
58
Interface Definition
int audio_CloseMic()
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
Callback Message
Message ID
Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_M
SG_AUDIO
_ON_AUDI
O_DEVICE
_STATUS_
CHANGE
Callback message
received by other
participants when
a participant of a
conference
performs an
operation on the
local microphone.
New participants
receive a
notification about
the status of
devices of other
participants who
have joined the
conference earlier.
Recipient: all users
int value
(device type):
AUDIO_MIC
= 0 or
AUDIO_SPE
AKER = 1
long value
(device status):
AUDIO_STATU
S_OPEN = 0,
AUDIO_ST
ATUS_CLOSE=
1,
AUDIO_ST
ATUS_MUTE=2
,
AUDIO_ST
ATUS_NO_DE
VICE=3
ID of the user
whose device
status changes
"<?xml
version=\"1.0\"
encoding=\"UTF
-8\"
standalone=\"yes
\"?> \
<MSG type =
\"%s\"> \
<version>%d</v
ersion> \
<devicetype>%d
</devicetype> \
<devicestatus>%
d</devicestatus>
\
<userID>%u</us
erID> \
</MSG>"
3.8.4 audio_MuteMic
Interface Description
Mutes an audio input device.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
59
Interface Definition
int audio_MuteMic()
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
Callback Message
Message ID
Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_M
SG_AUDIO
_ON_AUDI
O_DEVICE
_STATUS_
CHANGE
Callback message
received by other
participants when
a participant of a
conference
performs an
operation on the
local microphone.
New participants
receive a
notification about
the status of
devices of other
participants who
have joined the
conference earlier.
Recipient: all users
int value
(device type):
AUDIO_MIC
= 0 or
AUDIO_SPEA
KER = 1
long value
(device status):
AUDIO_STAT
US_OPEN = 0,
AUDIO_S
TATUS_CLOS
E=1,
AUDIO_S
TATUS_MUT
E=2,
AUDIO_S
TATUS_NO_D
EVICE=3
ID of the user
whose device
status changes
"<?xml
version=\"1.0\"
encoding=\"UTF
-8\"
standalone=\"yes
\"?> \
<MSG type =
\"%s\"> \
<version>%d</v
ersion> \
<devicetype>%d
</devicetype> \
<devicestatus>%
d</devicestatus>
\
<userID>%u</us
erID> \
</MSG>"
3.8.5 audio_UnMuteMic
Interface Description
Unmutes an audio input device.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
60
Interface Definition
int audio_UnMuteMic()
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_MSG_A
UDIO_ON_AUDI
O_DEVICE_STA
TUS_CHANGE
Callback
message
received by
other
participants
when a
participant of a
conference
performs an
operation on
the local
microphone.
New
participants
receive a
notification
about the status
of devices of
other
participants
who have
joined the
conference
earlier.
Recipient: all
users
int value
(device type):
AUDIO_MIC
= 0 or
AUDIO_SPE
AKER = 1
long value
(device
status):
AUDIO_STA
TUS_OPEN
= 0,
AUDIO
_STATUS_C
LOSE=1,
AUDIO
_STATUS_M
UTE=2,
AUDIO
_STATUS_N
O_DEVICE=
3
ID of the user
whose device
status changes
"<?xml
version=\"1.0\"
encoding=\"UTF
-8\"
standalone=\"yes
\"?> \
<MSG type =
\"%s\"> \
<version>%d</v
ersion> \
<devicetype>%d
</devicetype> \
<devicestatus>%
d</devicestatus>
\
<userID>%u</us
erID> \
</MSG>"
3.8.6 audio_OpenSpeaker
Interface Description
Enables an audio output device.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
61
Interface Definition
int audio_OpenSpeaker(int speakerID)
Parameter Description
Parameter Type Description
speakerID int Output device ID
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
3.8.7 audio_CloseSpeaker
Interface Description
Disables an audio output device.
Interface Definition
int audio_CloseSpeaker()
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
3.8.8 audio_MuteSpeaker
Interface Description
Mutes an audio output device.
Interface Definition
int audio_MuteSpeaker()
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
62
3.8.9 audio_UnMuteSpeaker
Interface Description
Unmutes an audio output device.
Interface Definition
int audio_UnMuteSpeaker()
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
3.9 Instant Message
3.9.1 chat_SendMsgEx
Interface Description
Extended interface for sending instant messages (IMs).
Compared with chat_SendMsg, the interface includes an extra parameter of the user name of the IM
sender. The chat_SendMsg interface obtains the user name of the IM sender from the IM component and
returns it to the IM recipient at the ISV application layer through the callback message. However, the
chat_SendMsgEx interface transmits the user name of the IM sender from the UI layer to the component
layer and returns it to the IM recipient at the UI layer through the callback message, preventing the
component layer from returning the user name before modification to the ISV application layer due to
the failure to obtain the modified user name after a user joins the conference.
Interface Definition
int chat_SendMsgEx(int nType, int nDstID, String strMsg, String dispSenderName)
Parameter Description
Parameter Type Description
nType int IM type
The options are as follows:
CHAT_TYPE_PUBLIC: public IMs
CHAT_TYPE_GROUP: one-to-one IMs
CHAT_TYPE_PRIVATE: group IMs
EC Platform Cloud
SDK Interface Reference (Android) 3 Description of the Android ConfInstance Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
63
Parameter Type Description
nUserID uint32 User ID of the recipient of one-to-one IMs,
ranging from 1 to 2147483647
Not involved for public IMs
Group ID for group IMs
strMsg String IM content
dispSenderName String User name of the IM sender
The maximum length is 48 bytes. If the user
name exceeds 48 bytes, bytes after the 47th byte
are discarded, and \0 is added to the 47th byte.
Return Value
If TC_OK is returned, the interface is successfully invoked. If other values are returned, the
interface fails to be invoked.
Callback Message
Message ID Description Value Description (nValue1)
Value Description (nValue2)
Return Parameter (xml)
COMPT_MS
G_CHAT_O
N_RECV_M
SG
Notification
of IM
reception
Recipient:
recipient of
the IM
message
0 0 "<?xml version=\"1.0\"
encoding=\"UTF-8\"
standalone=\"yes\"?> \
<MSG type = \"%s\"> \
<version>%d</version>
\
<groupID>%d</groupI
D> \
<userid>%u</userid> \
<username>%s</userna
me> \
<msgtype>%d</msgtyp
e> \
<servertime>%lld</serv
ertime> \
</MSG>"
EC Platform Cloud
SDK Interface Reference (Android) 4 Return Code
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
64
4 Return Code
This chapter describes the return codes when the type of the return codes is TcResult.
#define TcResult int
Table 4-1 Return codes
Enumeration Value Value Description Remarks
TC_OK 0 Correct.
TC_WARNING 1 Alarm.
TC_ERROR 2 Error.
TC_FAILURE 3 Failure
TC_NULL_POINT 4 Null pointer.
TC_CALL_TIMEOUT 5 Invocation timeout.
TC_PARAM_ERROR 6 Incorrect parameter.
TC_BUFFER_TOO_SHORT 7 Insufficient memory.
TC_XML_PARAM_ERROR 8 XML parameter error.
TC_NO_PRIVILEGE 9 No permission.
TC_FUNC_NOT_SUPPORT 10 Indicates that the invoked
interface is not supported
or has not been
implemented.
TC_MODULE_NOT_LOAD 11 Indicates that the module
is not loaded.
EC Platform Cloud
SDK Interface Reference (Android) 4 Return Code
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
65
Enumeration Value Value Description Remarks
Error codes at the bottom layer
TC_IMCC_RESULT_BASE 100 Base of error number of
the T.120 protocol stack.
The user who
invokes the
interface may
ignore the
enumeration
value.
TC_IMCC_RESULT_USER_
REJECTED
101 Indicates that the user's
request is rejected.
TC_IMCC_RESULT_NETW
ORK_ERROR
102 Network error.
TC_IMCC_RESULT_VERSI
ON_NOT_MATCH
103 Indicates that the version
does not match.
TC_IMCC_RESULT_PROTO
COL_NOT_RIGHT
104 Communications protocol
error.
TC_IMCC_RESULT_TOO_
MANY_CONNECTIONS
105 Indicates that the number
of connections on the
server exceeds the
maximum.
TC_IMCC_RESULT_EXPIR
ED
106 Indicates that the license
expires.
TC_IMCC_RESULT_DOMAI
N_TERMINATED
107 Indicates that the
conference has ended.
TC_IMCC_RESULT_SERVE
R_CONN_FAILED
108 Failure to connect to the
upper-level server.
The user who
invokes the
interface may
ignore the
enumeration
value.
TC_IMCC_RESULT_SYS_S
HUTINGDOWN
109 Indicates that the
connection is
disconnected.
TC_IMCC_RESULT_DOMAI
N_MERGING
110 Conference status error. The user who
invokes the
interface may
ignore the
enumeration
value.
TC_IMCC_RESULT_NO_SU
CH_USER
111 Detection that a user does
not exist during the
authentication.
EC Platform Cloud
SDK Interface Reference (Android) 4 Return Code
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
66
Enumeration Value Value Description Remarks
TC_IMCC_RESULT_CHAN
NEL_NOT_AVAILABLE
112 Indicates that the number
of channels in a
conference reaches the
threshold.
TC_IMCC_RESULT_TOKEN
_AUTH_FAIL
115 The user who
invokes the
interface may
ignore the
enumeration
value.
TC_IMCC_RESULT_POOL_
NOT_AVAILABLE
124 Indicates that the number
of enabled microphones
for the audio module
exceeds the upper limit.
The user who
invokes the
interface may
ignore the
enumeration
value.
TC_IMCC_RESULT_AUTH_
FAILED
126 Authentication failure.
TC_IMCC_RESULT_UNKN
OWN
127 Unknown error.
TC_IMCC_RESULT_AUTH_
REDIRECT
128 The user who
invokes the
interface may
ignore the
enumeration
value.
TC_IMCC_RESULT_QUER
Y_PARENT_OR_TOP_AGE
NT_EXPIRED
129 Cluster service exception. The user who
invokes the
interface may
ignore the
enumeration
value.
TC_IMCC_RESULT_DOMAI
N_LOCKED 130 Locked conference. The user who
invokes the
interface may
ignore the
enumeration
value.
TC_IMCC_RESULT_AUTH_
TIMEOUT
131 Authentication timeout. The user who
invokes the
interface may
ignore the
enumeration
value.
EC Platform Cloud
SDK Interface Reference (Android) 4 Return Code
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
67
Enumeration Value Value Description Remarks
TC_IMCC_RESULT_AUTH_
KEY_NOT_AVAILABLE
132 Incorrect conference
password.
The user who
invokes the
interface may
ignore the
enumeration
value.
TC_IMCC_RESULT_TOO_
MANY_CONFERENCE
133 Indicates that the number
of conferences exceeds the
upper limit.
The user who
invokes the
interface may
ignore the
enumeration
value.
TC_IMCC_RESULT_TOO_
MANY_CONFERENCE_USE
R
134 Indicates that the number
of conference participants
exceeds the upper limit.
The user who
invokes the
interface may
ignore the
enumeration
value.
TC_IMCC_RESULT_NOT_D
ATA_USER_LICENSE
135 Indicates that the
participant is not allowed
to join the conference
because of insufficient
data licenses.
The user who
invokes the
interface may
ignore the
enumeration
value.
TC_IMCC_RESULT_AUTH_
LINCENSE_TIMEOUT
136 Failure to join conference
because of a license
authentication timeout.
TC_IMCC_RESULT_SVR_N
OT_ALLOW
137 Failure to join a
conference because of an
invalid server area.
TC_IMCC_RESULT_USER_
NOT_ALLOW
138 Indicates that the user is
already in the conference.
copy from IMCC_ERROR
TC_IMCC_ERROR_BASE 200
copy from IMCC_REASON
TC_IMCC_REASON_BASE 300
TC_IMCC_REASON_USER_
INITIATED
300 Indicates that the user
normally leaves the
conference.
TC_IMCC_REASON_USER_
EJECTED
301 Indicates that the user is
kicked out.
TC_IMCC_REASON_TOKE
N_PURGED
302
EC Platform Cloud
SDK Interface Reference (Android) 4 Return Code
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
68
Enumeration Value Value Description Remarks
TC_IMCC_REASON_SYS_S
HUTTINGDOWN
303 System error.
TC_IMCC_REASON_NETW
ORK_ERROR
304 Network error.
TC_IMCC_REASON_TIME_
OUT
305 Timeout.
TC_IMCC_REASON_UNKN
OWN
306 Unknown error.
TC_IMCC_REASON_EXTE
ND_MAX_LICENSE
307
TC_IMCC_REASON_SYSTE
M_ERROR
308
TC_IMCC_REASON_USER_
OFFLINE
309 Indicates that the user is
offline.
Conference errors
TC_CONF_ERROR_NO_INI
T
400 Indicates that the
conference has not been
initialized.
TC_CONF_ERROR_REPEA
T_INIT
401 Repeated initialization.
TC_CONF_ERROR_REPEA
T_JOIN
402 Indicates that the user
joins conference
repeatedly.
TC_CONF_ERROR_NO_JOI
N
403 Indicates that the user has
not joined the conference.
TC_CONF_ERROR_NO_LO
AD_COM
404 Indicates that the
component has not been
loaded.
TC_CONF_ERROR_DATA_
TOO_LAGE
405 Indicates that the data size
is too large.
TC_CONF_ERROR_SEND_T
OO_FAST
406 Excessive sending speed.
TC_CONF_ERROR_ALREA
DY_TERMINATE
407 Indicates that the
conference has ended.
TC_CONF_ERROR_ALREA
DY_LEAVE
408 Indicates that the user has
left the conference.
TC_CONF_ERROR_COM_L
OADED
409 Indicates that the
component has been
loaded.
EC Platform Cloud
SDK Interface Reference (Android) 4 Return Code
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
69
Enumeration Value Value Description Remarks
TC_CONF_ERROR_CON_U
NLOADED
410 Indicates that the
component has been
uninstalled.
TC_CONF_ERROR_DISCON
NECT_EXC
411 Indicates that the
conference is
disconnected.
TC_CONF_ERROR_CONF_I
NFO
412 Incorrect parameter.
TC_CONF_ERROR_CONF_
NOT_INIT
413 Indicates that the
conference environment
has not been initialized.
TC_CONF_ERROR_SELF_P
RESENTER
414 Indicates that the user has
been set to the presenter.
TC_CONF_ERROR_PHONE
_INIT
415 Indicates that the phone
has not been initialized.
TC_CONF_ERROR_PHONE
_JOIN
416 Failure to join the
conference call.
TC_CONF_ERROR_NO_ME
MORY
417 Memory application
failure.
TC_CONF_ERROR_PARAM
_INVALID 418 Invalid parameter.
TC_CONF_ERROR_ALREA
DY_NEW
419 Indicates that the same
conference already exists.
TC_CONF_ERROR_PAAS_I
D_INVALID
420 Incorrect conference ID in
PaaS mode. The first 12
digits of the conference ID
must be empty.
IM module
TC_CHAT_ERROR_INVALI
DSESSION 1001 Indicates that the channel
has not been added.
TC_CHAT_ERROR_INVALI
DUSERID
1002 Incorrect user ID.
TC_CHAT_ERROR_INVALI
DGROUPID
1003 Incorrect group ID.
TC_CHAT_ERROR_TOO_M
ANY_CHAR
1004 A character string
exceeding the length
threshold.
TC_CHAT_ERROR_TOO_M
IN_INTERVAL
1005 Over-short sending
interval.
EC Platform Cloud
SDK Interface Reference (Android) 4 Return Code
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
70
Enumeration Value Value Description Remarks
Document module error codes
TC_DS_ERROR_DOC_NOT
EXIST
1101 Indicates that the
document does not exist.
TC_DS_ERROR_PAGE_NO
TEXIST
1102 Indicates that the page
does not exist.
TC_DS_ERROR_PARAM_N
OTEXIST
1103 Indicates that the
parameter does not exist.
TC_DS_ERROR_DE_NOTE
XIST
1104 Indicates that the element
does not exist.
TC_DS_ERROR_DOC_ALR
EADYEXIST
1105 Indicates that the
document exists.
TC_DS_ERROR_PAGE_ALR
EADYEXIST
1106 Indicates that the page
exists.
TC_DS_ERROR_NOT_VALI
D_CWP
1107 Indicates that the .cwp file
is invalid.
TC_ANNOT_ERROR_CUST
OMERTYPE_NOTEXIST
1108 Indicates that the type of
the user-defined annotation
does not exist.
TC_DS_ERROR_PROP_NOT
_EXIT
1109 Indicates that the
document property does
not exist.
TC_DS_ERROR_DOC_ALR
EADY_OPEN
1110 Indicates that the
document has been
opened.
TC_DS_ERROR_DOC_NO_I
NIT
1111 Indicates that the module
has not been initialized.
TC_DS_ERROR_DOC_NO_S
INK
1112 Indicates that the callback
interface has not been set.
The user who
invokes the
interface may
ignore the
enumeration
value.
TC_DS_ERROR_DOC_NO_S
ESSION_JOIN
1113 Indicates that the channel
has not been added.
TC_DS_ERROR_DOC_USE
R_OFFLINE
1114 Indicates that the user is
offline.
TC_DS_ERROR_DOC_PRIN
TING
1115 Indicates that the
document is being printed.
TC_DS_ERROR_DOC_PAG
E_DOWN
1116 Indicates that the
document page data is
being downloaded.
EC Platform Cloud
SDK Interface Reference (Android) 4 Return Code
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
71
Enumeration Value Value Description Remarks
TC_DS_ERROR_DOC_FOR
MAT_ERROR
1117 Indicates that a saved
whiteboard file is opened
during document sharing,
or a shared and saved
document is loaded during
whiteboard sharing.
TC_DS_ERROR_DOC_PAG
E_NOT_UPLOAD
1118 Indicates that the page data
has not been uploaded to
the server, or the user who
shares the document is not
in the conference.
TC_DS_LOADER_ERROR_
COM
1121 Component object model
(COM) component error.
TC_DS_LOADER_ERROR_
NO_PAGE
1122 Indicates that no page
exists in a document.
TC_DS_LOADER_CANCEL
ED
1123 Indicates that printing is
canceled.
TC_DS_LOADER_NOT_SUP
PORT
1124 Incorrect document
format.
TC_DS_LOADER_OFFICE_
NOT_SUPPORT
1125 Incorrect Office version.
TC_DS_LOADER_ERROR_
TRANSFORM
1126 Document conversion
error.
TC_DS_LOADER_FILE_EM
PTY
1127 Empty document.
TC_DS_LOADER_FORMAT
_ERROR
1128 Incompatible document
format.
Indicates that a
saved
whiteboard file
is opened
during
document
sharing, or a
shared and
saved
document is
loaded during
whiteboard
sharing.
TC_DS_LOADER_TIMEOU
T
1129 Indicates that the
document load times out.
TC_DS_LOADER_PRINTER
_UNINSTALL
1130 Indicates that the virtual
printer has not been
installed.
EC Platform Cloud
SDK Interface Reference (Android) 4 Return Code
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
72
Enumeration Value Value Description Remarks
TC_DS_LOADER_PPT_THR
EAD_ERROR
1131 Indicates a thread error
when loading a .ppt file.
TC_DS_LOADER_PPT_LOA
D_ERROR
1132 Indicates a .ppt file loading
error.
TC_DS_LOADER_PAGE_O
VER_MAX
1133 Indicates that the number
of pages exceeds the upper
limit of 200.
TC_DS_LOADER_PRINTER
_ERROR
1134 Printer error.
TC_DS_LOADER_SERVICE
_ERROR
1135 Printing service error.
TC_DS_LOADER_PPT2003_
RUNNING
1136 Indicates that the
PowerPoint 2003 is
running and cannot be
loaded.
TC_DS_LOADER_NO_PER
MISSION
1137 Indicates that you have no
rights to open the
document.
TC_DS_LOADER_WPS_NO
T_INSTALLED
1138 Indicates that WPS Office
has not been installed.
TC_ANNOT_ERROR_LASE
R_EXIST
1140 Indicates that the laser pen
exists.
TC_ANNOT_ERROR_CUST
OMERTYPE_NOTEXIST
1141 Indicates that the type of
the user-defined annotation
does not exist.
Screen sharing
TC_AS_ERROR_UNKNOW 1201 Unknown error.
TC_AS_ERROR_INVALIDP
ARA
1202 Invalid parameter.
TC_AS_ERROR_INVALIDU
SER
1203 Invalid role.
TC_AS_ERROR_INVALIDS
ESSION
1204 Channel error.
TC_AS_ERROR_NULLCOM
HANDLE
1205 Module handle error.
TC_AS_ERROR_INVALIDS
TATE 1206 Sharing status error.
TC_AS_ERROR_INVALIDW
ND
1207 Incorrect window handle.
EC Platform Cloud
SDK Interface Reference (Android) 4 Return Code
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
73
Enumeration Value Value Description Remarks
TC_AS_ERROR_CREATET
ASKFAIL
1208 Failure to creating a
sharing task.
TC_AS_ERROR_USERDRO
PPED
1209 Indicates that a user is
disconnected.
TC_AS_ERROR_XMLERRO
R
1210 Read and write error in
an .xml document.
TC_AS_ERROR_MODULEL
OCKED
1211 Indicates that the module
is locked.
TC_AS_ERROR_WAITFIRS
TFRAME
1212 Indicates that the first data
frame has not been sent.
TC_AS_ERROR_UNSUPPO
RT
1213 Indicates that the current
version is not supported.
TC_AS_ERROR_FORBID_S
CALE
1214 Indicates that the operation
of zooming in is not
supported.
TC_AS_ERROR_MEM_ALL
OC_FAILED
1215 Memory allocation failure.
TC_AS_ERROR_NULLCTR
LHANDLE
1216 Empty screen sharing
handle.
TC_AS_ERROR_INVALIDC
HANNEL
1217 Invalid data channel.
TC_AS_ERROR_GDI_ALLO
C_FAILED 1218 Failure to apply for a
graphics device interface
(GDI) object.
TC_AS_ERROR_P2P_CONN
ECTION_FAILED
1219 P2P connection error.
TC_AS_ERROR_ANNOT_B
ASE
1250 Application sharing
annotation error.
TC_AS_ERROR_ANNOT_N
OTEXIST
1251 Indicates that the
document does not exist.
TC_AS_ERROR_ANNOT_P
AGE_NOTEXIST
1252 Indicates that the page
does not exist.
TC_AS_ERROR_ANNOT_P
ARAM_NOTEXIST
1253 Indicates that the
parameter does not exist.
TC_AS_ERROR_ANNOT_D
E_NOTEXIST
1254 Indicates that the element
does not exist.
TC_AS_ERROR_ANNOT_A
NNOT_ALREADYEXIST
1255 Indicates that the
document already exists.
TC_AS_ERROR_ANNOT_P
AGE_ALREADYEXIST 1256 Indicates that the page
already exists.
EC Platform Cloud
SDK Interface Reference (Android) 4 Return Code
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
74
Enumeration Value Value Description Remarks
TC_AS_ERROR_ANNOT_N
OT_VALID_CWP
1257 Indicates that the .cwp file
is invalid.
TC_AS_ERROR_ANNOT_C
USTOMERTYPE_NOTEXIS
T
1258 Indicates that the type of
the user-defined annotation
does not exist.
TC_AS_ERROR_SC_BASE 1270 Application collection
error.
TC_AS_ERROR_SC_UNKN
OW
1271 Unknown collection error.
TC_AS_ERROR_SC_GDI_O
BJECT
1272 Failure to create a GDI
object.
Video module
TC_AS_ERROR_SC_BASE 1300
TC_VIDEO_ERROR_WND_
NULL
1301 Empty window.
TC_VIDEO_ERROR_WND_I
SUSED
1302 Indicates that the window
is used.
TC_VIDEO_ERROR_DISCO
NNECT
1303 Indicates that the video is
disconnected.
TC_VIDEO_ERROR_CREAT
E_ENGINE
1305 Failure to create an engine.
TC_VIDEO_ERROR_NO_SE
SSION
1306 Indicates that no session is
available in video.
TC_VIDEO_ERROR_NO_VI
DEO_OBJ
1307 Indicates that no object is
available in video.
TC_VIDEO_ERROR_NO_TA
BLE
1308 Indicates that no idle table
is available for the video.
TC_VIDEO_ERROR_ALREA
DY_EXIST_OPENLIST
1309 Indicates that the device is
in the list of enabled
devices when a user
attempts to enable a
device.
TC_VIDEO_ERROR_COMP
ONENT_NOTREADY
1310 Indicates that the video
component is not ready.
TC_VIDEO_ERROR_DLL_U
NLOAD
1311 Indicates that the video
library has been
uninstalled.
TC_VIDEO_ERROR_NOTIN
_RESOLUTION_RANGE
1312 Indicates that the
resolution is out of the
specified range.
EC Platform Cloud
SDK Interface Reference (Android) 4 Return Code
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
75
Enumeration Value Value Description Remarks
TC_VIDEO_ERROR_RESOL
UTION_NOTSUPPORT
1313 Indicates that the
resolution is beyond the
device capabilities.
TC_VIDEO_ERROR_OVER_
MAX_OPENVIDEO
1314 Indicates that the number
of video channels exceeds
the upper limit.
TC_VIDEO_ERROR_SAME_
CAPBILITY_USED
1320 Indicates that a specified
capability is being used.
TC_VIDEO_ERROR_STATU
S_UNINIT
1321 Indicates that the video
component has been
released.
TC_VIDEO_ERROR_NOT_F
IND_WNDCELL
1322 Indicates that the cell
corresponding to the user
device cannot be detected.
TC_VIDEO_ERROR_NOTIN
_MAXOPEN_RANGE
1323 Indicates that the number
of video channels exceeds
the upper limit.
TC_VIDEO_ERROR_ALLRE
ADY_PAUSE
1324 Indicates that the video is
paused.
TC_VIDEO_ERROR_NOT_P
AUSE_STATUS 1325 Indicates that the video is
not paused.
TC_VIDEO_ERROR_SWITC
H_STREAM_STATUS
1326 Indicates that the
switchover between
high-bit-rate and
low-bit-rate channel is not
performed on the decoding
end or performed when the
video is paused).
TC_VIDEO_ERROR_OPERA
TE_STATUS
1327 Error in video operations
(the table data is
abnormal).
TC_VIDEO_ERROR_RESOL
UTION_NOTFIT
1329 Indicates that the
user-defined resolution is
different from capability
resolution (for external
collection devices).
TC_VIDEO_ERROR_FLOW
CTRL
1330 Indicates that the flow
control is being carried
out.
TC_VIDEO_ERROR_OUTSI
DE_FLOWCTRL
1331 Indicates that the external
flow control is being
carried out.
EC Platform Cloud
SDK Interface Reference (Android) 4 Return Code
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
76
Enumeration Value Value Description Remarks
TC_VIDEO_ERROR_DEVIC
E_OPENED
1340 Indicates that the video
device is being used.
TC_VIDEO_ERROR_DEVIC
E_WIZARD_USED
1341 Indicates that the video
device is being used by the
video navigation.
TC_VIDEO_ERROR_WIZAR
D_NOTSAME_DEVICE
1342 Indicates that the device is
not the same during
parameter setting through
the wizard.
TC_VIDEO_ERROR_WIZAR
D_SAME_PARAM
1343 Indicates that the same
parameter already exists
during parameter setting
through the wizard.
TC_VIDEO_ERROR_MY_N
ODEID
1344 Indicates that the node ID
of the current user is used.
TC_VIDEO_ERROR_DEVIC
E_NOT_OPENED
1345 Indicates that the device
has not been enabled.
TC_VIDEO_ERROR_NOT_
MYDEVICE
1350 Indicates that the video
device is not owned by the
current user.
TC_VIDEO_ERROR_TOOL
ONG_FILENAME
1351 Indicates that the name of
a video feed exceeds the
upper limit.
TC_VIDEO_ERROR_RENDE
R_DISPLAY_PARAM
1352 Incorrect parameter for
rendering a video feed.
TC_VIDEO_ERROR_ROTAT
E
1353 Incorrect parameter for
video rotation.
TC_VIDEO_ERROR_PC_MO
BILE_VERSION_API
1354 Incorrect use of the API on
a PC and mobile platform.
TC_VIDEO_ERROR_NOT_
WND
1355 Indicates that the object is
not a window.
TC_VIDEO_ERROR_OVER_
CAPTURECAPBILITY 1356 Indicates that the
capability specified for a
video exceeds the video
capture capability.
TC_VIDEO_ERROR_NOT_
WND_NOTFIT
1357 Inconsistency between the
window in use (for
example, when the
window is unbound from
the video feed) and the
window when being
attached to a video.
EC Platform Cloud
SDK Interface Reference (Android) 4 Return Code
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
77
Enumeration Value Value Description Remarks
TC_VIDEO_ERROR_MULC
ONF_CANNOT_USERHME
1358 Indicates that the video
HME cannot be used by a
conference because
another conference is
using the HME.
TC_VIDEO_ERROR_MULC
ONF_HANGUP
1359 Indicates that the
conference is suspended
when multiple conferences
are ongoing.
TC_VIDEO_ERROR_IS_THI
RDCAPTURE_DEVICE
1360 Indicates that the device is
a third-party device.
TC_VIDEO_ERROR_ISNOT
_THIRDCAPTURE_DEVICE
1361 Indicates that the device is
not a third-party device.
TC_VIDEO_ERROR_BITRA
TE_RANGE
1362 Indicates that the bit rate is
out of the normal range.
TC_VIDEO_ERROR_NOT_D
OUBLESTREAM
1363 Indicates that the video
streams are not dual
streams.
TC_VIDEO_ERROR_NOT_F
IND_THIRDCARD
1364 Indicates that the
third-party capture card
cannot be detected.
TC_VIDEO_ERROR_VIDEO
_NOTOPEN
1365 Indicates that the video is
not opened.
TC_VIDEO_ERROR_VIDEO
_RECORDING
1366 Indicates that the video is
being recorded.
TC_VIDEO_ERROR_VIDEO
_RECOREND
1367 Indicates that video
recording is ended.
Audio module
TC_AUDIO_ERROR_BASE 1400
TC_AUDIO_ERROR_NOT_I
NITIALIZATION
1401 Indicates that the audio
module has not been
initialized.
TC_AUDIO_ERROR_PARA
M_NOTEXIST
1402 Indicates that the
parameter does not exist.
TC_AUDIO_ERROR_FILE_
NOT_SUPPORT
1403 Incorrect file type.
TC_AUDIO_CREATE_SEND
_THREAD_FAIL
1405 Indicates that the sound of
the microphone cannot be
sent to the server because
of the failure to create the
voice transmission thread.
EC Platform Cloud
SDK Interface Reference (Android) 4 Return Code
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
78
Enumeration Value Value Description Remarks
TC_AUDIO_PARAM_WRO
NG
1406 Incorrect parameter.
TC_AUDIO_FUNC_ALREA
DY_CALLED
1407 Repeated function
invoking.
TC_AUDIO_ENGINE_INIT_
FAILED
1408 Failure to initialize the
audio engine.
TC_AUDIO_PARAM_NOT_I
NITIALIZATION
1409 Indicates that the default
parameter has not been
specified in the audio
module.
TC_AUDIO_ERROR_SESSI
ON_NOT_READY
1410 Indicates that audio data
has not joined the channel.
TC_AUDIO_ERROR_MIC_N
OT_OPEN
1411 Indicates that the
microphone is not enabled.
TC_AUDIO_MIC_ALREAD
Y_OPEN 1412 Indicates that the
microphone is already
enabled.
TC_AUDIO_OVER_MAX_D
EVICE_OPEN
1413 Indicates that the number
of enabled microphones
exceeds the upper limit.
TC_AUDIO_SPEAKER_ALR
EADY_OPEN
1417 Indicates that the
loudspeaker is enabled.
TC_AUDIO_SPEAKER_ALR
EADY_MUTE
1418 Indicates that the
loudspeaker has been
muted.
TC_AUDIO_SPEAKER_ALR
EADY_UMUTE
1419 Indicates that the enabled
loudspeaker has been
unmuted.
TC_AUDIO_IS_NOT_SUPPO
RTED
1420 Indicates that the interface
invoking is not supported
on the current platform.
TC_AUDIO_ERROR_ALRE
ADY_IN_PRIVATE 1421 Indicates that the user is
already in a private chat.
TC_AUDIO_ERROR_ALRE
ADY_NOT_IN_PRIVATE
1422 Indicates that the user is
not in a private chat.
TC_AUDIO_ERROR_DEVIC
E_INOPERABLE
1423 Indicates that the video
device is being used in
another conference.
TC_AUDIO_ERROR_CONF_
SUSPEND
1424 Suspended conference.
EC Platform Cloud
SDK Interface Reference (Android) 4 Return Code
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
79
Enumeration Value Value Description Remarks
TC_AUDIO_
ERROR_PHONE_MGW_CO
DEC_FAIL
1425 Failure to negotiate codec
between gateways.
TC_AUDIO_ERROR_PHON
E_MGW_VA_ALREADY_N
OTIFY
1426 Indicates that the gateway
has been notified.
TC_AUDIO_ERROR_PHON
E_MGW_VA_ALREADY_T
ALK
1427 Indicates that the gateway
sends messages to the
conference server.
TC_AUDIO_ERROR_PHON
E_SESSION_NOT_READY
1428 Indicates that the phone
module has not been
initialized.
TC_AUDIO_ERROR_PHON
E_MGW_VA_NOT_NOTIFY
1429 Indicates that the gateway
has not been notified.
TC_AUDIO_ERROR_PHON
E_MGW_NOT_RESPONSE
1430 Indicates that the gateway
does not respond.
TC_AUDIO_ERROR_TRY_L
ATER
1431 Indicates that the gateway
is enabled.
TC_AUDIO_ERROR_MGW_
CODEC_ALREADY_SUCCE
SS
1432 Successful codec
negotiation between
gateways.
TC_AUDIO_ERROR_SAME
_VALUE
1433 Indicates that the
parameter is set to the
same value for two times.
Media sharing module
TC_MS_ERROR_BASE 1500
TC_MS_ERROR_BITRATE_
TO_HIGH 1501
Polling module
TC_POLLING_ERROR_BAS
E 1600
Recording module
TC_RECORD_ERROR_BAS
E 1700
TC_RECORD_ERROR_INOP
ERABLE 1701 Operation error.
TC_RECORD_ERROR_PAT
H_NOT_FOUND 1702 Path error.
EC Platform Cloud
SDK Interface Reference (Android) 4 Return Code
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
80
Enumeration Value Value Description Remarks
TC_RECORD_ERROR_WAI
T_TIME_OUT 1703 Timeout.
TC_RECORD_ERROR_SYS
TEM_NOT_SUPPORT_WMF
1704 Indicates that local video
cannot be recorded as
a .wmw file.
File transfer module
TC_FT_ERROR_BASE 1800
TC_FT_ERROR_CREATE_FI
LE_FAIL
1801 Failure to create the
specified file.
TC_FT_ERROR_DOWNLOA
DING_CANCELED
1802 Canceled file download.
TC_FT_ERROR_INVALID_F
ILE_HANDLE
1803 Invalid file handle.
TC_FT_ERROR_INVALID_S
TATE
1804 Invalid component status.
TC_FT_ERROR_INVALID_F
ILE
1805 Invalid file.
TC_FT_ERROR_EMPTY_FI
LE
1806 Empty file that cannot be
uploaded.
TC_FT_ERROR_UPLOADIN
G_TIMEOUT
1807 File upload timeout.
TC_FT_ERROR_ALREADY_
DOWNLOADING
1808 Indicates that the file is
being downloaded.
EC Platform Cloud
SDK Interface Reference (Android) 5 Callback Messages of the Java Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
81
5 Callback Messages of the Java Class
5.1 Description
The callback message is called back through the IConferenceUI interface. The callback
interface is as follows:
void confMsgNotify(ConfMsg msg, ConfExtendMsg extendMsg);
The ConfMsg class is a universal class, including the msgType, nValue1, and nValue2
members.
The ConfExtendMsg class is the extension base class. Different sub classes are returned by
different callback messages, as described in the following tables.
5.2 Conference Management
Message ID (ConfMsg.msgType)
Description Value Description (ConfMsg.nValue1)
Value Description (ConfMsg.nValue2)
Return Parameter (ConfExtendMsg)
CONF_MSG_O
N_CONFEREN
CE_JOIN
Notification of
joining a
conference.
TcResult N/A N/A
CONF_MSG_O
N_CONFEREN
CE_TERMINA
TE
Notification of
terminating a
conference.
Reason for
terminating a
conference.
N/A N/A
CONF_MSG_O
N_CONFEREN
CE_LEAVE
Notification of
leaving a
conference.
Reason for leaving a
conference.
N/A N/A
CONF_MSG_O
N_COMPONE
NT_LOAD
Notification of
loading a
component.
TcResult COMPONENT_IID N/A
EC Platform Cloud
SDK Interface Reference (Android) 5 Callback Messages of the Java Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
82
Message ID (ConfMsg.msgType)
Description Value Description (ConfMsg.nValue1)
Value Description (ConfMsg.nValue2)
Return Parameter (ConfExtendMsg)
CONF_MSG_O
N_MUTE
Notification of
muting a
participant.
All participants
can receive the
notification.
bMute:
1: Mute a participant
0: Unmute a
participant.
0 N/A
5.3 User Management
Message ID (ConfMsg.msgType)
Description Value Description (ConfMsg.nValue1)
Value Description (ConfMsg.nValue2)
Return Parameter (ConfExtendMsg)
CONF_MSG_U
SER_ON_ENT
ER_IND
Notification of a
data user joining
a conference
1: A user joins the
conference.
0: The user is
already in the
conference.
User role ConfExtendUserInfo
Msg
CONF_MSG_U
SER_ON_LEA
VE_IND
Notification of a
data user leaving
a conference.
N/A N/A ConfExtendUserInfo
Msg
CONF_MSG_U
SER_ON_HOS
T_CHANGE_I
ND
Notification of
changing the
moderator.
User ID of the
original moderator
User ID of the new
moderator N/A
CONF_MSG_U
SER_ON_HOS
T_GIVE_IND
Notification of
assigning the role
of moderator.
ID of the user to
whom the role is
assigned
N/A N/A
CONF_MSG_U
SER_ON_HOS
T_GIVE_CFM
Result of
assigning the role
of moderator.
TC_OK: operation
success
N/A N/A
CONF_MSG_U
SER_ON_PRES
ENTER_CHAN
GE_IND
Notification of
changing the
presenter.
User ID of the
original presenter
User ID of the new
presenter
N/A
CONF_MSG_U
SER_ON_PRES
ENTER_GIVE_
IND
Notification of
assigning the role
of presenter.
ID of the user to
whom the role is
assigned
N/A N/A
EC Platform Cloud
SDK Interface Reference (Android) 5 Callback Messages of the Java Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
83
Message ID (ConfMsg.msgType)
Description Value Description (ConfMsg.nValue1)
Value Description (ConfMsg.nValue2)
Return Parameter (ConfExtendMsg)
CONF_MSG_U
SER_ON_PRES
ENTER_GIVE_
CFM
Result of
assigning the role
of presenter.
TC_OK: operation
success
N/A N/A
CONF_MSG_U
SER_ON_OFFL
INE_IND
Notification that
a user is
disconnected.
User ID of the
disconnected user
N/A N/A
5.4 Video Module
Message ID (ConfMsg.msgType)
Description Value Description (ConfMsg.nValue1)
Value Description (ConfMsg.nValue2)
Return Parameter (ConfExtendMsg)
COMPT_MSG_
VIDEO_ON_S
WITCH
Triggered when
a device of the
current user or
another user is
enabled,
disabled,
paused, or
resumed.
Notification of
video change on
the video devices
of the current
user and other
users.
0: The video is
closed.
1: The video is
being played.
2: The paused
video is resumed.
4: The video is
paused.
User ID ConfExtendVideoPar
amMsg
The callback messages contain the device information, enabling or disabling of the device, device
insertion and removal of the device of the current user and other users.
5.5 Audio Module
Message ID (ConfMsg.msgType)
Description Value Description (ConfMsg.nValue1)
Value Description (ConfMsg.nValue2)
Return Parameter (ConfExtendMsg)
CONF_MSG_O
N_COMPONE
NT_LOAD
Triggered by the first callback
Notification that
the audio
component is
available.
int nValue1
TC_OK: The
audio component
is ready.
TC_FAILURE:
long nValue2
IID_COMPONENT_
AUDIO
N/A
EC Platform Cloud
SDK Interface Reference (Android) 5 Callback Messages of the Java Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
84
Message ID (ConfMsg.msgType)
Description Value Description (ConfMsg.nValue1)
Value Description (ConfMsg.nValue2)
Return Parameter (ConfExtendMsg)
message
received after
the audio
component is
loaded.
The audio
component fails to
be initialized.
COMPT_MSG_
AUDIO_ON_A
UDIO_MAX_O
PEN_DEVICE
Triggered by the
conf_audio_set_
max_open_devi
ce interface
(received by all
participants
joining the
meeting at any
time).
Notification of
the maximum
number of
devices that can
be enabled
simultaneously.
int nValue1:
maximum number of
devices that can be
enabled
simultaneously
long nValue2
0
N/A
COMPT_MSG_
AUDIO_ON_A
UDIO_DEVICE
_STATUS_CH
ANGE
Triggered when
a participant of a
meeting
performs an
operation on the
local
microphone.
(The notification
is received by
other
participants.)
New participants
receive a
notification
about the status
of devices of
other
participants who
have joined the
conference
earlier.
Notification of
changing the
status of a
participant's
device.
int value (device
type):
AUDIO_MIC = 0 or
AUDIO_SPEAKER =
1
long value (device
status):
AUDIO_STATUS_O
PEN = 0,
AUDIO_STATU
S_CLOSE=1,
AUDIO_STATU
S_MUTE=2,
AUDIO_STATU
S_NO_DEVICE=3
uint32*
ID of the user whose
device status changes
COMPT_MSG_
AUDIO_ON_A
UDIO_OPEN_
MIC
Notification of
asynchronously
opening the
microphone.
TcResult 0 0
EC Platform Cloud
SDK Interface Reference (Android) 5 Callback Messages of the Java Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
85
5.6 Desktop or Application Program Sharing
Message ID (ConfMsg.msgType)
Description Value Description (ConfMsg.nValue1)
Value Description (ConfMsg.nValue2)
Return Parameter (ConfExtendMsg)
COMPT_MSG_
AS_ON_SHARI
NG_STATE
Sharing status
notification.
SHSHARINGTYPE_
DESKTOP
SHSHARINGTYPE_
APP
AS_STATE_NULL
AS_STATE_VIEW
AS_STATE_START
AS_STATE_PAUSE
N/A
COMPT_MSG_
AS_ON_SHARI
NG_SESSION
Sharing channel
notification.
AS_SESSION_CON
NECT
AS_SESSION_OWN
ER
AS_SESSION_DISC
ONNECT
AS_SESSION_CONN
ECTED
AS_SESSION_RECO
NNECTED
AS_ACTION_DELET
E
AS_ACTION_ADD
AS_ACTION_MODIF
Y
ID
COMPT_MSG_
AS_ON_PRIVI
LEGE
Sharing
permission
notification.
AS_PRIVILEGETYP
E_CONTROL
AS_PRIVILEGETYP
E_ANNOTATION
AS_ACTION_DELET
E
AS_ACTION_ADD
AS_ACTION_MODIF
Y
AS_ACTION_REQU
EST
AS_ACTION_REJEC
T
ID
5.7 Document Sharing
Message ID (ConfMsg.msgType)
Description Value Description (ConfMsg.nValue1)
Value Description (ConfMsg.nValue2)
Return Parameter (ConfExtendMsg)
COMPT_MSG_
DS_ON_DOC_
NEW
Notification that a
document is
successfully
opened or the
header of a
document is
downloaded.
Document ID N/A ConfExtendDsDocI
nfoMsg
EC Platform Cloud
SDK Interface Reference (Android) 5 Callback Messages of the Java Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
86
Message ID (ConfMsg.msgType)
Description Value Description (ConfMsg.nValue1)
Value Description (ConfMsg.nValue2)
Return Parameter (ConfExtendMsg)
COMPT_MSG_
DS_ON_DOC_
DEL
Notification that a
document is
deleted.
Document ID N/A ConfExtendDsDocI
nfoMsg
COMPT_MSG_
DS_ON_PAGE_
NEW
Notification that a
page is
successfully
loaded or the
header of a page
is downloaded.
Document ID Page ID NULL
COMPT_MSG_
DS_ON_PAGE_
DEL
Notification that a
page is deleted.
Document ID Page ID NULL
COMPT_MSG_
DS_ON_CURR
ENT_PAGE_IN
D
Notification of
synchronously
turning pages.
The underlying
layer does not
turn the pages
after receiving the
message and
requires the upper
layer to specify
the page to be
turned to.
Other participants
may receive the
message and
cannot invoke the
synchronous page
switch interface
again.
Document ID Page ID NULL
COMPT_MSG_
DS_ON_CURR
ENT_PAGE
Notification that
the current
document or page
changes.
Document ID Page ID NULL
COMPT_MSG_
DS_ON_DOCL
OAD_START
Notification of
starting to load a
document.
Document ID Reserved NULL
COMPT_MSG_
DS_ON_PAGE_
LOADED
Notification that a
page is loaded.
Document ID Page ID NULL
COMPT_MSG_
DS_ON_DOCL
OAD_FINISH
Notification that a
document is
loaded.
Document ID Document loading
result
For details, see the
definition in
NULL
EC Platform Cloud
SDK Interface Reference (Android) 5 Callback Messages of the Java Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
87
Message ID (ConfMsg.msgType)
Description Value Description (ConfMsg.nValue1)
Value Description (ConfMsg.nValue2)
Return Parameter (ConfExtendMsg)
TcResult.
COMPT_MSG_
DS_XML_ON_
OPEN
ID returned after
a document is
opened on
Android.
Document ID N/A NULL
5.8 Whiteboard
Message ID (ConfMsg.msgType)
Description Value Description (ConfMsg.nValue1)
Value Description (ConfMsg.nValue2)
Return Parameter (ConfExtendMsg)
COMPT_MSG_
WB_ON_DOC_
NEW
Notification that a
whiteboard
document is
successfully
created or the
header of a
whiteboard
document is
downloaded.
Document ID Reserved ConfExtendDsDocI
nfoMsg
COMPT_MSG_
WB_ON_PAGE
_NEW
Notification that a
page is
successfully
created or the
header of a page
is downloaded.
Document ID Page ID NULL
COMPT_MSG_
WB_ON_CURR
ENT_PAGE_IN
D
Notification of
synchronously
turning pages.
The underlying
layer does not
turn the pages
after receiving the
message and
requires the upper
layer to specify
the page to be
turned to.
Other participants
may receive the
message and
cannot invoke the
synchronous page switch interface
Document ID Page ID NULL
EC Platform Cloud
SDK Interface Reference (Android) 5 Callback Messages of the Java Class
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
88
Message ID (ConfMsg.msgType)
Description Value Description (ConfMsg.nValue1)
Value Description (ConfMsg.nValue2)
Return Parameter (ConfExtendMsg)
again.
COMPT_MSG_
WB_ON_CURR
ENT_PAGE
Notification that
the current
document or page
changes.
Document ID Page ID NULL
COMPT_MSG_
WB_ON_DRA
W_DATA_NOT
IFY
Notification of
updating the user
interface.
After receiving
the message, the
upper layer
invokes the
ds_get_surfacebm
p interface to
obtain data for
user interface
rendering.
Document ID Page ID NULL
COMPT_MSG_
WB_XML_ON_
NEW_DOC
ID returned after a
document is
created on
Android.
Document ID NULL
COMPT_MSG_
WB_XML_ON_
NEW_PAGE
ID returned after a
page is created on
Android.
Document ID Page ID NULL
5.9 IM
Message ID (ConfMsg.msgType)
Description Value Description (ConfMsg.nValue1)
Value Description (ConfMsg.nValue2)
Return Parameter (ConfExtendMsg)
COMPT_MSG_
CHAT_ON_RE
CV_MSG
Notification of IM
reception
(received only by
the IM message
recipient).
0 0 ConfExtendChatMs
g
EC Platform Cloud
SDK Interface Reference (Android) 6 Callback Class Description
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
89
6 Callback Class Description
6.1 Conference Control
6.1.1 ConfExtendParamMsg
Conference global parameter callback class.
Parameter Description
paramName Global parameter.
paramData Parameter value, which is a binary number
6.1.2 ConfExtendUserDataMsg
User data callback class.
Parameter Description
fromuserid User ID of the message sender
msgtype Message type
userData Data
6.1.3 ConfExtendUserInfoMsg
User information callback class.
Parameter Description
userid User ID
deviceType User device type
osType Operating system type of the user device
EC Platform Cloud
SDK Interface Reference (Android) 6 Callback Class Description
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
90
Parameter Description
userPresenceFlag Status
userCapability Capability
userStatus User status
userName User name
userUri User uniform resource identifier (URI)
userInfo User extension data
6.2 Screen Sharing
6.2.1 ConfExtendAsChannelMsg
Callback class of channel joining or exiting during screen sharing.
Parameter Description
action Joining or exiting
6.2.2 ConfExtendAsMouseMsg
Callback class of mouse movement during screen sharing.
Parameter Description
msgtype Mouse message
wparam Mouse message parameter, which is the same as the
message parameter of the Windows operating
system
lparam Mouse message parameter, which is the same as the
message parameter of the Windows operating
system
6.2.3 ConfExtendAsParamMsg
Callback class of obtaining screen sharing parameters. For details, see the description of the
tup_conf_as_getparam interface.
Parameter Description
ulPorpType Parameter type
EC Platform Cloud
SDK Interface Reference (Android) 6 Callback Class Description
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
91
Parameter Description
ulParam1 Parameter 1
ulParam2 Parameter 2
lfParam1 Parameter 3
6.2.4 ConfExtendAsPrivilegeMsg
Callback class of assigning or revoking the remote control permission during screen sharing.
Parameter Description
userid User ID whose remote control permission is
assigned or revoked
6.2.5 ConfExtendAsScreenSizeMsg
Callback class of the screen size for screen sharing. This class is invoked to send the screen
size to the peer client.
Parameter Description
screenWidth Screen width
screenHeight Screen height
6.2.6 ConfExtendAsSessionMsg
Callback class of the channel sharing notification during screen sharing. This class is invoked
when the client that shares its screen to other terminals changes.
Parameter Description
userid User ID of the conference client that shares its screen
6.3 Whiteboard Sharing
6.3.1 ConfExtendDsNewDocMsg
Blank document creation callback class.
EC Platform Cloud
SDK Interface Reference (Android) 6 Callback Class Description
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
92
Parameter Description
docId ID of the document to be created
userId User ID
docName Name of the document to be created
6.3.2 ConfExtendFlowControlMsg
Stream control callback class.
Parameter Description
tcpLatency Network delay
tcpJitter Network jitter
tcpSendRate Network data sending rate
tcpSendDelay Network data sending delay
tcpRmtSendRate Data sending rate of the peer client
tcpRmtSendDelay Data sending delay of the peer client
6.4 File Transfer
6.4.1 ConfExtendFtFileInfoMsg
File transfer callback class.
Parameter Description
fileName File name
filePathName File path
senderUserName User name of the sender
senderUserId User ID of the sender
recieverUserId User ID of the recipient
size File size
status Status
EC Platform Cloud
SDK Interface Reference (Android) 6 Callback Class Description
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
93
6.5 Audio
6.5.1 ConfExtendMaxVoiceMsg
Callback class of the number of maximum microphones that can be enabled for a participant.
Parameter Description
maxVoiceUsers Number of maximum microphones that can be
enabled for a participant
6.6 Video
6.6.1 ConfExtendVideoDeviceInfoMsg
Video device information callback class.
Parameter Description
userid Video user ID
deviceId Video device ID
deviceName Video device name
deivceStatus Video device status
deviceType Video device type
deviceIndex Video device index
isInsert Reserved
6.6.2 ConfExtendVideoParamMsg
Video parameter callback class.
Parameter Description
deviceId Video device ID
xresolution Horizontal resolution
yresolution Vertical resolution
feamerate Frame rate
bitrate Bandwidth
EC Platform Cloud
SDK Interface Reference (Android) 6 Callback Class Description
Issue 01 (2016-08-24) Huawei Proprietary and Confidential
Copyright © Huawei Technologies Co., Ltd
94
Parameter Description
fecValue Redundancy number