cn.tee3.avd_SDK-C++
2.1.0
|
AVD引擎接口类 更多...
类 | |
class | IListener |
AVD引擎回调接口类 更多... | |
Public 类型 | |
typedef void(* | FuncGetRoomResult) (uint32 callId, Result result, const RoomInfo &room) |
typedef void(* | FuncScheduleRoomResult) (uint32 callId, Result result, const RoomId &roomId) |
Public 成员函数 | |
virtual void | release ()=0 |
释放AVD引擎对象 更多... | |
virtual Result | init (IListener *listener, const String &severuri, const String &appkey, const String &secretkey)=0 |
初始化引擎 更多... | |
virtual Result | init (IAVDEngine::IListener *listener, const String &severuri, const String &token)=0 |
初始化引擎 更多... | |
virtual Result | initWithOEM (IListener *listener, const String &severuri, const String &oemName)=0 |
初始化引擎 更多... | |
virtual Result | uninit ()=0 |
反初始化引擎 更多... | |
virtual bool | isWorking () const =0 |
判断引擎是否正常工作 更多... | |
virtual Result | getRoomByRoomId (uint32 &callId, const String &roomId)=0 |
根据房间Id获取房间信息 更多... | |
virtual Result | getRoomByRoomId (uint32 &callId, const String &roomId, FuncGetRoomResult func)=0 |
virtual Result | getRoomByAppRoomId (uint32 &callId, const String &appRoomId)=0 |
根据应用层房间Id获取房间信息 更多... | |
virtual Result | getRoomByAppRoomId (uint32 &callId, const String &appRoomId, FuncGetRoomResult func)=0 |
virtual Result | findRooms (uint32 &callId, const String &filter)=0 |
查找房间信息 更多... | |
virtual Result | scheduleRoom (uint32 &callId, const RoomInfo &roomInfo)=0 |
安排房间 更多... | |
virtual Result | scheduleRoom (uint32 &callId, const RoomInfo &roomInfo, FuncScheduleRoomResult func)=0 |
virtual Result | cancelRoom (uint32 &callId, const RoomId &roomId)=0 |
删除房间 更多... | |
virtual Result | getUsersCount (uint32 &callId, const RoomId &roomId)=0 |
根据房间号获取房间人数 更多... | |
virtual bool | hasFunction (FunctionType ft) const =0 |
判断是否拥有功能 更多... | |
virtual uint32 | getFunctions () const =0 |
获取功能集 更多... | |
virtual Result | setOption (EngineOption type, void *value)=0 |
设置引擎选项 更多... | |
virtual Result | setOption (EngineOption type, const String &value)=0 |
virtual Result | getOption (EngineOption type, void *value)=0 |
获取引擎选项 更多... | |
virtual String | getOption (EngineOption type)=0 |
virtual Result | setUserInfo (const User &info)=0 |
设置全局用户信息 更多... | |
virtual const User & | getUserInfo () const =0 |
获取全局用户信息 更多... | |
virtual const String & | getTempDir () const =0 |
静态 Public 成员函数 | |
static IAVDEngine * | Instance () |
获取AVD引擎对象 更多... | |
static Result | setLogParams (const String ¶ms, const String &filename) |
设置引擎日志配置 更多... | |
static Result | uploadLogFile (const String &rooturl) |
上传当前日志文件 更多... | |
static String | getVersion () |
获取引擎版本号 更多... | |
static String | getErrorMessage (Result code) |
根据错误代码获取关联的错误信息描述 更多... | |
Protected 成员函数 | |
virtual | ~IAVDEngine () |
AVD引擎接口类
AVD引擎接口定义了引擎全局初始化操作和房间安排、查询、删除等操作。
typedef void(* tee3::avd::IAVDEngine::FuncGetRoomResult) (uint32 callId, Result result, const RoomInfo &room) |
typedef void(* tee3::avd::IAVDEngine::FuncScheduleRoomResult) (uint32 callId, Result result, const RoomId &roomId) |
|
protectedvirtual |
|
pure virtual |
删除房间
[in,out] | callId | 调用Id,用于区别多次调用,在回调中会带上此调用Id,便于应用层区别每次调用;若调用时为0,内部产生一个序号。 |
[in] | roomId | 房间Id。 |
|
pure virtual |
查找房间信息
[in,out] | callId | 调用Id,用于区别多次调用,在回调中会带上此调用Id,便于应用层区别每次调用;若调用时为0,内部产生一个序号。 |
[in] | filter | 查找条件:json字符串,用房间信息结构中的字段“fieldname=value,...”来表示。 |
根据错误代码获取关联的错误信息描述
[in] | code | 错误代码。 |
|
pure virtual |
|
pure virtual |
获取引擎选项
[in] | type | 引擎选项类型。 |
[out] | *value | 引擎选项返回值指针。 |
|
pure virtual |
|
pure virtual |
根据应用层房间Id获取房间信息
[in,out] | callId | 调用Id,用于区别多次调用,在回调中会带上此调用Id,便于应用层区别每次调用;若调用时为0,内部产生一个序号。 |
[in] | appRoomId | 应用层房间Id。 |
|
pure virtual |
|
pure virtual |
根据房间Id获取房间信息
[in,out] | callId | 调用Id,用于区别多次调用,在回调中会带上此调用Id,便于应用层区别每次调用;若调用时为0,内部产生一个序号。 |
[in] | roomId | 房间Id。 |
|
pure virtual |
|
pure virtual |
|
pure virtual |
获取全局用户信息
|
pure virtual |
根据房间号获取房间人数
[in,out] | callId | 调用Id,用于区别多次调用,在回调中会带上此调用Id,便于应用层区别每次调用;若调用时为0,内部产生一个序号。 |
[in] | roomId | 房间Id。 |
|
static |
获取引擎版本号
|
pure virtual |
判断是否拥有功能
[in] | ft | 功能枚举。 |
|
pure virtual |
初始化引擎
[in] | *listener | 引擎回调指针。 |
[in] | severuri | 服务器uri。 |
[in] | appkey | 叁体公司分发给应用公司的应用秘钥。 |
[in] | secretkey | 叁体公司分发给应用公司的安全秘钥。 |
|
pure virtual |
初始化引擎
[in] | *listener | 引擎回调指针。 |
[in] | severuri | 服务器uri。 |
[in] | token | 认证后的凭证。 |
|
pure virtual |
初始化引擎
[in] | *listener | 引擎回调指针。 |
[in] | severuri | 服务器uri。 |
[in] | oemName | 叁体公司Open-AVD产品OEM的厂家名称。 |
|
static |
获取AVD引擎对象
|
pure virtual |
判断引擎是否正常工作
|
pure virtual |
释放AVD引擎对象
|
pure virtual |
安排房间
[in,out] | callId | 调用Id,用于区别多次调用,在回调中会带上此调用Id,便于应用层区别每次调用;若调用时为0,内部产生一个序号。 |
[in] | roomInfo | 房间信息。 |
|
pure virtual |
|
static |
设置引擎日志配置
[in] | params | 日志等级[sensitive verbose info warning error none ],以上只可取一个值;[debug]是否在调试输出;两个值时中间空格分隔。 |
[in] | filename | 日志文件名,若无日志文件名,则不写文件。 |
|
pure virtual |
设置引擎选项
[in] | type | 引擎选项类型。 |
[in] | *value | 引擎选项值指针。 |
|
pure virtual |
设置全局用户信息
[in] | info | 用户信息。 |
|
pure virtual |
反初始化引擎
上传当前日志文件
[in] | rooturl | url路径。 |