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