房间功能

joinRoom

virtual int joinRoom(const HRTCJoinParam &joinParam)

【功能说明】

加入房间。该方法让用户加入通话房间。

【请求参数】

joinParam：加入房间信息。具体请参见HRTCJoinParam。

【返回参数】

• 0：方法调用成功。
• >0：方法调用失败。具体请参见HRTCErrorCode。

会触发以下回调：

• onConnectStateChange：连接状态发送改变。
• onJoinRoomSuccess：加入房间成功。
• onJoinRoomFailure：加入房间失败。
• onRemoteUserOnline：远端用户收到当前用户加入房间的通知。

音频的自动订阅策略设置只在音频订阅模式下生效。

leaveRoom

virtual int leaveRoom()

【功能说明】

离开房间。

【返回参数】

• 0：方法调用成功。
• > 0：方法调用失败。具体请参见HRTCErrorCode。

【注意事项】

renewAuthorization

virtual int renewAuthorization(const char* signature, long long ctime)

【功能说明】

鉴权签名过期，收到onAuthorizationExpired签名鉴权过期回调后，更新鉴权签名。

【请求参数】

• signature：鉴权签名字符串。
• ctime：过期时间。

【返回参数】

• 0：方法调用成功。
• > 0：方法调用失败。具体请参见HRTCErrorCode。

changeUserRole

virtual int changeUserRole(HRTCRoleType role, const char *authorization, long long ctime)

【功能说明】

设置用户在当前房间内的角色类型，角色切换时使用。

【请求参数】

• role：用户角色类型，joiner类型和player类型，具体请参见HRTCRoleType。
• authorization：预留参数，填null或者空字符串。
• ctime：预留参数，填0。

【返回参数】

• 0：方法调用成功。
• > 0：方法调用失败。具体请参见HRTCErrorCode。

• 加入房间前，可以通过joinRoom的joinParam参数确认角色信息。
• 加入指定房间后才可以在指定房间内进行角色切换，当前仅支持joiner和player角色切换。跨房场景下，通过对应connection连接下的changeUserRole接口实现在跨入房间中的角色类型切换。
• 切换成功触发onUserRoleChangedNotify回调。切换失败会触发onError回调，返回HRTC_ERR_CODE_USER_ROLE_CHANGE_FAIL错误码。
• 同一时间不同房间最多只能有一个joiner，player切换joiner的时候，需要将其他房间的joiner先切换成player。
• 不支持缺省用户昵称入会。

changeUserName

virtual int changeUserName(const char* userName)

【功能说明】

房间内设置用户自己的昵称。

【请求参数】

userName：变更的昵称。

createConnection

virtual IHRTCConnection* createConnection(const char* roomId, IHRTCConnectionEventHandler* eventHandler) = 0)

【功能说明】

通过此接口可以创建一个与房间关联的IHRTCConnection连接对象，可多次调用以创建多个IHRTCConnection连接对象。调用每个连接对象中的joinRoom方法等接口，可以实现同时加入到多个房间，完成订阅和选看多个连接房间中的用户等功能。具体请参见IHRTCConnection和事件回调（IHRTCConnectionEventHandler）目录下的有关接口和回调。

【请求参数】

• roomId：房间ID。
• eventHandler：IHRTCConnectionEventHandler，引擎回调句柄，指定一个回调事件。SDK通过指定的事件通知应用程序的运行事件，如加入或离开房间等。具体请参见5.3.4-事件回调（IHRTCConnectionEventHandler）。

【返回参数】

IHRTCConnection：成功返回连接对象指针，失败返回内容为空。

同一时间最多只能创建4个连接对象，每个连接对象对应的房间ID必须互不相同。加上IHRTCEngine对象，即同时最多可加入5个房间，且在这5个房间中最多只能同时有一个joiner角色，其他只能为player角色。如果使用IHRTCEngine对象加入房间，则加入房间的房间ID不能和已创建连接对象对应的房间ID相同。

addMultiRoomMediaRelay

virtual int addMultiRoomMediaRelay(HRTCMultiRoomMediaRelayConfiguration roomMediaRelayConfiguration)

【功能说明】

添加单个跨房。发起跨房后由云侧单向将本端上行流推至目标房间，即只推流不收流。

【请求参数】

roomMediaRelayConfiguration：跨房信息，具体请参见HRTCMultiRoomMediaRelayConfiguration。

removeMultiRoomMediaRelay

virtual int removeMultiRoomMediaRelay(HRTCMultiRoomMediaRelayConfiguration roomMediaRelayConfiguration)

【功能说明】

删除单个跨房。

【请求参数】

roomMediaRelayConfiguration：跨房信息，具体请参见HRTCMultiRoomMediaRelayConfiguration。

stopMultiRoomMediaRelay

virtual int stopMultiRoomMediaRelay()

【功能说明】

停止所有跨房。

【请求参数】