| 接口 | 说明 |
|---|---|
| ECChatManager |
IM 聊天管理接口
可以使用该接口将
ECMessage 对象发送到服务器a
标准的发送一个文本、图片或者附件消息代码如下:
try {
// 组建一个待发送的ECMessage
ECMessage msg = ECMessage.createECMessage(ECMessage.Type.TXT);
//设置消息的属性：发出者，接受者，发送时间等
msg.setForm("$Tony的账号");
msg.setMsgTime(System.currentTimeMillis());
// 设置消息接收者
msg.setTo("$John的账号");
msg.setSessionId("$John的账号");
// 设置消息发送类型（发送或者接收）
msg.setDirection(ECMessage.Direction.SEND);
// 创建一个文本消息体，并添加到消息对象中
ECTextMessageBody msgBody = new ECTextMessageBody(text.toString());
// 或者创建一个图片消息体 并且设置附件包体（其实图片也是相当于附件）
// 比如我们发送SD卡里面的一张Tony_2015.jpg图片
ECImageMessageBody msgBody = new ECImageMessageBody();
// 设置附件名
msgBody.setFileName("Tony_2015.jpg");
// 设置附件扩展名
msgBody.setFileExt("jpg");
// 设置附件本地路径
msgBody.setLocalUrl(".. |
| ECChatManager.OnChangeVoiceListener |
语音文件处理接口
|
| ECChatManager.OnDeleteMessageListener |
删除消息回调接口(目前只支持删除接收到的消息)
|
| ECChatManager.OnDownloadMessageListener |
下载语音附件消息完成回调
|
| ECChatManager.OnGetPersonInfoListener |
获取个人信息接口监听
|
| ECChatManager.OnGetRedPacketTokenListener | |
| ECChatManager.OnGetSessionsOfTopListener |
查询个人设置的置顶会话列表
|
| ECChatManager.OnProgressNotifyListener |
文件下载进度监听
|
| ECChatManager.OnQueryMessageReadStatusListener |
查询消息已读未读回调接口、
第一个是已读列表 如果没有就是null
第二个是未读列表 如果没有就是null
|
| ECChatManager.OnReadMessageListener |
置为已读消息接口回调
|
| ECChatManager.OnRealTimeMessageListener |
发送实时语音监听
|
| ECChatManager.OnRecordTimeoutListener |
录音超时监听
|
| ECChatManager.OnRevokeMessageListener |
消息撤回操作回调监听
|
| ECChatManager.OnSendMessageListener |
IM消息发送完成监听
|
| ECChatManager.OnSetContactToTopListener |
设置会话置顶状态回调监听
|
| ECChatManager.OnSetPersonInfoListener |
设置个人信息接口监听
|
| ECChatManager.OnStopVoiceRecordingListener |
停止录音回调监听
|
| ECDeskManager |
客服管理接口
|
| ECDeskManager.OnAgentEventListener | |
| ECDeskManager.OnAgentWithUserListener | |
| ECDeskManager.OnFinishConsultationListener |
结束在线客服回调监听接口
|
| ECDeskManager.OnGetAgentInfoListener | |
| ECDeskManager.OnQueryQueueListener | |
| ECDeskManager.OnReadyOrNotListener | |
| ECDeskManager.OnSendAgentCommandListener | |
| ECDeskManager.OnSendDeskMessageListener |
发送在线客服消息回调监听接口
|
| ECDeskManager.OnSendUserMessageListener |
客服回复消息回调监听接口
|
| ECDeskManager.OnSetReplyListener | |
| ECDeskManager.OnStartConsultationListener |
发起在线客服回调监听接口
|
| ECDeskManager.OnSubmitSatisfactionListener |
发送满意度回调监听接口
|
| ECDeskManager.OnUpGradeServiceListener | |
| ECDevice.InitListener |
SDK初始化方法回调接口，通知应用SDK初始化状态
|
| ECDevice.OnECDeviceConnectListener |
SDK注册状态（连接状态）回调监听
|
| ECDevice.OnGetOnlineMultiDeviceListener |
查询当前账号是否在其他设备上登录回调接口
|
| ECDevice.OnGetPersonInfoListener |
获取个人信息接口监听
|
| ECDevice.OnGetUsersStateListener |
查询用户状态信息回调接口
|
| ECDevice.OnGetUserStateListener | 已过时 |
| ECDevice.OnLogInfoListener | |
| ECDevice.OnLogoutListener |
SDK注销接口回调
|
| ECDevice.OnLogoutResultListener |
SDK注销并返回注销结果接口回调
|
| ECDevice.OnSetDisturbListener | |
| ECDevice.OnSetPersonInfoListener |
设置个人信息接口监听
|
| ECDevice.OnSetPresenceListener |
设置个人在线状态回调接口
|
| ECGroupManager |
群组管理API
可以使用该接口对群组进行管理，包括群组的创建、退出、解散、查询以及对
群组成员进行管理（邀请加入群组、将成员移除出群组、查询群组成员等）
标准的创建一个群组并且处理创建结果回调代码如下:
// 构建群组参数
ECGroup group = new ECGroup();
// 设置群组名称
group.setName("出彩中国人");
// 设置群组公告
group.setDeclare("欢迎体验云通讯群组功能");
// 设置群组类型，如：ECGroup.Scope.TEMP临时群组（100人）
group.setScope(ECGroup.Scope.TEMP);;
// 设置群组验证权限，如：需要身份验证ECGroup.Permission.NEED_AUTH
group.setPermission(ECGroup.Permission.NEED_AUTH);
// 设置群组创建者（可以不设置，服务器默认接口调用者为创建者）
group.setOwner("$Tony的账号");
// 获得SDK群组创建管理类
ECGroupManager groupManager = ECDevice.getECGroupManager();
// 调用创建群组接口，设置创建结果回调
groupManager.createGroup(group, new ECGroupManager.OnCreatGroupListener() {
public void onCreatGroupComplete(ECError error, ECGroup group) {
if(error.errorCode == SdkErrorCode.REQUEST_SUCCESS) {
// 群组创建成功
// 缓存创建的群组到数据库，同时通知UI进行更新
return ;
}
// 群组创建失败
Log.e("ECSDK_Demo" , "create group fail , errorCode="
+ error.errorCode);
}
public void onComplete(ECError error) {
// 不需要处理忽略
}
}); |
| ECGroupManager.OnAckInviteJoinGroupRequestListener |
回复管理员邀请加入群组请求回调接口
|
| ECGroupManager.OnAckJoinGroupRequestListener |
回复加入群组申请请求回调接口
|
| ECGroupManager.OnCreateGroupListener |
创建群组结果回调接口
|
| ECGroupManager.OnDeleteGroupListener |
删除群组结果回调接口
|
| ECGroupManager.OnDeleteGroupMembersListener |
删除群组请求回调接口
|
| ECGroupManager.OnForbidMemberSpeakStatusListener |
设置群组成员用户禁言状态请求回调接口
|
| ECGroupManager.OnGetAllPublicGroupsListener |
查询公共群组结果回调接口
|
| ECGroupManager.OnGetGroupDetailListener |
查询群组详细信息结果回调接口
|
| ECGroupManager.OnInviteJoinGroupListener |
邀请加入群组回调接口
|
| ECGroupManager.OnJoinGroupListener |
申请加入群组请求回调接口
|
| ECGroupManager.OnModifyGroupListener |
修改群组结果回调接口
|
| ECGroupManager.OnModifyMemberCardListener |
修改群组成员名片请求回调接口
|
| ECGroupManager.OnQueryGroupMembersListener |
根据群组ID查询群组所有成员请求回调接口
|
| ECGroupManager.OnQueryMemberCardListener |
查询群组成员请求名片接口回调
|
| ECGroupManager.OnQueryOwnGroupsListener |
查询我加入的群组请求回调接口
|
| ECGroupManager.OnQuitGroupListener |
退出群组请求回调接口
|
| ECGroupManager.OnSearchPublicGroupsListener |
搜索公共群组结果回调接口
|
| ECGroupManager.OnSetGroupIsAnonymityListener |
设置群组是否匿名聊天模式
|
| ECGroupManager.OnSetGroupMemberRoleListener | |
| ECGroupManager.OnSetGroupMessageOptionListener |
设置群组消息接收规则请求回调接口
|
| ECLiveCallBack.OnControlMemberRoleListener | |
| ECLiveCallBack.OnControlMemberStateListener | |
| ECLiveCallBack.OnExitLiveChatRoomListener | |
| ECLiveCallBack.OnLiveChatRoomKickMemberListener | |
| ECLiveCallBack.OnUpdateLiveChatRoomListener | |
| ECLiveCallBack.OnUpdateSelfInfoListener | |
| ECLiveChatRoomManager |
Created by luhuashan on 17/5/12.
|
| ECMeetingManager |
会议管理接口
会议创建、会议列表查询、会议成员查询、会议退出、会议解散
实时对讲创建、实时对讲退出、实时对讲控麦、实时对讲放麦
视频会议发布和取消视频图象接口、请求和取消请求成员视频图像接口
|
| ECMeetingManager.OnControlMicInInterPhoneListener |
实时对讲抢麦结果回调接口
|
| ECMeetingManager.OnCreateOrJoinMeetingListener |
创建或者加入会议结果回调接口
|
| ECMeetingManager.OnDeleteMeetingListener |
删除会议（解散会议）结果回调接口
|
| ECMeetingManager.OnInviteMembersJoinToMeetingListener |
邀请用户加入会议结果回调接口
|
| ECMeetingManager.OnListAllMeetingsListener<T extends ECMeeting> |
查询会议列表结果回调接口
|
| ECMeetingManager.OnListPageMeetingsListener<T extends ECMeeting> | |
| ECMeetingManager.OnMemberVideoFrameChangedListener |
在视频会议中获取或者取消实时获取某一成员视频图像请求失败回调接口
|
| ECMeetingManager.OnQueryMeetingMembersListener<T extends ECMeetingMember> |
查询会议成员结果回调
|
| ECMeetingManager.OnQueryMeetingPageMembersListener<T extends ECMeetingMember> | |
| ECMeetingManager.OnReleaseMicInInterPhoneListener |
实时对讲释放麦结果回调接口
|
| ECMeetingManager.OnRemoveMemberFromMeetingListener |
会议管理员移除会议成员结果回调接口
|
| ECMeetingManager.OnSelfVideoFrameChangedListener |
在视频会议中发布或者取消发布自己的视频图象回调接口
|
| ECMeetingManager.OnSetMemberSpeakListenListener |
设置语音、视频会议成员禁言、禁听回调监听
|
| ECVoIPCallManager |
VoIP呼叫接口
呼叫、接听、拒接、挂机
标准的在呼叫前设置呼叫参数信息、处理来电事件、以及发起一次音频呼叫代码如下:
// 1、呼叫准备工作、设置透传呼叫个人参数信息
ECVoIPSetupManager setupManager = ECDevice.getECVoIPSetupManager();
// 创建一个本地呼叫参数对象
VoIPCallUserInfo mUserInfo = new VoIPCallUserInfo();
mUserInfo.setNickName("$NickName");
mUserInfo.setPhoneNumber("$PhoneNumber");
// 设置当前呼叫透传参数，对方收到VoIP呼叫可以获得该设置信息
setupManager.setVoIPCallUserInfo(mUserInfo);
// 2、设置SDK来电处理
// Note：为了保证能及时收到来电呼叫事件通知、所以应该在在注册SDK参数中加入如下代码传入来电呼叫处理接口
Intent intent = new Intent(Context, "${VoIPCallActivity.class}");
PendingIntent pendingIntent = PendingIntent.getActivity(Context, 0, intent, PendingIntent.FLAG_UPDATE_CURRENT);
ECInitParams.createParams().setPendingIntent(pendingIntent);
// 3、获取SDK VoIP呼叫接口
ECVoIPCallManager callManager = ECDevice.getECVoIPCallManager();
// 设置VoIP呼叫时间回调监听
callManager.setOnVoIPCallListener(new ECVoIPCallManager.OnVoIPListener() {
public void onCallEvents(ECVoIPCallManager.VoIPCall voipCall) {
// 接收VoIP呼叫事件回调
if(voipCall == null) {
Log.e("CallInter" , "handle call event error , voipCall null" );
return ;
}
String callId = voipCall.callId;
switch (voipCall.callState) {
case ECCALL_PROCEEDING:
// 处理呼叫进行中
break;
case ECCALL_ALERTING:
// 处理呼叫对方振铃
break;
case ECCALL_ANSWERED:
// 处理呼叫对方应答，通话开始计时
break;
case ECCALL_FAILED:
// 处理呼叫失败
break;
case ECCALL_RELEASED:
// 处理通话结束，通话完全释放
break;
default:
break;
}
}
});
// 发起VoIP呼叫(音频呼叫，CallType.VIDEO可以发起视频呼叫，CallType.DIRECT发起直拨呼叫)
callManager.makeCall(ECVoIPCallManager.CallType.VOICE , "${JorstinChan}");
|
| ECVoIPCallManager.OnCallMediaUpdateListener |
音视频切换回调接口
|
| ECVoIPCallManager.OnCallProcessDataListener |
音视频分辨率回调接口
|
| ECVoIPCallManager.OnCallProcessMultiDataListener | |
| ECVoIPCallManager.OnFrameChangeListener | |
| ECVoIPCallManager.OnMakeCallBackListener |
回拨呼叫接口执行结果回调通知接口
|
| ECVoIPCallManager.OnPauseCallListener | |
| ECVoIPCallManager.OnResumeCallListener | |
| ECVoIPCallManager.OnSendCmdListener | |
| ECVoIPCallManager.OnThirdMemberVideoListener | |
| ECVoIPCallManager.OnThreeInviteListener | |
| ECVoIPCallManager.OnVideoRatioChangeListener |
远端成员视频分辨率改变回调通知接口
|
| ECVoIPCallManager.OnVoIPListener |
VoIP呼叫状态接口
|
| ECVoIPSetupManager |
VoIP呼叫设置接口
|
| ECVoIPSetupManager.OnMediaDataCallBackListener | |
| OnChatReceiveListener |
SDK IM消息回调通知接口
|
| OnCustomChatListener |
Created by luhuashan on 17/3/16.
|
| OnLiveChatRoomListener |
Created by luhuashan on 17/5/12.
|
| OnMeetingListener |
SDK 会议消息回调通知接口
|
| 类 | 说明 |
|---|---|
| CallStatisticsInfo |
SDK通话数据统计参数信息
可以通过接口
ECVoIPSetupManager.getCallStatistics(String, boolean)
获得，包含当前通话数据包延迟和丢包率等信息 |
| CameraCapability |
当前设备所支持的摄像头参数信息
|
| CameraInfo |
摄像头参数
|
| ECDevice |
SDK入口，通过该接口可以获取访问SDK各个功能
1、SDK初始化、注销
2、SDK注册云通讯服务器、退出登陆[与服务器断开连接]
3、查询SDK在线状态
4、设置企业认证ID和企业认证密码
5、获取SDK能力集功能接口[IM通讯、VoIP呼叫、VoIP设置、会议管理、群组管理、多渠道]
标准的初始化代码如下:
ECDevice.initial(Context , new ECDevice.InitListener() {
public void onInitialized() {
// SDK完成基本功能的初始化，生成IM聊天、群组功能管理、VoIP以及会议等接口
}
public void onError(Exception exception) {
// SDK 初始化失败,可能有如下原因造成
// 1、可能SDK已经处于初始化状态
// 2、SDK所声明必要的权限未在清单文件（AndroidManifest.xml）里配置、
// 或者未配置服务属性android:exported="false";
// 3、当前手机设备系统版本低于ECSDK所支持的最低版本（当前ECSDK支持
// Android |
| ECError |
SDK错误码对象
|
| ECInitParams |
SDK注册参数封装
|
| ECLiveCallBack |
Created by luhuashan on 17/5/12.
|
| ECLiveCallBack.OnEnterLiveChatRoomListener | |
| ECLiveCallBack.OnQueryLiveChatRoomInfoListener | |
| ECLiveCallBack.OnQueryLiveChatRoomMembersListener | |
| ECLiveCallBack.OnQuerySingleLiveChatRoomMembersListener | |
| ECLiveCallBack.OnSendLiveChatRoomMessageListener | |
| ECLiveChatRoom |
Created by luhuashan on 17/5/11.
|
| ECLiveChatRoomMember |
Created by luhuashan on 17/5/12.
|
| ECLiveChatRoomMemberInfoBuilder |
Created by luhuashan on 17/5/12.
|
| ECLiveChatRoomModifyBuilder |
Created by luhuashan on 17/5/12.
|
| ECLiveControlOption |
Created by luhuashan on 17/5/12.
|
| ECLiveEnums |
Created by luhuashan on 17/5/12.
|
| ECLiveNotifyWrapper |
Created by luhuashan on 17/5/12.
|
| ECLiveSearchMembersConditionBuilder |
Created by luhuashan on 17/5/12.
|
| ECMcmCmdMessage | |
| ECMeetingManager.ECCreateMeetingParams |
会议创建参数信息
|
| ECMeetingManager.ECCreateMeetingParams.Builder |
会议创建参数生成器
通过该类可以将创建会议所需要的必选参数或者可选参数进行组装生成
ECMeetingManager.ECCreateMeetingParams |
| ECMessage |
IM消息对象
|
| ECMessageBody |
IM消息内容抽象接口类
|
| ECMultiDeviceState | |
| ECNotifyOptions |
设置通知栏样式
1、自定义当有新的消息时是否自动提醒
2、自定义推送消息状态栏通知图标
3、自定义推送消息状态栏通知是否振动/声音提醒
4、自定义是否启用勿扰模式（收到新消息不会振动/声音提醒），并且可以设置勿扰模式时间段
|
| ECReadMessageMember |
Created by luhuashan on 16/6/16.
|
| ECScreenRecorderParameter |
Created by luhuashan on 16/10/9.
|
| ECUserState |
个人状态类
|
| ECVoipAccount |
Created by luhuashan on 16/6/15.
|
| ECVoIPCallManager.AbsOnVoipClass | |
| ECVoIPCallManager.CallBackEntity |
回拨呼叫请求参数
|
| ECVoIPCallManager.VoIPCall |
标识一次呼叫参数
|
| NetworkStatistic |
SDK通话数据上下行流量统计信息
可以通过接口
ECVoIPSetupManager.getNetworkStatistic(String)
获得，包含当前通话所发生的流量等信息 |
| Parameters | |
| PersonInfo |
个人信息
|
| SdkErrorCode |
SDK错误码
|
| VideoRatio |
视频通话或者视频会议分辨率改变信息
type : 0 点对点,1 视频 // isVideoMeetingType
|
| VoIPCallUserInfo |
VoIP呼叫透传信息
|
| VoipDescriptor |
Created by luhuashan on 16/8/6.
|
| VoipMediaChangedInfo |
Created by luhuashan on 16/7/27.
|
Copyright © 2017 All rights reserved.