阿里云RTC的基本功能包含初始化SDK、加入频道、本地发布、订阅远端和离开频道等。通过阅读本文,您可以了解阿里云RTC的基本功能。
前提条件
- 您已下载并集成最新版本的SDK。具体操作,请参见Windows端集成SDK。
- 您已获取加入频道必需的频道鉴权令牌(Token)。具体操作,请参见生成Token。
使用限制
本文仅供SDK 2.1及以上版本使用,如果您需要SDK 1.17版本对应的文档,请参见Windows端实现基本功能。
操作步骤
- 初始化SDK。
您需要创建AliEngine实例,并注册回调。具体回调接口请参见AliEngineEventListener。
mpEngine = AliEngine::Create(pConfig);//pConfig是SDK初始化配置,当前版本请使用空字符串说明 mpEngine->SetEngineEventListener(pListener);//pListener是您实现的AliRtcEventListener对象,用于接收SDK的回调
- 本地预览。在创建完AliEngine实例后,您可以创建canvas布局进行本地预览视频。
AliEngineVideoCanvas canvas; canvas.displayView = (void*)GetSafeHwnd(); canvas.renderMode = AliEngineRenderMode::AliEngineRenderModeAuto; mpEngine->SetLocalViewConfig(canvas, AliEngineVideoTrackCamera); mpEngine->StartPreview();
说明- AliEngineRenderMode提供五种渲染模式:
- AliEngineRenderModeAuto(推荐):自动。
- AliEngineRenderModeStretch:拉伸填充视图,不保持视频比例。
- AliEngineRenderModeFill:在保持视频宽高比的同时缩放,填充黑边。
- AliEngineRenderModeCrop:在保持视频宽高比的同时缩放,并裁剪以适合视图。
- AliEngineRenderModeScroll:滚动视图以显示更多内容。
- AliEngineRenderMirrorMode在本地或远端均可设置镜像模式,并提供三种镜像模式:
- AliEngineRenderMirrorModeOnlyFrontMirror:只有前置摄像头预览镜像,其余不镜像。
- AliEngineRenderMirrorModeAllMirror:全部镜像。
- AliEngineRenderMirrorModeAllNoMirror:全部不镜像。
- AliEngineRenderMode提供五种渲染模式:
- 可选:取消本地预览。
engine.stopPreview();
- 设置发布与订阅。
- SDK默认入会后自动发布音频流与视频流,如果您不希望自动发布音频和视频,可以在入会前通过以下接口设置:
mpEngine->PublishLocalAudioStream(false); mpEngine->PublishLocalVideoStream(false);
- SDK默认入会后自动订阅远端的音频流与视频流,如果您不希望自动订阅音频与视频,可以在入会前通过以下接口设置:
mpEngine->SetDefaultSubscribeAllRemoteAudioStreams(false); mpEngine->SetDefaultSubscribeAllRemoteVideoStreams(false);
- SDK默认入会后自动发布音频流与视频流,如果您不希望自动发布音频和视频,可以在入会前通过以下接口设置:
- 本地预览。在创建完AliEngine实例后,您可以创建canvas布局进行本地预览视频。
- 加入频道。
AliEngineAuthInfo authinfo; authinfo.channelId = /* 频道ID */; authinfo.appId = /* 应用ID */; authinfo.token = /* 频道鉴权令牌Token */; authinfo.nonce = /* 随机码 */; authinfo.userId = /* 用户ID */; authinfo.timestamp = /* 时间戳 */; authinfo.gslbCount = 1; /* GSLB地址个数 */; authinfo.gslb = new char*[authinfo.gslbCount]; /* GSLB地址组 */; for (int i = 0; i < authinfo.gslbCount; i++) { authinfo.gslb[i] = "https://rgslb.rtc.aliyuncs.com"; } authinfo.agentCount = 1;/* AGENT地址个数 */; authinfo.agent = new char*[authinfo.agentCount];/* AGENT地址组 */; for (int i = 0; i < authinfo.agentCount; i++) { authinfo.agent[i] = "example.com"; } m_pEngine->joinChannel(authinfo,userName /* 显示名称 */);
参数 描述 appId 应用ID,在控制台应用管理页面创建和查看。 channelId 频道ID。1~64位,由大小写字母、数字、下划线(_)、短划线(-)组成。 userId 用户ID。1~64位,由大小写字母、数字、下划线(_)、短划线(-)组成。 说明 同一个用户ID在其他端登录,先入会的端会被后入会的端踢出频道。nonce 随机码。以前缀AK-开头,由大小写字母、数字组成,最大64字节。例如:AK-2b9be4b25c2d38c409c376ffd2372be1。 timestamp 过期时间戳。可以选择12小时、24小时、3天和7天,代表令牌有效时间。 token 频道鉴权令牌,计算方法: token = sha256(appId + appKey + channelId + userId + nonce + timestamp)
。gslb 服务地址,该参数是数组类型,当前请使用: ["https://rgslb.rtc.aliyuncs.com"]
,请您通过业务服务器下发到客户端SDK,不建议您将该地址固化在客户端代码。 - 发布或取消发布本地流。
- 发布本地音频流和视频流
如果您在入会前没有设置发布音频流和视频流,则入会后会自动发布本地的音频流和视频流;如果您在入会前设置取消发布音频流和视频流,则入会后需要调用以下接口进行手动发布:
mpEngine->PublishLocalAudioStream(true); mpEngine->PublishLocalVideoStream(true);
- 发布小流
SDK默认不发布小流,如果您需要推送小流,请调用以下接口(入会前、后均可调用):
mpEngine->PublishLocalDualStream(true);
- 取消发布本地音频流和视频流
如果您需要取消发布本地的音频流和视频流,请调用以下接口:
mpEngine->PublishLocalAudioStream(false); mpEngine->PublishLocalVideoStream(false);
- 发布本地音频流和视频流
- 订阅或取消订阅远程流。
- 订阅远端音频流和视频流
如果您在入会前没有设置订阅音频流和视频流,则入会后会自动订阅远端的音频流和视频流;如果您在入会前设置取消订阅音频流和视频流,则入会后需要调用以下接口进行手动订阅:
mpEngine->SetDefaultSubscribeAllRemoteAudioStreams(true); mpEngine->SetDefaultSubscribeAllRemoteVideoStreams(true);
说明 此接口作用于后续入会的远端用户,对于调用此接口之前已经入会的远端用户,此接口不产生影响。订阅成功后,您可以在OnRemoteTrackAvailableNotify回调里渲染远端的视频画面:
AliEngineVideoCanvas canvas; canvas.displayView = (void*)view->GetSafeHwnd(); canvas.mirrorMode = view->mCameraMirror ? AliEngineRenderMirrorModeAllMirror : AliEngineRenderMirrorModeAllNoMirror; mpEngine->SetRemoteViewConfig(canvas, uid.c_str(), AliEngineVideoTrackCamera);
- 取消订阅远端音频流和视频流
如果您需要取消订阅远端的音频流和视频流,请调用以下接口:
mpEngine->SetDefaultSubscribeAllRemoteAudioStreams(false); mpEngine->SetDefaultSubscribeAllRemoteVideoStreams(false);
说明 此接口作用于后续入会的远端用户,对于调用此接口之前已经入会的远端用户,此接口不产生影响。 - 订阅特定用户的音频流和视频流
当已取消订阅所有的音频流和视频流之后,如果您需要订阅某个远端用户的音频流和视频流,可以通过调用以下接口实现(如果需要取消订阅此远端用户的音频流和视频流,参数sub传入false即可):
mpEngine->SubscribeRemoteAudioStream(uid.c_str(), true); mpEngine->SubscribeRemoteVideoStream(uid.c_str(), AliEngineVideoTrackCamera, true);
- 订阅小流
如果您需要订阅小流,请调用以下接口:
mpEngine->SetRemoteDefaultVideoStreamType(AliEngineVideoStreamTypeLow);
说明 此接口作用于后续入会的远端用户,对于调用此接口之前已经入会的远端用户,此接口不产生影响。 - 取消订阅所有远端用户音频流和视频流
如果您希望当前会议中及后续入会的用户全部取消订阅,请调用以下接口:
mpEngine->SubscribeAllRemoteVideoStreams(false); mpEngine->SubscribeAllRemoteAudioStreams(false);
说明- 当以上接口设置为false时,优先级最高,即使SetDefaultSubscribeAllRemoteAudioStreams和SetDefaultSubscribeAllRemoteVideoStreams设置为true时也不生效。
- 当以上接口设置为true时,是否订阅以SetDefaultSubscribeAllRemoteAudioStreams和SetDefaultSubscribeAllRemoteVideoStreams设置为准。
- 订阅远端音频流和视频流
- 离开频道。
m_pEngine->LeaveChannel();
后续步骤
您可以下载示例代码,快速运行Demo,实现频道内和其他人进行实时音视频通话,详情请参见运行Windows Demo。