cn.tee3.avd_SDK-C++  2.1.0
| Public 类型 | Public 成员函数 | 静态 Public 成员函数 | Protected 成员函数 | 所有成员列表
tee3::avd::IAVDEngine类 参考abstract

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 UsergetUserInfo () const =0
 获取全局用户信息 更多...
 
virtual const StringgetTempDir () const =0
 

静态 Public 成员函数

static IAVDEngineInstance ()
 获取AVD引擎对象 更多...
 
static Result setLogParams (const String &params, const String &filename)
 设置引擎日志配置 更多...
 
static Result uploadLogFile (const String &rooturl)
 上传当前日志文件 更多...
 
static String getVersion ()
 获取引擎版本号 更多...
 
static String getErrorMessage (Result code)
 根据错误代码获取关联的错误信息描述 更多...
 

Protected 成员函数

virtual ~IAVDEngine ()
 

详细描述

AVD引擎接口类

AVD引擎接口定义了引擎全局初始化操作和房间安排、查询、删除等操作。

成员类型定义说明

◆ FuncGetRoomResult

typedef void(* tee3::avd::IAVDEngine::FuncGetRoomResult) (uint32 callId, Result result, const RoomInfo &room)

◆ FuncScheduleRoomResult

typedef void(* tee3::avd::IAVDEngine::FuncScheduleRoomResult) (uint32 callId, Result result, const RoomId &roomId)

构造及析构函数说明

◆ ~IAVDEngine()

virtual tee3::avd::IAVDEngine::~IAVDEngine ( )
protectedvirtual

成员函数说明

◆ cancelRoom()

virtual Result tee3::avd::IAVDEngine::cancelRoom ( uint32 callId,
const RoomId roomId 
)
pure virtual

删除房间

参数
[in,out]callId调用Id,用于区别多次调用,在回调中会带上此调用Id,便于应用层区别每次调用;若调用时为0,内部产生一个序号。
[in]roomId房间Id。
注解
删除房间为异步操作,调用此接口后等待回调中函数onCancelRoomResult回调,判断是否取消成功。
返回
返回错误代码。

◆ findRooms()

virtual Result tee3::avd::IAVDEngine::findRooms ( uint32 callId,
const String filter 
)
pure virtual

查找房间信息

参数
[in,out]callId调用Id,用于区别多次调用,在回调中会带上此调用Id,便于应用层区别每次调用;若调用时为0,内部产生一个序号。
[in]filter查找条件:json字符串,用房间信息结构中的字段“fieldname=value,...”来表示。
注解
查找房间信息为异步操作,调用此接口后等待回调中函数onFindRoomsResult回调,判断是否查找成功。
返回
返回错误代码。

◆ getErrorMessage()

static String tee3::avd::IAVDEngine::getErrorMessage ( Result  code)
static

根据错误代码获取关联的错误信息描述

参数
[in]code错误代码。
返回
返回错误信息描述。

◆ getFunctions()

virtual uint32 tee3::avd::IAVDEngine::getFunctions ( ) const
pure virtual

获取功能集

返回
返回功能集。
参见
FunctionType

◆ getOption() [1/2]

virtual Result tee3::avd::IAVDEngine::getOption ( EngineOption  type,
void *  value 
)
pure virtual

获取引擎选项

参数
[in]type引擎选项类型。
[out]*value引擎选项返回值指针。
返回
返回错误代码。

◆ getOption() [2/2]

virtual String tee3::avd::IAVDEngine::getOption ( EngineOption  type)
pure virtual

◆ getRoomByAppRoomId() [1/2]

virtual Result tee3::avd::IAVDEngine::getRoomByAppRoomId ( uint32 callId,
const String appRoomId 
)
pure virtual

根据应用层房间Id获取房间信息

