TRTCParams

TRTCParams

5.1 进房相关参数

只有该参数填写正确,才能顺利调用 enterRoom 进入 roomId 所指定的音视频房间。

Constructor

new TRTCParams(sdkAppId, userId, userSig, roomId, strRoomId, role, privateMapKey, businessInfo, streamId, userDefineRecordId)

Parameters:
Name Type Description
sdkAppId Number

【字段含义】应用标识(必填),腾讯视频云基于 sdkAppId 完成计费统计。
【推荐取值】在腾讯云 TRTC 控制台 中创建应用,之后可以在账号信息页面中得到该 ID。

userId String

【字段含义】用户标识(必填)。当前用户的 userId,相当于用户名,UTF-8编码。
【推荐取值】如果一个用户在您的账号系统中的 ID 为“abc”,则 userId 即可设置为“abc”。

userSig String

【字段含义】用户签名(必填),当前 userId 对应的验证签名,相当于登录密码。
【推荐取值】请参考 如何计算UserSig

roomId Number

【字段含义】房间号码(必填),指定房间号,在同一个房间里的用户(userId)可以彼此看到对方并进行视频通话, roomId 和 strRoomId 必须填一个, 若您选用 strRoomId,则 roomId 需要填写为0。
【推荐取值】您可以随意指定,但请不要重复,如果您的用户账号 ID 是数字类型的,可以直接用创建者的用户 ID 作为 roomId。

strRoomId String

【字段含义】字符串房间号码(选填),roomId 和 strRoomId 必须填一个。若两者都填,则优先选择 roomId。
【推荐取值】您可以随意指定,但请不要重复。

role TRTCRoleType

【字段含义】直播场景下的角色,仅适用于直播场景(TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom),视频通话场景下指定无效。
【推荐取值】默认值:主播(TRTCRoleAnchor)

privateMapKey String

【字段含义】房间签名(非必填),如果您希望某个房间只能让特定的某些 userId 进入,就需要使用 privateMapKey 进行权限保护。
【推荐取值】仅建议有高级别安全需求的客户使用,参考文档:进房权限保护

businessInfo String

【字段含义】业务数据(非必填),某些非常用的高级特性才需要用到此字段。
【推荐取值】不建议使用

streamId String

【字段含义】绑定腾讯云直播 CDN 流 ID[非必填],设置之后,您就可以在腾讯云直播 CDN 上通过标准直播方案(FLV或HLS)播放该用户的音视频流。
【推荐取值】限制长度为64字节,可以不填写,一种推荐的方案是使用 “sdkappid_roomid_userid_main” 作为 streamid,这样比较好辨认且不会在您的多个应用中发生冲突。
【特殊说明】要使用腾讯云直播 CDN,您需要先在控制台 中的功能配置页开启“启动自动旁路直播”开关。
【参考文档】CDN 旁路直播

userDefineRecordId String

【字段含义】设置云端录制完成后的回调消息中的 "userdefinerecordid" 字段内容,便于您更方便的识别录制回调。
【推荐取值】限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。
【参考文档】云端录制