前提条件
在实现基本功能前,请您确保下载最新 SDK,请参见 SDK 下载。
获得加入频道必须的频道鉴权令牌(Token):
- 您可以在控制台生成临时 Token 校验加入频道是否成功,详情请参见控制台生成 Token。
- 在安全要求更高的场景下,建议您在服务端生成 Token,详情请参见服务端生成 Token。
说明 本文中的实现方法为主要功能方法,仅供参考,您可以根据业务需求进行实际开发。
操作步骤
- 初始化 SDK。
- 如果 CRtcSampleDlg 类中有定义 AliRTCEngine 实例,则需要创建 AliRTCEngine 实例,并注册 AliRtcEventListener 监听相关回调,更多信息,请参见回调及监听。
m_pEngine = AliRtcEngine::sharedInstance(AliRtcEventListener* pListener, char* pConfig);//pListener是您实现的AliRtcEventListener对象,用于接收SDK的回调。pConfig是SDK初始化配置,当前版本请使用空字符串
说明 暂不支持多实例。
- 创建 canvas 布局进行本地预览视频。
- 开启本地预览。
// 获取预览窗口 AliVideoCanvas canvas; canvas.renderMode = AliRtcRenderModeAuto; canvas.hWnd = /*预览窗口句柄*/; // 设置预览窗口 m_pEngine->setLocalViewConfig(canvas, AliRtcVideoTrackCamera); m_pEngine->startPreview(); canvas.flip = true;//true表示镜像画面,false表示正常画面
- 说明AliRtcRenderMode 提供四种渲染模式。
- (推荐)AliRtcRenderModeAuto:自动模式。
- AliRtcRenderModeStretch:拉伸填充视图,不保持视频比例。
- AliRtcRenderModeFill:在保持视频宽高比的同时缩放,填充黑边。
- AliRtcRenderModeCrop:在保持视频宽高比的同时缩放,并裁剪以适合视图。
- 停止本地预览。
m_pEngine->stopPreview();
- 设置自动或者手动模式。
/* 设置自动发布和订阅,只能在joinChannel之前设置 autoPub: true表示自动发布,false表示手动发布 autoSub: true表示自动订阅,false表示手动订阅 */ m_pEngine->setAutoPublishSubscribe(bool autoPub, bool autoSub);
- 自动发布模式: 如果您打开自动发布模式,加入频道之后,SDK 将自动开始发布音视频流;如果关闭自动发布模式,则需要您调用 publish 接口之后才会发布音视频流。
- 自动订阅模式: 如果您打开自动订阅模式,加入频道之后,SDK 将会自动订阅当前频道内其他人的音视频流;如果关闭自动订阅模式,则需要您调用 subscribe 接口之后才会订阅其他人的音视频流。
- 加入频道。
AliRtcAuthInfo authinfo; authinfo.channel = /* 频道ID */; authinfo.appid = /* 应用ID */; authinfo.token = /* 频道鉴权令牌Token */; authinfo.nonce = /* 随机码 */; authinfo.user_id = /* 用户ID */; authinfo.timestamp = /* 时间戳 */; authinfo.gslb = /* GSLB地址 */; ... // joinChannel是一个异步接口,设置回调函数 auto onJoinResult = [](void *opaque, int errCode) { if (errCode == 0) { // 加入频道成功 } else { //加入频道失败 } }; m_pEngine->joinChannel(authinfo, /* 显示名称 */, onJoinResult, /*UserData,传递给onJoinResult回调函数*/);
参数 | 描述 |
appid | 应用 ID,在控制台应用管理页面创建和查看。 |
channel | 频道 ID。1~64 位,支持大小写字母、数字、下划线(_)、短划线(-)。 |
user_id | 用户 ID。1~64 位,支持大小写字母、数字、下划线(_)、短划线(-)。
说明 同一个用户 ID 在其他端登录,先入会的端会被后入会的端踢出频道。 |
nonce | 随机码。需要加上前缀 AK-,由字母 [a-zA-Z] 和数字 [0-9] 组成,不包含特殊字符,最大 64 字节。例如:AK-2b9be4b25c2d38c409c376ffd2372be1。 |
timestamp | 频道过期时间戳。代表令牌有效时间为当前时间 + 所选择小时数。 |
token | 频道鉴权令牌,计算方法:token = sha256(appId + appKey + channel + userId + nonce + timestamp) 。 |
gslb | 服务地址,该参数是数组类型,当前请使用:["https://rgslb.rtc.aliyuncs.com"] ,请您通过业务服务器下发到客户端 SDK,不建议您将该地址固化在客户端代码。 |
- 发布或取消发布本地流。发布本地流。
- 自动发布模式下:加入频道成功后,即可发布本地流,无需再次调用 publish 接口。
- 手动发布模式下:加入频道成功后,可通过以下接口发布本地流。
如果发布过程中需要变更配置或者停止发布,需要按如下流程先重新设置配置参数,然后再调用 publish 接口。
//发布本地流设置 //true表示允许发布屏幕共享流,false表示不允许 m_pEngine->configLocalScreenPublish(true); //true表示允许发布音频流,false表示不允许 m_pEngine->configLocalAudioPublish(true); //true表示允许发布相机流,false表示不允许 m_pEngine->configLocalCameraPublish(true); //true表示允许发布次要视频流;false表示不允许 //子码流 m_pEngine->configLocalSimulcast(true, AliRtcVideoTrack::AliRtcVideoTrackCamera); //屏幕共享流不支持子码流,因此第二个参数只能为AliRtcVideoTrack::AliRtcVideoTrackCamera。 // Call back when publish finished auto onPubResult = [](void *opaque, int errCode) { if (errCode == 0) { // 发布成功 } else { // 发布失败 } }; m_pEngine->publish(onPubResult, /*UserData,传递给onPubResult回调函数*/);
取消发布本地流。
m_pEngine->configLocalScreenPublish(false); m_pEngine->configLocalAudioPublish(false); m_pEngine->configLocalCameraPublish(false); m_pEngine->configLocalSimulcast(false, AliRtcVideoTrack::AliRtcVideoTrackCamera); // 取消发布完成返回成功或者失败 auto onPubResult = [](void *opaque, int errCode) { if (errCode == 0) { // 取消发布成功 } else { // 取发布失败 } }; m_pEngine->publish(onPubResult, /*UserData,传递给onPubResult回调函数*/);
- 订阅或取消订阅远程流。订阅远程流。
- 自动订阅模式下:加入频道成功后,即可订阅远端流,无需再次调用 subscribe 接口。
- 手动订阅模式下:加入频道成功后,可通过以下接口订阅远端流。
- 如果订阅过程中需要变更配置或者停止订阅,需要按如下流程先重新设置配置参数,然后再调用 subscribe 接口。
//true表示允许订阅音频流,false表示不允许 m_pEngine->configRemoteAudio(/* remoteUserID */, true); //true表示允许订阅屏幕共享流,false表示不允许 m_pEngine->configRemoteScreenTrack(/* remoteUserID */, true); //第二个参数preferMaster true表示优先订阅大流,fales表示优先订阅次小流 //第三个参数enable true表示允许订阅相机流,false表示不允许 m_pEngine->configRemoteCameraTrack(/* remoteUserID */, true, true); //Call back when subscribe finished auto onSubResult = [](void *opaque, const AliRtc::String &uid, AliRtcVideoTrack vt, AliRtcAudioTrack at) { }; m_pEngine->subscribe(/* remoteUserID */, onSubResult, /*UserData*/);
自动模式或非自动模式下,订阅成功后,您可以通过订阅的回调,进行相关 UI 操作或逻辑处理。
auto onSubResult = [](void *opaque, const AliRtc::String &uid, AliRtcVideoTrack vt, AliRtcAudioTrack at) { ... // 设置视频流的窗口 if (vt == AliRtcVideoTrack::AliRtcVideoTrackCamera || vt == AliRtcVideoTrack::AliRtcVideoTrackBoth) { /*设置远端视频预览*/ }
另外,您可以通过 onRemoteTrackAvailableNotify 回调获得远端用户的流状态变更。例如:手动模式下,收到此回调后,可以获取到远端用户的发布状态,然后相应做出订阅操作,或者更新 UI 等。
void onRemoteTrackAvailableNotify(const AliRtc::String & uid, AliRtcAudioTrack audioTrack, AliRtcVideoTrack videoTrack) { }
取消订阅远程流。
m_pEngine->configRemoteAudio(/* remoteUserID */, false); m_pEngine->configRemoteScreenTrack(/* remoteUserID */, false); m_pEngine->configRemoteCameraTrack(/* remoteUserID */, true, false); auto onSubResult = [](void *opaque, const AliRtc::String &uid, AliRtcVideoTrack vt, AliRtcAudioTrack at) { }; m_pEngine->subscribe(/* remoteUserID */, onSubResult, /*UserData*/);
- 离开频道。
m_pEngine->leaveChannel();
您可以下载示例代码,快速跑通 Demo,实现频道内和其他人进行实时音视频通话,详情请参见 Windows Demo。接口方法请参见 AliRtcEngine 接口。
「视频云技术」你最值得关注的音视频技术公众号,每周推送来自阿里云一线的实践技术文章,在这里与音视频领域一流工程师交流切磋。