更新时间:2024-07-02 GMT+08:00
分享

房间功能

joinRoom

- (int)joinRoom:(HWRtcJoinParam * _Nonnull)joinParam;

功能说明

加入房间。该方法让用户加入通话房间。如果已在通话中,用户必须调用leaveRoom退出当前通话,才能进入下一个房间。

请求参数

joinParam:用户信息,具体请参见HWRtcJoinParam

返回参数
  • 0:方法调用成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode
会触发以下回调:

changeUserRole

- (int)changeUserRole:(HWRtcRole)role signature:(NSString *)authorization ctime:(long long)ctime;

功能说明

设置用户在本房间内/指定房间的角色,角色切换时使用。

请求参数

  • role:用户角色,具体请参见HWRtcRole
  • authorization:鉴权信息,当填写null时,则切换角色不鉴权,同时会忽略ctime值。
  • ctime:生成鉴权时使用的时间戳,必须匹配对应。

返回参数

  • 0:方法调用成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode
  • 加入房间后才可以切换角色,当前仅支持joiner和player角色切换。
  • 切换成功触发onUserRoleChange回调。切换失败会触发onError回调,错误码HWRtcErrorCode:HWRtcErrorCodeUserRoleChangeFail。
  • 同一时间不同房间最多只能有一个joiner,player切换joiner的时候,需要将joiner先切换成player,再将当前用户切换成joiner。

changeUserName

- (int)changeUserName:(NSString*)userName;

功能说明

修改用户昵称。

请求参数

userName:用户新的昵称。

返回参数
  • 0:方法调用成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode
  • 该接口仅支持房间内调用,更改的昵称会被实时同步到房间内其他用户的用户列表,退出房间不会保存,再次加入房间变更为加入房间时设置的昵称(参考joinRoom接口注意事项)。
  • 会触发用户名变更通知的回调onUserNameChangedNotify。

getRoomId

- (NSString *)getRoomId;

功能说明

获取当前房间的roomId。

请求参数

返回参数
  • 0:方法调用成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

disableRejoinRoom

- (int)disableRejoinRoom:(BOOL)disable;

功能说明

禁止自动重入房间。

请求参数

disable:使能开关。

返回参数
  • 0:方法调用成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

leaveRoom

- (int)leaveRoom;

功能说明

离开房间。

请求参数

返回参数
  • 0:方法调用成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

相关文档