Flutter

本文档主要介绍如何进入 TRTC 房间中,只有在进入音视频房间后,用户才能订阅房间中其他用户的音视频流,或者向房间中的其他用户发布自己的音视频流。

调用指引

步骤1:导入 SDK 并设置 App 权限

请参考文档 导入 SDK 到项目中 完成 SDK 的导入工作。

步骤2:创建 SDK 实例并设置事件监听器

调用各平台的初始化接口创建 TRTC 的对象实例。
// 创建 TRTCCloud 单例 trtcCloud = (await TRTCCloud.sharedInstance())!; // 注册 TRTC 事件回调 trtcCloud.registerListener(onRtcListener);

步骤3:监听 SDK 的事件

通过设置事件回调接口,您可以监听 SDK 在运行期间所发生的错误信息、警告信息、流量统计信息、网络质量信息以及各种音视频事件。
// 我们需要定义一个方法用来处理事件的回调,在方法中根据收到的事件的type来进行相应的处理。 // 以onError为例 trtcCloud.registerListener(onRtcListener); onRtcListener(type, param) async { if (type == TRTCCloudListener.onError) { if (param['errCode'] == -1308) { MeetingTool.toast('Failed to start screen recording', context); } else { showErrordDialog(param['errMsg']); } } }

步骤4:准备进房参数 TRTCParams

在调用 enterRoom 接口时需要填写两个关键参数,即 TRTCParams 和 应用场景,接下来进行详细介绍:

参数一:scene

该参数用于指定您的应用场景,即视频通话、互动视频直播、音频通话还是互动音频直播
场景类型
场景介绍
TRTC_APP_SCENE_VIDEOCALL
在视频通话场景中,支持 720p 和 1080p 高清图像质量。单个房间可容纳最多300名同时在线用户,最多50人同时发言。
TRTC_APP_SCENE_LIVE
在互动视频直播场景中,麦克风可以顺畅地打开/关闭,无需等待切换,主播延迟低至300毫秒以下。支持数十万并发观众用户的直播,播放延迟降至1000毫秒。
注意:在此场景下,您必须使用 TRTCParams 中的 role 字段指定当前用户的角色。
TRTC_APP_SCENE_AUDIOCALL
在音频通话场景中,支持48 kHz双声道音频通话。单个房间可容纳最多300名同时在线用户,最多50人同时发言。
TRTC_APP_SCENE_VOICE_CHATROOM
在互动音频直播场景中,麦克风可以顺畅地打开/关闭,无需等待切换,主播延迟低至300毫秒以下。支持数十万并发观众用户的直播,播放延迟降至1000毫秒。
注意:在此场景下,您必须使用 TRTCParams 中的 role 字段指定当前用户的角色。

参数二:TRTCParams

TRTCParams 由很多的字段构成,但通常您只需要关心如下几个字段的填写:
参数名称
字段含义
补充说明
数据类型
填写示例
sdkAppId
应用 ID
您可以在 实时音视频控制台 中找到这个 SDKAppID,如果没有就单击“创建应用”按钮创建一个新的应用。
数字
1400000123
userId
用户 ID
即用户名,只允许包含大小写英文字母(a-z、A-Z)、数字(0-9)及下划线和连词符。注意 TRTC 不支持同一个 userId 在两台不同的设备上同时进入房间,否则会相互干扰。
字符串
“denny” 或者 “123321”
userSig
进房鉴权票据
您可以使用 SDKAppID 和 userId 计算出 userSig,计算方法请参见 如何计算及使用 UserSig
字符串
eJyrVareCeYrSy1SslI...
roomId
房间号
数字类型的房间号。注意如果您想使用字符串类型的房间号,请使用 strRoomId 字段,而不要使用 roomId 字段,因为 strRoomId 和 roomId 不可以混用。
数字
29834
strRoomId
房间号
字符串类型的房间号。注意 strRoomId 和 roomId 不可以混用,“123” 和 123 在 TRTC 后台服务看来并不是同一个房间。
字符串
"29834"
role
角色
分为“主播”和“观众”两种角色,只有当 TRTCAppScene 被指定为 TRTCAppSceneLIVETRTCAppSceneVoiceChatRoom 这两种直播场景时才需要指定该字段。
枚举值
TRTCRoleAnchor 或 TRTCRoleAudience
注意:
TRTC 不支持同一个 userId 在两台不同的设备上同时进入房间,否则会相互干扰。
每个端在应用场景 appScene 上必须要进行统一,否则会出现一些不可预料的问题。

步骤5:进入房间(enterRoom)

在准备好步骤4中两个参数(应用场景 和 TRTCParams)后,就可以调用 enterRoom 接口函数进入房间了。
enterRoom() async { try { userInfo['userSig'] = await GenerateTestUserSig.genTestSig(userInfo['userId']); meetModel.setUserInfo(userInfo); } catch (err) { userInfo['userSig'] = ''; print(err); }
// 如果您的场景为“互动视频直播”,请将场景设置为 TRTC_APP_SCENE_LIVE,并在TRTCParams中为role字段设置相应的值。 await trtcCloud.enterRoom( TRTCParams( sdkAppId: GenerateTestUserSig.sdkAppId, userId: userInfo['userId'], userSig: userInfo['userSig'], role: TRTCCloudDef.TRTCRoleAnchor, roomId: meetId!), TRTCCloudDef.TRTC_APP_SCENE_LIVE); }
事件回调 如果进入房间成功,SDK 会回调 onEnterRoom(result) 事件,其中 result 会是一个大于 0 的数值,代表加入房间所消耗的时间,单位为毫秒(ms)。 如果进入房间失败,SDK 同样会回调 onEnterRoom(result) 事件,但参数 result 会是一个负数,其数值为进房失败的错误码。
//监听 SDK 的 onEnterRoom 事件并获知是否成功进入房间
onRtcListener(type, param) async {
if (type == TRTCCloudListener.onEnterRoom) { if (param > 0) { MeetingTool.toast('Enter room success', context); } }
}