# 房间功能
 #### joinRoom
```
virtual int joinRoom(const HRTCJoinParam &joinParam)
```
【**功能说明**】
加入房间。该方法让用户加入通话房间。
【**请求参数**】
joinParam：加入房间信息。具体请参见[HRTCJoinParam](https://support.huaweicloud.com/csdk-rtc/rtc_05_0128.html#rtc_05_0128__section11398133002711)。
【**返回参数**】
- 0：方法调用成功。
- \>0：方法调用失败。具体请参见[HRTCErrorCode](https://support.huaweicloud.com/csdk-rtc/rtc_05_0125.html)。
![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/caution_3.0-zh-cn.png)
会触发以下回调：
- [onConnectStateChange](https://support.huaweicloud.com/csdk-rtc/rtc_05_0107.html#rtc_05_0107__zh-cn_topic_0277015530_section1856441562814)：连接状态发送改变。
- [onJoinRoomSuccess](https://support.huaweicloud.com/csdk-rtc/rtc_05_0107.html#rtc_05_0107__zh-cn_topic_0277015530_section1319832102216)：加入房间成功。
- [onJoinRoomFailure](https://support.huaweicloud.com/csdk-rtc/rtc_05_0107.html#rtc_05_0107__zh-cn_topic_0277015530_section1184221016238)：加入房间失败。
- [onRemoteUserOnline](https://support.huaweicloud.com/csdk-rtc/rtc_05_0107.html#rtc_05_0107__zh-cn_topic_0277015530_section422052222412)：远端用户收到当前用户加入房间的通知。
音频的自动订阅策略设置只在音频订阅模式下生效。
 #### leaveRoom
```
virtual int leaveRoom()
```
【**功能说明**】
离开房间。
【**返回参数**】
- 0：方法调用成功。
- \> 0：方法调用失败。具体请参见[HRTCErrorCode](https://support.huaweicloud.com/csdk-rtc/rtc_05_0125.html)。
【**注意事项**】
![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/caution_3.0-zh-cn.png)
会触发以下回调：
- [onLeaveRoom](https://support.huaweicloud.com/csdk-rtc/rtc_05_0107.html#rtc_05_0107__zh-cn_topic_0277015530_section18952103711231)：离开房间回调。
- [onConnectStateChange](https://support.huaweicloud.com/csdk-rtc/rtc_05_0107.html#rtc_05_0107__zh-cn_topic_0277015530_section1856441562814)：连接状态改变回调。
- [onRemoteUserOffline](https://support.huaweicloud.com/csdk-rtc/rtc_05_0107.html#rtc_05_0107__zh-cn_topic_0277015530_section166775422416)：远端用户收到当前用户离开房间的通知。
 
 #### renewAuthorization
```
virtual int renewAuthorization(const char* signature, long long ctime)
```
【**功能说明**】
鉴权签名过期，收到[onAuthorizationExpired](https://support.huaweicloud.com/csdk-rtc/rtc_05_0107.html#rtc_05_0107__zh-cn_topic_0277015530_section9566994582)签名鉴权过期回调后，更新鉴权签名。
【**请求参数**】
- signature：鉴权签名字符串。
- ctime：过期时间。
【**返回参数**】
- 0：方法调用成功。
- \> 0：方法调用失败。具体请参见[HRTCErrorCode](https://support.huaweicloud.com/csdk-rtc/rtc_05_0125.html)。
 
 #### changeUserRole
```
virtual int changeUserRole(HRTCRoleType role, const char *authorization, long long ctime)
```
【**功能说明**】
设置用户在当前房间内的角色类型，角色切换时使用。
【**请求参数**】
- role：用户角色类型，joiner类型和player类型，具体请参见[HRTCRoleType](https://support.huaweicloud.com/csdk-rtc/rtc_05_0128.html#rtc_05_0128__zh-cn_topic_0277015533_section426214263183)。
- authorization：预留参数，填null或者空字符串。
- ctime：预留参数，填0。
【**返回参数**】
- 0：方法调用成功。
- \> 0：方法调用失败。具体请参见[HRTCErrorCode](https://support.huaweicloud.com/csdk-rtc/rtc_05_0125.html)。
![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/caution_3.0-zh-cn.png)
- 加入房间前，可以通过[joinRoom]的joinParam参数确认角色信息。
- 加入指定房间后才可以在指定房间内进行角色切换，当前仅支持joiner和player角色切换。跨房场景下，通过对应connection连接下的changeUserRole接口实现在跨入房间中的角色类型切换。
- 切换成功触发[onUserRoleChangedNotify](https://support.huaweicloud.com/csdk-rtc/rtc_05_0107.html#rtc_05_0107__zh-cn_topic_0277015530_section9263123615018)回调。切换失败会触发[onError](https://support.huaweicloud.com/csdk-rtc/rtc_05_0107.html#rtc_05_0107__zh-cn_topic_0277015530_section07911946101112)回调，返回HRTC_ERR_CODE_USER_ROLE_CHANGE_FAIL错误码。
- 同一时间不同房间最多只能有一个joiner，player切换joiner的时候，需要将其他房间的joiner先切换成player。
- 不支持缺省用户昵称入会。
 
 #### changeUserName
```
virtual int changeUserName(const char* userName)
```
【**功能说明**】
房间内设置用户自己的昵称。
【**请求参数**】
userName：变更的昵称。
【**返回参数** 】
- 0：方法调用成功。
- \> 0：方法调用失败。具体请参见[HRTCErrorCode](https://support.huaweicloud.com/csdk-rtc/rtc_05_0125.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_0107.html#rtc_05_0107__zh-cn_topic_0277015530_section81445822511)。
 
 #### createConnection
```
virtual IHRTCConnection* createConnection(const char* roomId, IHRTCConnectionEventHandler* eventHandler) = 0)
```
【**功能说明**】
通过此接口可以创建一个与房间关联的IHRTCConnection连接对象，可多次调用以创建多个IHRTCConnection连接对象。调用每个连接对象中的joinRoom方法等接口，可以实现同时加入到多个房间，完成订阅和选看多个连接房间中的用户等功能。具体请参见[IHRTCConnection](https://support.huaweicloud.com/csdk-rtc/rtc_05_0108.html)和[事件回调（IHRTCConnectionEventHandler）](https://support.huaweicloud.com/csdk-rtc/rtc_05_0115.html)目录下的有关接口和回调。
【**请求参数**】
- roomId：房间ID。
- eventHandler：IHRTCConnectionEventHandler，引擎回调句柄，指定一个回调事件。SDK通过指定的事件通知应用程序的运行事件，如加入或离开房间等。具体请参见[5.3.4-事件回调（IHRTCConnectionEventHandler）](https://support.huaweicloud.com/csdk-rtc/rtc_05_0115.html)。
【**返回参数**】
IHRTCConnection：成功返回连接对象指针，失败返回内容为空。
![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/caution_3.0-zh-cn.png)
同一时间最多只能创建4个连接对象，每个连接对象对应的房间ID必须互不相同。加上IHRTCEngine对象，即同时最多可加入5个房间，且在这5个房间中最多只能同时有一个joiner角色，其他只能为player角色。如果使用IHRTCEngine对象加入房间，则加入房间的房间ID不能和已创建连接对象对应的房间ID相同。
 #### addMultiRoomMediaRelay
```
virtual int addMultiRoomMediaRelay(HRTCMultiRoomMediaRelayConfiguration roomMediaRelayConfiguration)
```
【**功能说明**】
添加单个跨房。发起跨房后由云侧单向将本端上行流推至目标房间，即只推流不收流。
【**请求参数**】
roomMediaRelayConfiguration：跨房信息，具体请参见[HRTCMultiRoomMediaRelayConfiguration](https://support.huaweicloud.com/csdk-rtc/rtc_05_0128.html#rtc_05_0128__section12447152317212)。
【**返回参数** 】
- 0：方法调用成功。
- \> 0：方法调用失败。具体请参见[HRTCErrorCode](https://support.huaweicloud.com/csdk-rtc/rtc_05_0125.html)。
 
 #### removeMultiRoomMediaRelay
```
virtual int removeMultiRoomMediaRelay(HRTCMultiRoomMediaRelayConfiguration roomMediaRelayConfiguration)
```
【**功能说明**】
删除单个跨房。
【**请求参数**】
roomMediaRelayConfiguration：跨房信息，具体请参见[HRTCMultiRoomMediaRelayConfiguration](https://support.huaweicloud.com/csdk-rtc/rtc_05_0128.html#rtc_05_0128__section12447152317212)。
【**返回参数** 】
- 0：方法调用成功。
- \> 0：方法调用失败。具体请参见[HRTCErrorCode](https://support.huaweicloud.com/csdk-rtc/rtc_05_0125.html)。
 
 #### stopMultiRoomMediaRelay
```
virtual int stopMultiRoomMediaRelay()
```
【**功能说明**】
停止所有跨房。
【**请求参数**】
【**返回参数** 】
- 0：方法调用成功。
- \> 0：方法调用失败。具体请参见[HRTCErrorCode](https://support.huaweicloud.com/csdk-rtc/rtc_05_0125.html)。