AVDEngine

Superclass:
NSObject
Declared In:

Introduction

AVD引擎接口类

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



Methods

-cancelRoom:
+destory
-findRooms:
+getErrorMessage:
-getOption:
-getRoomByAppRoomId:
-getRoomByRoomId:
-getUserInfo
-getUsersCount:
+getVersion
-initWithServerUrl:accessKey:secretKey:delegate:
-initWithServerUrl:OEM:delegate:
-initWithServerUrl:token:delegate:
+instance
-isWorking
-scheduleRoom:
-setLogParams:file:
-setOption:value:
-setUserInfo:
-uninit

cancelRoom:


- (AVDResult) cancelRoom:(AVDRoomId)roomId; 
Return Value

返回错误代码。

Discussion

取消删除房间

@param[in] roomId 房间Id。

取消房间为异步操作,调用此接口后等待回调中函数onCancelRoomResult回调,判断是否取消成功。:


destory


+ (AVDResult) destory; 
Discussion

释放AVD引擎对象


findRooms:


- (AVDResult) findRooms:(NSString*)filter; 
Return Value

返回错误代码。

Discussion

查找房间信息

@param[in] *filter 查找条件:json字符串,用房间信息结构中的字段“fieldname=value,...”来表示。

查找房间信息为异步操作,调用此接口后等待回调中函数onFindRoomsResult回调,判断是否查找成功。:


getErrorMessage:


+ (NSString*) getErrorMessage:(AVDResult)code; 
Return Value

返回错误信息描述。

Discussion

根据错误代码获取关联的错误信息描述 @param[in] code 错误代码。


getOption:


- (NSString*) getOption:(enum AVDEngineOption)type; 
Return Value

返回引擎选项返回值指针。

Discussion

获取引擎选项

@param[in] type 引擎选项类型。


getRoomByAppRoomId:


- (AVDResult) getRoomByAppRoomId:(NSString*)appRoomId; 
Return Value

返回错误代码。

Discussion

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

@param[in] appRoomId 应用层房间Id。

获取房间信息为异步操作,调用此接口后等待回调中函数onGetRoomResult回调,判断是否获取成功。:


getRoomByRoomId:


- (AVDResult) getRoomByRoomId:(AVDRoomId)roomId; 
Return Value

返回错误代码。

Discussion

根据房间Id获取房间信息

@param[in] roomId 房间Id。

获取房间信息为异步操作,调用此接口后等待回调中函数onGetRoomResult回调,判断是否获取成功。:


getUserInfo


- (AVDUser*) getUserInfo; 
Return Value

返回用户信息。

Discussion

获取全局用户信息


getUsersCount:


- (AVDResult) getUsersCount:(AVDRoomId)roomId; 
Return Value

返回错误代码。

Discussion

根据房间号获取房间人数

@param[out] callId 调用Id,用于区别多次调用,在回调中会带上此调用Id,便于应用层区别每次调用。 @param[in] roomId 房间Id。

获取房间人数为异步操作,调用此接口后等待回调中函数onGetUsersCountResult回调,判断是否取消成功。:


getVersion


+ (NSString*) getVersion; 
Return Value

返回引擎版本号。

Discussion

获取引擎版本号


initWithServerUrl:accessKey:secretKey:delegate:


- (AVDResult) initWithServerUrl:(NSString *)severuri 
        accessKey:(NSString *)appkey secretKey:(NSString *)secretkey 
        delegate:(id<AVDEngineDelegate>)delegate; 
Return Value

返回错误代码。

Discussion

初始化引擎

@param[in] *severuri 服务器uri, 取值格式为([]中内容可选):https://xxx.com[:443],http://xxx.cn[:80],xxx.cn[:8080](为http)。 @param[in] *appkey 叁体公司分发给应用公司的应用秘钥。 @param[in] *secretkey 叁体公司分发给应用公司的安全秘钥。 @param[in] delegate 引擎回调指针。

AVD引擎在做任何功能操作前,必须先要初始化引擎成功。引擎初始化是一个异步操作,调用此接口后等待回调中函数onInitResult回调,判断是否初始化成功。:


initWithServerUrl:OEM:delegate:


- (AVDResult) initWithServerUrl:(NSString *)severuri OEM:(NSString *)oemName 
        delegate:(id<AVDEngineDelegate>)delegate; 
Return Value

返回错误代码。

Discussion

初始化引擎

@param[in] severuri 服务器uri, 取值格式为([]中内容可选):https://xxx.com[:443],http://xxx.cn[:80],xxx.cn[:8080](为http)。 @param[in] oemName 叁体公司Open-AVD产品OEM的厂家名称。 @param[in] delegate 引擎回调指针。

AVD引擎在做任何功能操作前,必须先要初始化引擎成功。引擎初始化是一个异步操作,调用此接口后等待回调中函数onInitResult回调,判断是否初始化成功。:


initWithServerUrl:token:delegate:


- (AVDResult) initWithServerUrl:(NSString *)severuri token:(NSString *)token 
        delegate:(id<AVDEngineDelegate>)delegate; 
Return Value

返回错误代码。

Discussion

初始化引擎

@param[in] *severuri 服务器uri, 取值格式为([]中内容可选):https://xxx.com[:443],http://xxx.cn[:80],xxx.cn[:8080](为http)。 @param[in] *token 根据叁体公司提供的算法计算出来的token。 @param[in] delegate 引擎回调指针。


instance


+ (AVDEngine*) instance; 
Return Value

返回AVD引擎指针。

Discussion

获取AVD引擎对象

AVD引擎是一个单例对象,一个进程空间只存在一个引擎。:


isWorking


- (BOOL) isWorking; 
Return Value

返回引擎是否正常工作。

Discussion

判断引擎是否正常工作


scheduleRoom:


- (AVDResult) scheduleRoom:(AVDRoomInfo*)roomInfo; 
Return Value

返回错误代码。

Discussion

安排房间

@param[in] *roomInfo 房间信息。

安排房间为异步操作,调用此接口后等待回调中函数onScheduleRoomResult回调,判断是否安排成功。:


setLogParams:file:


- (AVDResult) setLogParams:(NSString *)params file:(NSString *)filename; 
Return Value

返回错误代码。

Discussion

设置引擎日志配置

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


setOption:value:


- (AVDResult) setOption:(enum AVDEngineOption)type value:(NSString*)value; 
Return Value

返回错误代码。

Discussion

设置引擎选项

@param[in] type 引擎选项类型。 @param[in] *value 引擎选项值指针。


setUserInfo:


- (AVDResult) setUserInfo:(AVDUser*) info; 
Return Value

返回错误代码。

全局用户信息设置后,所有房间或直播房间加入都使用此用户信息:

Discussion

设置全局用户信息

@param[in] info 用户信息。


uninit


- (AVDResult) uninit; 
Return Value

返回错误代码。

Discussion

反初始化引擎

AVD反初始化后,引擎中涉及的所有房间对象都无效,引擎上的功能函数都无法正常使用。: