cn.tee3.avd_SDK-C++
2.1.0
|
房间接口类 更多...
类 | |
class | IListener |
房间回调接口类 更多... | |
Public 类型 | |
typedef void(* | FuncJoinResult) (const RoomId &roomId, Result result) |
加入房间回调接口 更多... | |
Public 成员函数 | |
virtual void | release ()=0 |
释放房间接口 更多... | |
virtual Result | setListener (IListener *listener)=0 |
设置房间回调接口 更多... | |
virtual Result | join (const User &user, const String &password, FuncJoinResult joinresult)=0 |
当前用户加入房间 更多... | |
virtual Result | leave (Result reason)=0 |
当前用户离开房间 更多... | |
virtual Result | close ()=0 |
关闭房间 更多... | |
virtual Result | reJoin ()=0 |
重新加入当前房间 更多... | |
virtual Result | reConnect ()=0 |
重置房间中网络连接 更多... | |
virtual Result | kickoutUser (Result reason, const UserId &userId)=0 |
房间中踢出用户 更多... | |
virtual Result | updateRoomStatus (RoomStatus status)=0 |
更新房间状态 更多... | |
virtual RoomStatus | getRoomStatus () const =0 |
获取房间状态 更多... | |
virtual const RoomId & | getRoomId () const =0 |
获取房间Id 更多... | |
virtual const String & | getAppRoomId () const =0 |
获取房间应用层Id 更多... | |
virtual const String & | getRoomName () const =0 |
获取房间名 更多... | |
virtual const String & | getRoomTopic () const =0 |
获取房间主题 更多... | |
virtual const RoomInfo & | getRoomInfo () const =0 |
获取房间信息 更多... | |
virtual Result | sendPublicData (const char *data, uint32 len)=0 |
透明通道,发送广播数据 更多... | |
virtual Result | sendPrivateData (const char *data, uint32 len, const UserId &toId)=0 |
透明通道,发送私有数据 更多... | |
virtual String | getAppData (const String &key) const =0 |
返回应用层的房间数据 更多... | |
virtual Result | updateAppData (const String &key, const String &value)=0 |
修改应用层的房间数据 更多... | |
virtual DeviceId | createFakeDeviceID (const DeviceId &fakeId)=0 |
创建模拟设备Id,在导入音视频时可用 更多... | |
virtual bool | isWorking () const =0 |
virtual Result | join (const User &user, const String &password, FuncJoinResult joinresult, const String &roomToken)=0 |
当前用户加入房间 更多... | |
virtual Result | enableStats (bool isEnable)=0 |
当前房间启用或关闭流量统计功能 更多... | |
virtual const RoomStats & | getRoomStats () const =0 |
获取房间的流量统计信息 更多... | |
virtual const MediaStats & | getMediaStats (const DeviceId &deviceId) const =0 |
获取某路媒体(音频或者视频)的流量统计信息 更多... | |
virtual const MediaStats & | getAudioStats ()=0 |
virtual Result | setOption (RoomOption type, void *value)=0 |
设置房间选项 更多... | |
virtual Result | setOption (RoomOption type, const String &value)=0 |
virtual Result | getOption (RoomOption type, void *value)=0 |
获取房间选项 更多... | |
virtual String | getOption (RoomOption type)=0 |
静态 Public 成员函数 | |
static IRoom * | obtain (const RoomId &roomId) |
获取或创建房间接口 更多... | |
static IRoom * | obtain (const RoomId &roomId, const UserId &userId) |
获取或创建房间接口 更多... | |
Protected 成员函数 | |
virtual | ~IRoom () |
房间接口类
房间接口定义了房间对象创建和释放、房间功能操作。
|
protectedvirtual |
|
pure virtual |
关闭房间
创建模拟设备Id,在导入音视频时可用
[in] | fakeId | 自定义Id。 |
|
pure virtual |
当前房间启用或关闭流量统计功能
[in] | isEnable | 启用或关闭。 |
返回应用层的房间数据
[in] | key | 房间数据关键字。 |
|
pure virtual |
获取房间应用层Id
|
pure virtual |
|
pure virtual |
|
pure virtual |
获取房间选项
[in] | type | 房间选项类型。 |
[out] | *value | 房间选项返回值指针。 |
|
pure virtual |
|
pure virtual |
获取房间Id
|
pure virtual |
|
pure virtual |
获取房间名
|
pure virtual |
|
pure virtual |
|
pure virtual |
获取房间主题
|
pure virtual |
|
pure virtual |
当前用户加入房间
[in,out] | user | 用户信息:用户Id(不能包含'{'、'}'字符),用户名,用户数据等;当应用层不传入user.userId时,SDK将创建一个新的guid作为user.userId,同时返回给应用层。 |
[in] | password | 密码:如果是主持人请用主持人密码;如果是其他参会者,请用房间密码。 |
[in] | joinresult | 加房间回调接口。 |
|
pure virtual |
当前用户加入房间
[in,out] | user | 用户信息:用户Id(不能包含'{'、'}'字符),用户名,用户数据等;当应用层不传入user.userId时,SDK将创建一个新的guid作为user.userId,同时返回给应用层。 |
[in] | password | 密码:如果是主持人请用主持人密码;如果是其他参会者,请用房间密码。 |
[in] | joinresult | 加房间回调接口。 |
[in] | roomToken | 房间token。 |
房间中踢出用户
[in] | reason | 踢出用户的理由代码。 |
[in] | userId | 被踢出用户Id。 |
当前用户离开房间
[in] | reason | 用户离开房间的原因代码,正常离开为AVD_OK。 |
获取或创建房间接口
[in] | roomId | 房间Id。 |
获取或创建房间接口
[in] | roomId | 房间Id。 |
[in] | userId | 用户Id。 |
|
pure virtual |
重置房间中网络连接
|
pure virtual |
重新加入当前房间
|
pure virtual |
释放房间接口
|
pure virtual |
透明通道,发送私有数据
[in] | *data | 发送的数据指针。 |
[in] | len | 发送的数据长度。 |
[in] | toId | 目的用户Id。 |
透明通道,发送广播数据
[in] | *data | 发送的数据指针。 |
[in] | len | 发送的数据长度。 |
|
pure virtual |
设置房间选项
[in] | type | 房间选项类型。 |
[in] | *value | 房间选项值指针。 |
|
pure virtual |
|
pure virtual |
修改应用层的房间数据
[in] | key | 房间数据关键字。 |
[in] | value | 房间数据对应关键字的信息内容 |
|
pure virtual |