本章将介绍如何实现视频互动直播,视频互动直播的 API 调用时序见下图:
初始化
首先继承 JCMediaChannelCallback 对象和 JCMediaDeviceCallback 对象,并实现这两个对象中的纯虚函数。
class JCManager : public JCMediaDeviceCallback, public JCMediaChannelCallback
{
public:
//自身状态变化回调
virtual void onMediaChannelStateChange(JCMediaChannelState state, JCMediaChannelState oldState);
//频道属性变化回调
virtual void onMediaChannelPropertyChange(JCMediaChannelPropChangeParam propChangeParam);
//加入频道结果回调
virtual void onJoin(bool result, JCMediaChannelReason reason, const char* channelId);
//离开频道结果回调
virtual void onLeave(JCMediaChannelReason reason, const char* channelId);
//解散频道结果回调
virtual void onStop(bool result, JCMediaChannelReason reason);
//查询频道结果回调
virtual void onQuery(int operationId, bool result, JCMediaChannelReason reason, JCMediaChannelQueryInfo* queryInfo);
//新成员加入回调
virtual void onParticipantJoin(JCMediaChannelParticipant* participant);
//成员离开回调
virtual void onParticipantLeft(JCMediaChannelParticipant* participant);
//成员更新回调
virtual void onParticipantUpdate(JCMediaChannelParticipant* participant, JCMediaChannelParticipant::ChangeParam changeParam);
//频道中收到消息回调
virtual void onMessageReceive(const char* type, const char* content, const char* fromUserId);
//邀请sip成员结果回调
virtual void onInviteSipUserResult(int operationId, bool result, JCMediaChannelReason reason);
//成员声音变化
virtual void onParticipantVolumeChange(JCMediaChannelParticipant* participant);
public:
//媒体设备对象
JCMediaDevice* mediaDevice;
//媒体通道对象
JCMediaChannel* mediaChannel;
};
然后调用 createJCMediaDevice 和 createJCMediaChannel 以初始化多方视频通话需要的模块:
//初始化
bool JCManager::initialize()
{
//1. 媒体类
mediaDevice = createJCMediaDevice(client, this);
//1. 媒体通道类
mediaChannel = createJCMediaChannel(client, mediaDevice, this);
return true;
}
其中:
JCMediaDevice create 方法中的 this 为 JCMediaDeviceCallback 的派生类,该类于将媒体设备相关的事件通知给上层。因此需要先创建 JCMediaDeviceCallback 的派生类,然后在该派生类中实现 JCMediaDeviceCallback 的纯虚函数。
JCMediaChannel create 方法中的 this 为 JCMediaChannelCallback 的派生类,该类用于将频道中的相关事件通知给上层。因此需要先创建 JCMediaChannelCallback 的派生类,然后在该派生类中实现 JCMediaChannelCallback 的纯虚函数。
回调中的对象只能在该回调中使用,不能保存,上层可通过对应的方法获取通话对象。
角色设置
直播有两种用户角色:主播和观众。观众只能看到主播的画面、听到主播的声音。
加入频道前要先进行角色的设置。其中主播需要上传本地音视频流,观众则不需要。
角色值可以根据 JCMediaChannelCustomRole 枚举值进行自定义,例如
//自定义主播角色
JCMediaChannelCustomRole ROLE_BROASCASTER = JCMediaChannelCustomRole0;
//自定义观众角色
JCMediaChannelCustomRole ROLE_AUDIENCE = JCMediaChannelCustomRole1;
调用 setCustomRole 设置自己的角色以进入频道。
// 设置角色,participant(第二个参数) 值为 NULL 代表设置自身的角色
JCManager::shared()->mediaChannel->setCustomRole(ROLE_BROASCASTER, NULL);
加入频道后,如果想切换用户角色,也可以调用 setCustomRole 方法。
加入频道
加入频道前需根据成员角色进行音视频流上传的控制,主播需要上传本地音视频流,观众则不需要。
1. 调用 enableUploadAudioStream 开启音频流,调用 enableUploadVideoStream 开启视频流。
//根据角色上传本地音视频流
JCManager::shared()->mediaChannel->enableUploadAudioStream(customRole == ROLE_BROASCASTER);
JCManager::shared()->mediaChannel->enableUploadVideoStream(customRole == ROLE_BROASCASTER);
这两个接口可以在加入频道之前调用,也可以在加入频道之后调用。
如果在加入频道前调用,只是预打开或关闭“上传音视频流”的标识,但不发送数据,当加入频道后,服务器会根据参数传入的值来确定是否上传音视频流数据。
如果加入频道前 enableUploadVideoStream 方法传入的值为 false,则在加入频道后会自动开启语音通话模式。
此外,调用 enableUploadVideoStream 方法发送本地视频流数据还要依赖摄像头是否已经打开。
接口调用后,当加入频道后,频道中的其他成员会收到该成员”是否上传音视频“的状态变化回调(onParticipantUpdate)。
角色设置后,调用 join 方法创建并加入频道。你需要在该方法中传入如下参数:
channelIdOrUri:频道 ID 或频道 Uri,当 param 中 uriMode 设置为 true 时表示频道 Uri,其他表示频道 ID。频道 ID 或 Uri 相同的用户会进入同一个频道。
joinParam:加入参数,没有则填 NULL。详见 JCMediaChannelJoinParam 对象。
// 加入频道
JCManager::shared()->mediaChannel->join("频道 ID", NULL);
加入频道后收到 onJoin 回调。
// 加入频道结果回调 void JCManager::onJoin(bool result, JCMediaChannelReason reason, const char* channelId) { if (result) { //加入成功的逻辑 ... } else { //加入失败的逻辑 ... } }
创建本地视频画面
1. 加入频道后,调用 JCMediaChannel 中的 getSelfParticipant 方法获取频道内自身对象。该方法返回 JCMediaChannelParticipant 对象
// 1. 获得频道成员自身对象
JCMediaChannelParticipant* participant = JCManager::shared()->mediaChannel->getSelfParticipant();
调用 JCMediaChannelParticipant 类中的 startVideo 方法打开本地视频预览。该方法会返回一个 JCMediaDeviceVideoCanvas 对象,该对象用于将视频渲染到画布上,并管理渲染的方式。(调用此方法会打开摄像头)
示例代码:
// 2. 打开本地视频预览
JCMediaDeviceVideoCanvas* mConfSelfCanvas;
if (mediaChannel->getUploadLocalVideo() && mConfSelfCanvas == NULL)
{
if (strlen(JCManager::shared()->mediaDevice->getCamera().cameraId) > 0)
{
//创建本地视频画面
mConfSelfCanvas = mediaChannel->getSelfParticipant()->startVideo(
mWndConfSelfVideo.m_hWnd,
JCMediaDeviceRenderModeFullContent,
JCMediaChannelPictureSizeLarge);
}
}
创建远端视频画面
视频通话中,通常需要看到其他用户。通过 JCMediaChannel 中的 participants 属性获取频道内所有成员对象。
然后调用 JCMediaChannelParticipant 类中的 startVideo 方法设置远端用户的视图。调用该方法会返回一个 JCMediaDeviceVideoCanvas 对象,该对象用于将视频渲染到画布上,并管理渲染的方式。
示例代码:
//取频道内所有成员对象
JCMediaDeviceVideoCanvas* mConfOtherCanvas;
std::list<JCMediaChannelParticipant*>* participants = NULL;
JCMediaChannelParticipant* other = NULL;
participants = mediaChannel->getParticipants();
for (JCMediaChannelParticipant* participant : *participants) {
if (!participant->isSelf())
{
other = participant;
break;
}
}
if (other != NULL && other->isVideo())
{
if (mConfOtherCanvas == NULL)
{
//创建远端画面
mConfOtherCanvas = participant->startVideo(
mWndConfOtherVideo.m_hWnd,
JCMediaDeviceRenderModeFullContent,
JCMediaChannelPictureSizeLarge);
}
}
离开频道
调用 leave 方法离开当前频道。
JCManager::shared()->mediaChannel->leave();
离开频道后,自身收到 onLeave 回调,其他成员同时收到 onParticipantLeft 回调。
// 离开频道回调
void JCManager::onLeave(JCMediaChannelReason reason, const char* channelId);
{
//离开频道的逻辑
}
销毁本地和远端视频画面
在视频挂断后,调用 JCMediaChannelParticipant 里的 stopVideo 销毁本地和远端视频画面。
示例代码:
if (!mediaChannel->getUploadLocalVideo() && mConfSelfCanvas != NULL)
{
//销毁本地视频画面
mediaChannel->getSelfParticipant()->stopVideo();
mConfSelfCanvas = NULL;
mWndConfSelfVideo.Invalidate();
}
if (mConfOtherCanvas != NULL)
{
for (JCMediaChannelParticipant* participant : *participants)
{
if (!participant->isSelf())
{
//销毁远端视频画面
participant->stopVideo();
}
}
mConfOtherCanvas = NULL;
mWndConfOtherVideo.Invalidate();
}
解散频道
如果想解散频道,可以调用下面的接口,此时所有成员都将被退出。
// 结束频道
JCManager::shared()->mediaChannel->stop();
解散频道后,发起结束的成员收到 onStop 回调,其他成员同时收到 onLeave 回调。 解散失败原因枚举值请参考 JCMediaChannelReason 。
void JCManager::onStop(bool result, JCMediaChannelReason reason)
{
//结束频道的处理逻辑
}
解散频道后,同样需要调用 JCMediaChannelParticipant 里的 stopVideo 销毁本地和远端视频画面。