房间功能
joinRoom
- (int)joinRoom:(HWRtcJoinParam * _Nonnull)joinParam;
【功能说明】
加入房间。该方法让用户加入通话房间。如果已在通话中,用户必须调用leaveRoom退出当前通话,才能进入下一个房间。
【请求参数】
joinParam:用户信息,具体请参见HWRtcJoinParam。
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HWRtcErrorCode。
![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/caution_3.0-zh-cn.png)
会触发以下回调:
- onConnStateChange:连接状态发生改变。
- onJoinSuccess:加入房间成功。
- onRemoteUserOnline:用户收到当前用户加入房间的通知。
- onJoinRoomFailure:加入房间失败。
changeUserRole
- (int)changeUserRole:(HWRtcRole)role signature:(NSString *)authorization ctime:(long long)ctime;
【功能说明】
设置用户在当前房间内的角色类型,角色切换时使用。
【请求参数】
- role:用户角色类型,joiner类型和player类型,具体请参见HWRtcRole。
- authorization:预留参数,填null。
- ctime:预留参数,填0。
【返回参数】
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HWRtcErrorCode。
![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/caution_3.0-zh-cn.png)
- 加入房间前,可以通过joinRoom的userRole参数确认角色信息。
- 加入指定房间后才可以在指定房间内进行角色切换,当前仅支持joiner和player角色切换。跨房场景下,通过对应connection连接下的changeUserRole接口实现在跨入房间中的角色类型切换。
- 切换成功触发onUserRoleChange回调。切换失败会触发onError回调,错误码HWRtcErrorCode :HWRtcErrorCodeUserRoleChangeFail。
- 同一时间不同房间最多只能有一个joiner,player切换joiner的时候,需要将其他房间的joiner先切换成player。
- 不支持缺省用户昵称入会。
renewAuthorization
- (int)renewAuthorization:(NSString *_Nonnull)signature time:(long long)time;
【功能说明】
鉴权签名过期,收到onAuthorizationExpired签名鉴权过期回调后,更新鉴权签名。
- signature:鉴权签名字串。
- time:过期时间。
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HWRtcErrorCode。
![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/caution_3.0-zh-cn.png)
- 必须调用leaveRoom结束通话后才可以开始下一次通话。
- 会触发以下回调:
- onLeaveRoom:离开房间回调。
- onConnStateChange:连接状态改变回调。
- onRemoteUserOffline:远端用户收到当前用户离开房间的通知。
changeUserName
- (int)changeUserName:(NSString *)userName;
【功能说明】
房间内设置用户自己的昵称。
【请求参数】
userName:变更的昵称。
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HWRtcErrorCode。
![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/caution_3.0-zh-cn.png)
- 该接口仅支持房间内调用,更改的昵称会被实时同步到房间内其他用户的用户列表,退出房间不会保存,再次加入房间变更为加入房间时设置的昵称(参考joinRoom接口注意事项)。
- 会触发用户名变更通知的回调onUserNameChangedNotify。
createConnection
- (HWRtcConnection *_Nullable)createConnection:(NSString *_Nullable)roomId;
【功能说明】
根据房间ID,创建HWRtcConnection对象,为跨房做准备。
通过此接口创建一个与房间关联的HWRtcConnection连接对象。
该方法支持多次调用,创建多个HWRtcConnection连接对象,调用每个对象中的joinRoom方法,可以同时加入到多个房间。在每个房间中,可以分别订阅和选看房间中的用户。
具体请参见事件回调(HWRtcConnection)有关接口和回调。
【请求参数】
roomid:房间ID。
【返回参数】
HWRtcConnection:成功返回连接对象指针,失败返回为空。
![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/caution_3.0-zh-cn.png)
- 同一时间最多只能创建4个连接对象,每个连接对象对应的房间ID必须互不相同。
- 如果使用HWRtcConnection对象加入房间,则加入房间的房间ID不能和已创建连接对象对应的房间ID相同。
- 同一时间只能以JOINER角色加入某一个房间。
addMultiRoomMediaRelay
- (int)addMultiRoomMediaRelay:(HWRtcMultiRoomMediaRelayConfiguration *)roomMediaRelayConfiguration;
【功能说明】
添加单个跨房。
【请求参数】
roomMediaRelayConfiguration:跨房信息,具体请参见HRTCMultiRoomMediaRelayConfiguration。
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HRTCErrorCode。
removeMultiRoomMediaRelay
- (int)removeMultiRoomMediaRelay:(HWRtcMultiRoomMediaRelayConfiguration *)roomMediaRelayConfiguration;
【功能说明】
删除单个跨房。
【请求参数】
roomMediaRelayConfiguration:跨房信息,具体请参见HRTCMultiRoomMediaRelayConfiguration。
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HRTCErrorCode。
stopMultiRoomMediaRelay
- (int)stopMultiRoomMediaRelay;
【功能说明】
停止所有跨房。
【请求参数】
- 0:方法调用成功。
- > 0:方法调用失败。具体请参见HRTCErrorCode。