AnyChat视频呼叫业务逻辑详解
本帖最后由 佰锐技术-卓剑锐 于 2014-10-11 11:31 编辑新版本AnyChat已经内置视频呼叫(VideoCall)业务逻辑,简化应用层开发工作量,下面详细讲解视频呼叫业务逻辑:
一、视频呼叫业务逻辑概述
视频呼叫业务逻辑主要实现两个终端(PC、手机、Pad等)之间的通话请求流程控制,包括请求(Request)、回复(Reply)、开始(Start)以及结束(Finish)等过程,可以形象理解为打电话的流程:拨号、等待、通话、挂断。
二、视频呼叫业务逻辑流程图
三、视频呼叫业务逻辑API接口
客户端新增回调函数:
// 视频通话消息通知回调函数定义
typedef void (CALLBACK * BRAC_VideoCallEvent_CallBack)(DWORD dwEventType, DWORD dwUserId, DWORD dwErrorCode, DWORD dwFlags, DWORD dwParam, LPCTSTR lpUserStr, LPVOID lpUserValue);
// 设置视频通话消息通知回调函数
BRAC_API DWORD BRAC_SetVideoCallEventCallBack(BRAC_VideoCallEvent_CallBack lpFunction, LPVOID lpUserValue);
客户端新增API接口:
// 视频呼叫事件控制(请求、回复、挂断等)
BRAC_API DWORD BRAC_VideoCallControl(DWORD dwEventType, DWORD dwUserId, DWORD dwErrorCode, DWORD dwFlags, DWORD dwParam, LPCTSTR lpUserStr);
服务器新增回调函数
// 视频通话消息通知回调函数定义
typedef DWORD (CALLBACK * BRAS_OnVideoCallEvent_CallBack)(DWORD dwEventType, DWORD dwSrcUserId, DWORD dwTarUserId, DWORD dwErrorCode, DWORD dwFlags, DWORD dwParam, LPCTSTR lpUserStr, LPVOID lpUserValue);
// 设置视频通话消息通知回调函数
BRAS_API DWORD BRAS_SetOnVideoCallEventCallBack(BRAS_OnVideoCallEvent_CallBack lpFunction, LPVOID lpUserValue=NULL);
服务器新增API接口:
// 视频呼叫事件控制(请求、回复、挂断等)
BRAS_API DWORD BRAS_VideoCallControl(DWORD dwEventType, DWORD dwUserId, DWORD dwErrorCode, DWORD dwFlags, DWORD dwParam, LPCTSTR lpUserStr);
常量定义
// 视频呼叫事件类型定义(API:BRAC_VideoCallControl 传入参数、VideoCallEvent回调参数)
#define BRAC_VIDEOCALL_EVENT_REQUEST 1 ///< 呼叫请求
#define BRAC_VIDEOCALL_EVENT_REPLY 2 ///< 呼叫请求回复
#define BRAC_VIDEOCALL_EVENT_START 3 ///< 视频呼叫会话开始事件
#define BRAC_VIDEOCALL_EVENT_FINISH 4 ///< 挂断(结束)呼叫会话
// 视频呼叫标志定义(API:BRAC_VideoCallControl 传入参数)
#define BRAC_VIDEOCALL_FLAGS_AUDIO 0x01 ///< 语音通话
#define BRAC_VIDEOCALL_FLAGS_VIDEO 0x02 ///< 视频通话
#define BRAC_VIDEOCALL_FLAGS_FBSRCAUDIO 0x10 ///< 禁止源(呼叫端)音频
#define BRAC_VIDEOCALL_FLAGS_FBSRCVIDEO 0x20 ///< 禁止源(呼叫端)视频
#define BRAC_VIDEOCALL_FLAGS_FBTARAUDIO 0x40 ///< 禁止目标(被呼叫端)音频
#define BRAC_VIDEOCALL_FLAGS_FBTARVIDEO 0x80 ///< 禁止目标(被呼叫端)视频
// 视频呼叫
#define AC_ERROR_VIDEOCALL_CANCEL 100101 ///< 源用户主动放弃会话
#define AC_ERROR_VIDEOCALL_OFFLINE 100102 ///< 目标用户不在线
#define AC_ERROR_VIDEOCALL_BUSY 100103 ///< 目标用户忙
#define AC_ERROR_VIDEOCALL_REJECT 100104 ///< 目标用户拒绝会话
#define AC_ERROR_VIDEOCALL_TIMEOUT 100105 ///< 会话请求超时
#define AC_ERROR_VIDEOCALL_DISCONNECT 100106 ///< 网络断线
四、其它
1、客户端API(BRAC_VideoCallControl)和回调函数(BRAC_VideoCallEvent_CallBack)中的dwUserId均为对方的用户ID;2、被呼叫方拒绝通话时,发送回复(Reply)指令,dwErrorCode=100104;
3、被呼叫方同意通话时,发送回复(Reply)指令,dwErrorCode=0,然后服务器会向双方发送通话开始(Start)指令,dwParam=RoomId,房间号由核心服务器自动分配;
4、结束通话时,任何一方(包括业务服务器)均可以发送结束(Finish)指令,然后服务器会向双方发送通话结束(Finish)指令;
5、业务服务器可干预呼叫流程:在BRAS_OnVideoCallEvent_CallBack收到呼叫请求指令后,返回0表示允许呼叫,否则为出错代码,不允许呼叫;在会话过程中可以发送结束(Finish)指令,强制挂断指定用户的通话;
6、API接口中的dwParam(整型)、lpUserStr(字符串)均为用户自定义用途;
7、一个用户同时只能发起一路呼叫请求,也同时只能被一个用户呼叫;
8、视频呼叫业务流程可以脱离业务服务器,由核心服务器独立支撑,可以不需要在服务器端进行二次开发。
本帖最后由 廖斌 于 2013-10-12 14:07 编辑
下面android端为例,展示实现视频呼叫业务逻辑的整个过程(代码仅供参考,根据实际情况调用)
一、设置呼叫回调事件接收
用户收到呼叫请求、请求回复、会话开始、会话结束等事件都是在呼叫回调事件中处理的。
1、首先要在目标activity中实现AnyChatVideoCallEvent接口
2、然后在接收之前设置回调接收anychat.SetVideoCallEvent(this);
二、发送呼叫请求
1、用户A请求呼叫用户B,调用如下代码:anychat.VideoCallControl(AnyChatDefine.BRAC_VIDEOCALL_EVENT_REQUEST, useridB, 0, 0,0, "usernameA")发送呼叫请求。
其中“AnyChatDefine.BRAC_VIDEOCALL_EVENT_REQUEST”为请求呼叫类型,“useridB”为用户B的userId,“usernameA”是自定义参数(这里可以传送A的userName)。
2、服务器接收到之后会判断B用户是否在线、是否正在呼叫,并返回“呼叫请求回复”给A,A触发OnAnyChatVideoCallEvent。 public void OnAnyChatVideoCallEvent(int dwEventType, final int dwUserId,
int dwErrorCode, final int dwFlags, final int dwParam, final String userStr) {
// TODO Auto-generated method stub
switch(dwEventType)
{
case AnyChatDefine.BRAC_VIDEOCALL_EVENT_REPLY:
switch(dwErrorCode)
{
case AnyChatDefine.RETURNCODE_SUCCESS:
showToast("呼叫成功,请等待");
dialogCall=new ProgressDialog(this);
dialogCall.setMessage("呼叫成功,请等待");
dialogCall.setButton("取消呼叫", new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialog, int which) {
// TODO Auto-generated method stub
anychat.VideoCallControl(AnyChatDefine.BRAC_VIDEOCALL_EVENT_REPLY, dwUserId, AnyChatDefine.RETURNCODE_SESSION_QUIT, dwFlags, 30, anychat.GetUserName(-1));
}
});
dialogCall.show();
break;
case AnyChatDefine.RETURNCODE_SESSION_BUSY:
showToast("目标用户忙");
break;
case AnyChatDefine.RETURNCODE_SESSION_DISCONNECT:
showToast("网络断线");
break;
case AnyChatDefine.RETURNCODE_SESSION_OFFLINE:
showToast("目标用户不在线");
break;
case AnyChatDefine.RETURNCODE_SESSION_QUIT:
showToast("源用户主动放弃会话");
break;
case AnyChatDefine.RETURNCODE_SESSION_REFUSE:
showToast("目标用户拒绝会话");
if(dialogCall!=null)
dialogCall.dismiss();
break;
case AnyChatDefine.RETURNCODE_SESSION_TIMEOUT:
showToast("会话请求超时");
break;
}
break;3、如B是空闲的,服务器会转发“请求指令”给B,B触发OnAnyChatVideoCallEvent switch(dwEventType)
{
case AnyChatDefine.BRAC_VIDEOCALL_EVENT_REQUEST:
dialogRequest = new AlertDialog.Builder(this).setPositiveButton("同意", new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialog, int which) {
// TODO Auto-generated method stub
targetUserId=String.valueOf(dwUserId);
anychat.VideoCallControl(AnyChatDefine.BRAC_VIDEOCALL_EVENT_REPLY, dwUserId, AnyChatDefine.RETURNCODE_SUCCESS, dwFlags, 10, anychat.GetUserName(-1));
}
}).setNegativeButton("拒绝", new DialogInterface.OnClickListener() {
@Override
public void onClick(DialogInterface dialog, int which) {
// TODO Auto-generated method stub
Log.i("ANYCHAT", "REPLY:"+"EVENT:"+AnyChatDefine.BRAC_VIDEOCALL_EVENT_REPLY+"dwUserId:"+dwUserId+"ERRORCODE:"+AnyChatDefine.RETURNCODE_SESSION_REFUSE+"NAME:"+anychat.GetUserName(-1));
anychat.VideoCallControl(AnyChatDefine.BRAC_VIDEOCALL_EVENT_REPLY, dwUserId, AnyChatDefine.RETURNCODE_SESSION_REFUSE, dwFlags, 20, anychat.GetUserName(-1));
}
}).setMessage(userStr+":请求通话").create();
dialogRequest.show();三、呼叫请求回复
B收到“请求指令之后”之后,可以回复A的请求。
1、同意通话,调用 anychat.VideoCallControl(AnyChatDefine.BRAC_VIDEOCALL_EVENT_REPLY, useridA, AnyChatDefine.RETURNCODE_SUCCESS, dwFlags, 10, anychat.GetUserName(-1));其中useridA为用户A的userId,10、anychat.GetUserName(-1)都是用户自定义参数
2、拒绝通话,调用
anychat.VideoCallControl(AnyChatDefine.BRAC_VIDEOCALL_EVENT_REPLY, useridA, AnyChatDefine.RETURNCODE_SESSION_REFUSE, dwFlags, 20, anychat.GetUserName(-1));
其中useridA为用户A的userId,20、anychat.GetUserName(-1)都是用户自定义参数。A端触发OnAnyChatVideoCallEvent,可以得知B拒绝通话 case AnyChatDefine.BRAC_VIDEOCALL_EVENT_REPLY:
switch(dwErrorCode)
{
case AnyChatDefine.RETURNCODE_SESSION_REFUSE:
showToast("目标用户拒绝会话");
if(dialogCall!=null)
dialogCall.dismiss();
break;3、取消呼叫
A端此时可以取消呼叫,调用anychat.VideoCallControl(AnyChatDefine.BRAC_VIDEOCALL_EVENT_REPLY, useridB, AnyChatDefine.RETURNCODE_SESSION_QUIT, dwFlags, 30, anychat.GetUserName(-1));B端将触发OnAnyChatVideoCallEvent case AnyChatDefine.BRAC_VIDEOCALL_EVENT_REPLY:
switch(dwErrorCode)
{
case AnyChatDefine.RETURNCODE_SESSION_QUIT:
showToast("源用户主动放弃会话");
break;四、会话开始
B端发送“同意会话回复”之后,服务器端将向A、B同时发送“会话开始”指令,A和B将触发OnAnyChatVideoCallEventpublic void OnAnyChatVideoCallEvent(int dwEventType, final int dwUserId,
int dwErrorCode, final int dwFlags, final int dwParam, final String userStr) {
// TODO Auto-generated method stub
switch(dwEventType)
{
case AnyChatDefine.BRAC_VIDEOCALL_EVENT_START:
anychat.LeaveRoom(-1);
Intent intent=new Intent();
intent.putExtra("UserID",targetUserId);
intent.putExtra("ROOMID",dwParam);
intent.setClass(RoomActivity.this, VideoActivity.class);
startActivity(intent);
break;其中dwParam是roomId,A和B收到之后可以进入同一房间进行音视频通话。
五、会话结束
B或者A任何一方发送会话结束指令,调用anychat.VideoCallControl(AnyChatDefine.BRAC_VIDEOCALL_EVENT_FINISH, userID, 0, 0, 0, "");其中userID为对方的useId.此时A、B将会触发“呼叫结束事件”OnAnyChatVideoCallEventpublic void OnAnyChatVideoCallEvent(int dwEventType, int dwUserId,
int dwErrorCode, int dwFlags, int dwParam, String userStr) {
// TODO Auto-generated method stub
public void OnAnyChatVideoCallEvent(int dwEventType, final int dwUserId,
int dwErrorCode, final int dwFlags, final int dwParam, final String userStr) {
// TODO Auto-generated method stub
switch(dwEventType)
{
case AnyChatDefine.BRAC_VIDEOCALL_EVENT_FINISH:
Toast.makeText(this, "通话结束",Toast.LENGTH_LONG).show();
this.finish();
}六、附录,errorcode定义
public static final int RETURNCODE_SUCCESS=0;
public static final int RETURNCODE_SESSION_QUIT = 100101;// 源用户主动放弃会话
public static final int RETURNCODE_SESSION_OFFLINE = 100102;// 目标用户不在线
public static final int RETURNCODE_SESSION_BUSY = 100103;// 目标用户忙
public static final int RETURNCODE_SESSION_REFUSE = 100104;// 目标用户拒绝会话
public static final int RETURNCODE_SESSION_TIMEOUT = 100105;//会话请求超时
public static final int RETURNCODE_SESSION_DISCONNECT= 100106;// 网络断线 廖斌 发表于 2013-9-10 10:55
下面android端为例,展示实现视频呼叫业务逻辑的整个过程
一、设置呼叫回调事件接收
用户收到呼叫请求、 ...
请问实现以上逻辑,需要服务器二次开发吗?
1.如果不需要的话,A呼叫B 执行
anychat.VideoCallControl(AnyChatDefine.BRAC_VIDEOCALL_EVENT_REQUEST, useridB, 0, 0,0, "usernameA")
OnAnyChatVideoCallEvent ()方法无响应.
2.如果需要的话,能否提供代码
谢谢
您好,服务器端不需要进行二次开发,该业务逻辑可以单独由核心服务器来实现,即可以不倚赖业务服务器。
执行方法“anychat.VideoCallControl”无响应,请确认两边客户端、服务器都是最新版本。 admin 发表于 2013-10-11 16:14
您好,服务器端不需要进行二次开发,该业务逻辑可以单独由核心服务器来实现,即可以不倚赖业务服务器。
...
服务器端是最新版本
android客户端是我下载官方demo后修改的
官方demo中点击用户执行以下方法, 但对方无任何提示.
Intent intent = new Intent();
intent.putExtra("UserID", idList.get(position));
intent.setClass(RoomActivity.this, VideoActivity.class);
startActivity(intent);,
我修改为下面的方法,请问是否正确.--------
anychat.VideoCallControl(AnyChatDefine.BRAC_VIDEOCALL_EVENT_REQUEST,
Integer.parseInt(idList.get(position)), 0, 0, 0, "usernameA");
谢谢. KeepGoing2013 发表于 2013-10-11 16:34
服务器端是最新版本
android客户端是我下载官方demo后修改的
官方demo中点击用户执行以下方法, 但对方 ...
可以的。android业务流程描述中的代码还没有更新到网上,还是老的代码 廖斌 发表于 2013-10-11 16:50
可以的。android业务流程描述中的代码还没有更新到网上,还是老的代码
回调接收anychat.SetVideoCallEvent(this)也已经设置,但是OnAnyChatVideoCallEvent()方法无响应.
谢谢 您设置的SetVideoCallEvent在什么地方呢?另外最新的核心服务器才支持业务呼叫逻辑,你连接的服务器是什么版本的? 廖斌 发表于 2013-10-11 17:05
您设置的SetVideoCallEvent在什么地方呢?另外最新的核心服务器才支持业务呼叫逻辑,你连接的服务器是什么 ...
private void InitialSDK() {
anychat = new AnyChatCoreSDK();
anychat.SetBaseEvent(this);
anychat.SetTextMessageEvent(this);
anychat.SetVideoCallEvent(this);
}
服务器版本是v4.8
谢谢 您好,请将客户端、服务器的log均帖上来我们帮您分析一下,谢谢!