cn.tee3.avd_SDK-Objectc  2.1.0
构造函数 | 类方法 | 属性 | 所有成员列表
AVDEngine类 参考

AVD引擎接口类 更多...

类 AVDEngine 继承关系图:

构造函数

(AVDResult) - initWithServerUrl:accessKey:secretKey:delegate:
 初始化引擎 更多...
 
(AVDResult) - initWithServerUrl:token:delegate:
 初始化引擎 更多...
 
(AVDResult) - initWithServerUrl:OEM:delegate:
 初始化引擎 更多...
 
(AVDResult) - uninit
 反初始化引擎 更多...
 
(BOOL) - isWorking
 判断引擎是否正常工作 更多...
 
(AVDResult) - getRoomByRoomId:
 根据房间Id获取房间信息 更多...
 
(AVDResult) - getRoomByAppRoomId:
 根据应用层房间Id获取房间信息 更多...
 
(AVDResult) - findRooms:
 查找房间信息 更多...
 
(AVDResult) - scheduleRoom:
 安排房间 更多...
 
(AVDResult) - cancelRoom:
 取消删除房间 更多...
 
(AVDResult) - getUsersCount:
 根据房间号获取房间人数 更多...
 
(AVDResult) - setLogParams:file:
 设置引擎日志配置 更多...
 
(AVDResult) - setOption:value:
 设置引擎选项 更多...
 
(NSString *) - getOption:
 获取引擎选项 更多...
 
(AVDResult) - setUserInfo:
 设置全局用户信息 更多...
 
(AVDUser *) - getUserInfo
 获取全局用户信息 更多...
 
((unavailable("init is not a supported initializer for this class.") - __attribute__
 

类方法

(AVDEngine *) + instance
 获取AVD引擎对象 更多...
 
(AVDResult) + destory
 释放AVD引擎对象 更多...
 
(NSString *) + getVersion
 获取引擎版本号 更多...
 
(NSString *) + getErrorMessage:
 根据错误代码获取关联的错误信息描述 更多...
 

属性

NSMutableArray * rooms
 
NSMutableArray * easyrooms
 

详细描述

AVD引擎接口类

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

函数文档

◆ __attribute__()

- (( unavailable("init is not a supported initializer for this class.") __attribute__

◆ cancelRoom:()

- (AVDResult) cancelRoom: (AVDRoomId)  roomId

取消删除房间

参数
[in]roomId房间Id。
注解
取消房间为异步操作，调用此接口后等待回调中函数onCancelRoomResult回调，判断是否取消成功。
返回
返回错误代码。

◆ destory()

+ (AVDResult) destory

释放AVD引擎对象

◆ findRooms:()

- (AVDResult) findRooms: (NSString *)  filter

查找房间信息

参数
[in]*filter查找条件：json字符串，用房间信息结构中的字段“fieldname=value,...”来表示。
注解
查找房间信息为异步操作，调用此接口后等待回调中函数onFindRoomsResult回调，判断是否查找成功。
返回
返回错误代码。

◆ getErrorMessage:()

+ (NSString*) getErrorMessage: (AVDResult)  code

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

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

◆ getOption:()

- (NSString*) getOption: (enum AVDEngineOption)  type

获取引擎选项

参数
[in]type引擎选项类型。
返回
返回引擎选项返回值指针。

◆ getRoomByAppRoomId:()

- (AVDResult) getRoomByAppRoomId: (NSString *)  appRoomId

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

参数
[in]appRoomId应用层房间Id。
注解
获取房间信息为异步操作，调用此接口后等待回调中函数onGetRoomResult回调，判断是否获取成功。
返回
返回错误代码。

◆ getRoomByRoomId:()

- (AVDResult) getRoomByRoomId: (AVDRoomId)  roomId

根据房间Id获取房间信息

参数
[in]roomId房间Id。
注解
获取房间信息为异步操作，调用此接口后等待回调中函数onGetRoomResult回调，判断是否获取成功。
返回
返回错误代码。

◆ getUserInfo()

- (AVDUser*) getUserInfo

获取全局用户信息

返回
返回用户信息。

◆ getUsersCount:()

- (AVDResult) getUsersCount: (AVDRoomId)  roomId

根据房间号获取房间人数

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

◆ getVersion()

+ (NSString*) getVersion

获取引擎版本号

返回
返回引擎版本号。

◆ initWithServerUrl:accessKey:secretKey:delegate:()

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

初始化引擎

参数
[in]*severuri服务器uri, 取值格式为([]中内容可选)：https://xxx.com[:443]，http://xxx.cn[:80]，xxx.cn[:8080](为http)。
[in]*appkey叁体公司分发给应用公司的应用秘钥。
[in]*secretkey叁体公司分发给应用公司的安全秘钥。
[in]delegate引擎回调指针。
注解
AVD引擎在做任何功能操作前，必须先要初始化引擎成功。引擎初始化是一个异步操作，调用此接口后等待回调中函数onInitResult回调，判断是否初始化成功。
返回
返回错误代码。

◆ initWithServerUrl:OEM:delegate:()

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

初始化引擎

参数
[in]severuri服务器uri, 取值格式为([]中内容可选)：https://xxx.com[:443]，http://xxx.cn[:80]，xxx.cn[:8080](为http)。
[in]oemName叁体公司Open-AVD产品OEM的厂家名称。
[in]delegate引擎回调指针。
注解
AVD引擎在做任何功能操作前，必须先要初始化引擎成功。引擎初始化是一个异步操作，调用此接口后等待回调中函数onInitResult回调，判断是否初始化成功。
返回
返回错误代码。

◆ initWithServerUrl:token:delegate:()

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

初始化引擎

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

◆ instance()

+ (AVDEngine*) instance

获取AVD引擎对象

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

◆ isWorking()

- (BOOL) isWorking

判断引擎是否正常工作

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

◆ scheduleRoom:()

- (AVDResult) scheduleRoom: (AVDRoomInfo *)  roomInfo

安排房间

参数
[in]*roomInfo房间信息。
注解
安排房间为异步操作，调用此接口后等待回调中函数onScheduleRoomResult回调，判断是否安排成功。
返回
返回错误代码。

◆ setLogParams:file:()

- (AVDResult) setLogParams: (NSString *)  params
file: (NSString *)  filename 

设置引擎日志配置

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

◆ setOption:value:()

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

设置引擎选项

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

◆ setUserInfo:()

- (AVDResult) setUserInfo: (AVDUser *)  info

设置全局用户信息

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

◆ uninit()

- (AVDResult) uninit

反初始化引擎

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

属性说明

◆ easyrooms

- (NSMutableArray*) easyrooms
readwritenonatomicretain

◆ rooms

- (NSMutableArray*) rooms
readwritenonatomicretain
该类的文档由以下文件生成:
制作者   doxygen 1.8.13