参数
[in,out]callId调用Id,用于区别多次调用,在回调中会带上此调用Id,便于应用层区别每次调用;若调用时为0,内部产生一个序号。
[in]appRoomId应用层房间Id。
注解
获取房间信息为异步操作,调用此接口后等待回调中函数onGetRoomResult回调,判断是否获取成功。
返回
返回错误代码。

◆ getRoomByAppRoomId() [2/2]

virtual Result tee3::avd::IAVDEngine::getRoomByAppRoomId ( uint32 callId,
const String appRoomId,
FuncGetRoomResult  func 
)
pure virtual

◆ getRoomByRoomId() [1/2]

virtual Result tee3::avd::IAVDEngine::getRoomByRoomId ( uint32 callId,
const String roomId 
)
pure virtual

根据房间Id获取房间信息

参数
[in,out]callId调用Id,用于区别多次调用,在回调中会带上此调用Id,便于应用层区别每次调用;若调用时为0,内部产生一个序号。
[in]roomId房间Id。
注解
获取房间信息为异步操作,调用此接口后等待回调中函数onGetRoomResult回调,判断是否获取成功。
返回
返回错误代码。

◆ getRoomByRoomId() [2/2]

virtual Result tee3::avd::IAVDEngine::getRoomByRoomId ( uint32 callId,
const String roomId,
FuncGetRoomResult  func 
)
pure virtual

◆ getTempDir()

virtual const String& tee3::avd::IAVDEngine::getTempDir ( ) const
pure virtual

◆ getUserInfo()

virtual const User& tee3::avd::IAVDEngine::getUserInfo ( ) const
pure virtual

获取全局用户信息

返回
返回用户信息。

◆ getUsersCount()

virtual Result tee3::avd::IAVDEngine::getUsersCount ( uint32 callId,
const RoomId roomId 
)
pure virtual

根据房间号获取房间人数

参数
[in,out]callId调用Id,用于区别多次调用,在回调中会带上此调用Id,便于应用层区别每次调用;若调用时为0,内部产生一个序号。
[in]roomId房间Id。
注解
获取房间人数为异步操作,调用此接口后等待回调中函数onGetUsersCountResult回调,判断是否取消成功。
返回
返回错误代码。

◆ getVersion()

static String tee3::avd::IAVDEngine::getVersion ( )
static

获取引擎版本号

返回
返回引擎版本号。

◆ hasFunction()

virtual bool tee3::avd::IAVDEngine::hasFunction ( FunctionType  ft) const
pure virtual

判断是否拥有功能

参数
[in]ft功能枚举。
返回
返回是否拥有。

◆ init() [1/2]

virtual Result tee3::avd::IAVDEngine::init ( IListener listener,
const String severuri,
const String appkey,
const String secretkey 
)
pure virtual

初始化引擎

参数
[in]*listener引擎回调指针。
[in]severuri服务器uri。
[in]appkey叁体公司分发给应用公司的应用秘钥。
[in]secretkey叁体公司分发给应用公司的安全秘钥。
注解
AVD引擎在做任何功能操作前,必须先要初始化引擎成功。引擎初始化是一个异步操作,调用此接口后等待回调中函数onInitResult回调,判断是否初始化成功。
返回
返回错误代码。

◆ init() [2/2]

virtual Result tee3::avd::IAVDEngine::init ( IAVDEngine::IListener listener,
const String severuri,
const String token 
)
pure virtual

初始化引擎

参数
[in]*listener引擎回调指针。
[in]severuri服务器uri。
[in]token认证后的凭证。
注解
AVD引擎在做任何功能操作前,必须先要初始化引擎成功。引擎初始化是一个异步操作,调用此接口后等待回调中函数onInitResult回调,判断是否初始化成功。
返回
返回错误代码。

◆ initWithOEM()

virtual Result tee3::avd::IAVDEngine::initWithOEM ( IListener listener,
const String severuri,
const String oemName 
)
pure virtual

初始化引擎

参数
[in]*listener引擎回调指针。
[in]severuri服务器uri。
[in]oemName叁体公司Open-AVD产品OEM的厂家名称。
注解
AVD引擎在做任何功能操作前,必须先要初始化引擎成功。引擎初始化是一个异步操作,调用此接口后等待回调中函数onInitResult回调,判断是否初始化成功。
返回
返回错误代码。

◆ Instance()

static IAVDEngine* tee3::avd::IAVDEngine::Instance ( )
static

获取AVD引擎对象

注解
AVD引擎是一个单例对象,一个进程空间只存在一个引擎。
返回
返回AVD引擎。

◆ isWorking()

virtual bool tee3::avd::IAVDEngine::isWorking ( ) const
pure virtual

判断引擎是否正常工作

返回
返回引擎是否正常工作。

◆ release()

virtual void tee3::avd::IAVDEngine::release ( )
pure virtual

释放AVD引擎对象

◆ scheduleRoom() [1/2]

virtual Result tee3::avd::IAVDEngine::scheduleRoom ( uint32 callId,
const RoomInfo roomInfo 
)
pure virtual

安排房间

参数
[in,out]callId调用Id,用于区别多次调用,在回调中会带上此调用Id,便于应用层区别每次调用;若调用时为0,内部产生一个序号。
[in]roomInfo房间信息。
注解
安排房间为异步操作,调用此接口后等待回调中函数onScheduleRoomResult回调,判断是否安排成功。 RoomInfo 中 room.roomName = "xxx"; //房间名称,一般需要填写。 room.appRoomId = "xxxxxx"; //房间应用层Id,应用层创建房间时设置,应用层可用于标示房间; 必须填写,而且要确保唯一。 room.maxAttendee = 5; //房间最大用户数限制, 根据实际需要填写。 room.maxAudio = 3; //房间最大音频数限制, 根据实际需要填写。 room.maxVideo = 2; //房间最大视频数限制, 根据实际需要填写。 room.setRoomMode(tee3::avd::rm_mcu); //房间模式,设置为mcu模式 以上参数必须要填写, 其他参数可以根据情况做设置。
返回
返回错误代码。

◆ scheduleRoom() [2/2]

virtual Result tee3::avd::IAVDEngine::scheduleRoom ( uint32 callId,
const RoomInfo roomInfo,
FuncScheduleRoomResult  func 
)
pure virtual

◆ setLogParams()

static Result tee3::avd::IAVDEngine::setLogParams ( const String params,
const String filename 
)
static

设置引擎日志配置

参数
[in]params日志等级[sensitive verbose info warning error none ],以上只可取一个值;[debug]是否在调试输出;两个值时中间空格分隔。
[in]filename日志文件名,若无日志文件名,则不写文件。
返回
返回错误代码。

◆ setOption() [1/2]

virtual Result tee3::avd::IAVDEngine::setOption ( EngineOption  type,
void *  value 
)
pure virtual

设置引擎选项

参数
[in]type引擎选项类型。
[in]*value引擎选项值指针。
返回
返回错误代码。

◆ setOption() [2/2]

virtual Result tee3::avd::IAVDEngine::setOption ( EngineOption  type,
const String value 
)
pure virtual

◆ setUserInfo()

virtual Result tee3::avd::IAVDEngine::setUserInfo ( const User info)
pure virtual

设置全局用户信息

参数
[in]info用户信息。
返回
返回错误代码。
注解
全局用户信息设置后,所有房间或直播房间加入都使用此用户信息

◆ uninit()

virtual Result tee3::avd::IAVDEngine::uninit ( )
pure virtual

反初始化引擎

注解
AVD反初始化后,引擎中涉及的所有房间对象都无效,引擎上的功能函数都无法正常使用。
返回
返回错误代码。

◆ uploadLogFile()

static Result tee3::avd::IAVDEngine::uploadLogFile ( const String rooturl)
static

上传当前日志文件

参数
[in]rooturlurl路径。
返回
返回错误代码。

该类的文档由以下文件生成: