AVDRoom类 参考

房间接口类 更多...

类 AVDRoom 继承关系图:

构造函数
(void)	- destory
	释放房间对象 更多...
(AVDResult)	- joinWithUser:password:delegate:
	当前用户加入房间 更多...
(AVDResult)	- joinWithUser:password:delegate:oemToken:
(AVDResult)	- leave:
	当前用户离开房间 更多...
(AVDResult)	- reJoin
	重新加入当前房间 更多...
(AVDResult)	- kickoutUser:userId:
	房间中踢出用户 更多...
(AVDResult)	- updateRoomStatus:
	更新房间状态 更多...
(enum AVDRoomStatus)	- getRoomStatus
	获取房间状态 更多...
(AVDRoomId)	- getRoomId
	获取房间Id 更多...
(NSString *)	- getAppRoomId
	获取房间应用层Id 更多...
(NSString *)	- getRoomName
	获取房间名 更多...
(NSString *)	- getRoomTopic
	获取房间主题 更多...
(AVDRoomInfo *)	- getRoomInfo
	获取房间信息 更多...
(AVDResult)	- sendPublicData:
	透明通道，发送广播数据 更多...
(AVDResult)	- sendPrivateData:toUserId:
	透明通道，发送私有数据 更多...
(NSString *)	- getAppData:
	返回应用层的房间数据 更多...
(AVDResult)	- updateAppData:value:
	修改应用层的房间数据 更多...
(AVDDeviceId)	- createFakeDeviceID:
	创建模拟设备Id，在导入音视频时可用 更多...
(AVDResult)	- enableStats:
	当前房间启用或关闭流量统计功能 更多...
(AVDRoomStats *)	- getRoomStats
	获取房间的流量统计信息 更多...
(AVDMediaStats *)	- getMediaStats:
	获取某路媒体（音频或者视频）的流量统计信息 更多...
(AVDResult)	- setOption:value:
	设置房间选项 更多...
(NSString *)	- getOption:
	获取房间选项 更多...
((unavailable("init is not a supported initializer for this class.")	- __attribute__

类方法
(AVDRoom *)	+ obtain:
	获取房间对象 更多...

属性
id< AVDRoomDelegate >	delegate
	房间逻辑回调代理 更多...
AVDUserManager *	userManager
	房间用户管理模块接口 更多...

详细描述

房间接口类

房间接口定义了房间对象创建和释放、房间功能操作。

函数文档

__attribute__()

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

createFakeDeviceID:()

- (AVDDeviceId) createFakeDeviceID:

(AVDDeviceId)

fakeId

创建模拟设备Id，在导入音视频时可用

参数

[in]

fakeId

自定义Id。

返回

模拟设备Id。

注解

模拟摄像头信息，接口会生成deviceId，生成规则："userId_"+（用户输入的fakeId), 此处deviceId不能包含'_'和'{'、'}'此三个字符。

参见

previewLocalCamera

publishLocalCamera

destory()

- (void) destory

释放房间对象

enableStats:()

- (AVDResult) enableStats:

(BOOL)

isEnable

当前房间启用或关闭流量统计功能

参数

[in]

isEnable

启用或关闭。

返回

返回错误代码： AVD_OK 成功

getAppData:()

- (NSString*) getAppData:

(NSString *)

key

返回应用层的房间数据

参数

[in]

*key

房间数据关键字。

注解

应用层的房间数据方便应用层在房间中保留关于房间的一些业务逻辑数据，可以获取和修改应用层的房间数据。

返回

返回应用层的相应关键字的房间数据。

getAppRoomId()

- (NSString*) getAppRoomId

获取房间应用层Id

注解

房间应用层Id在应用层安排当前房间的时候由应用层来指定，方便应用层查找、标示房间。

返回

返回房间应用层Id。

getMediaStats:()

- (AVDMediaStats*) getMediaStats:

(AVDDeviceId)

deviceId

获取某路媒体（音频或者视频）的流量统计信息

参数

[in]

deviceId

设备Id。

返回

返回媒体统计信息。

参见

MediaStats

getOption:()

- (NSString*) getOption:

(enum AVDRoomOption)

type

获取房间选项

参数

[in]

type

房间选项类型。

返回

返回房间选项值。

getRoomId()

- (AVDRoomId) getRoomId

获取房间Id

返回

返回房间Id。

getRoomInfo()

- (AVDRoomInfo*) getRoomInfo

获取房间信息

返回

返回房间信息。

参见

RoomInfo

getRoomName()

- (NSString*) getRoomName

获取房间名

返回

返回房间名。

getRoomStats()

- (AVDRoomStats*) getRoomStats

获取房间的流量统计信息

返回

返回房间流量统计信息。

参见

RoomStats

getRoomStatus()

- (enum AVDRoomStatus) getRoomStatus

获取房间状态

返回

返回房间状态。

参见

RoomStatus

getRoomTopic()

- (NSString*) getRoomTopic

获取房间主题

返回

返回房间主题。

joinWithUser:password:delegate:()

- (AVDResult) joinWithUser:		(AVDUser *)	user
password:		(NSString *)	password
delegate:		(id< AVDRoomJoinDelegate >)	joinresult

当前用户加入房间

参数

[in]	*user	用户信息：用户Id，用户名，用户数据等；当应用层必须传入有效的user.UserId，来唯一标识一个用户。
[in]	*password	密码：如果是主持人请用主持人密码；如果是其他参会者，请用房间密码。
[in]	joinresult	加房间回调接口。

返回

返回错误代码。

参见

User

joinWithUser:password:delegate:oemToken:()

- (AVDResult) joinWithUser:		(AVDUser *)	user
password:		(NSString *)	password
delegate:		(id< AVDRoomJoinDelegate >)	joinresult
oemToken:		(NSString *)	token

kickoutUser:userId:()

- (AVDResult) kickoutUser:		(AVDResult)	reason
userId:		(AVDUserId)	userId

房间中踢出用户

参数

[in]	reason	踢出用户的理由代码。
[in]	userId	被踢出用户Id。

注解

被踢用户将会在onLeaveIndication中接收到回调，被踢用户直接调用 leave 离开房间即可。

返回

返回错误代码。

参见

onLeaveIndication

leave:()

- (AVDResult) leave:

(AVDResult)

reason

当前用户离开房间

参数

[in]

reason

用户离开房间的原因代码，正常离开为AVD_OK。

注解

当前用户离开房间后，当前房间对象和房间的各功能模块都处于离会状态，功能操作无效。

返回

返回错误代码。

obtain:()

+ (AVDRoom*) obtain:

(AVDRoomId)

roomID

获取房间对象

注解

房间对象的生命周期由AVD SDK来管理，应用层通过obtain获取一个房间对象，房间最终不使用的时候调用destory来释放。

返回

返回房间对象指针。

reJoin()

- (AVDResult) reJoin

重新加入当前房间

注解

当用户主动离开房间或者中间网络断线后离开房间后，可以重新调用此函数加入房间。

返回

返回错误代码。

sendPrivateData:toUserId:()

- (AVDResult) sendPrivateData:		(NSData *)	data
toUserId:		(AVDUserId)	toId

透明通道，发送私有数据

参数

[in]	*data	发送的数据指针。
[in]	toId	目的用户Id。

注解

此透明通道用于承载应用层数据，发送给房间内某一特定用户。

返回

返回错误代码。

sendPublicData:()

- (AVDResult) sendPublicData:

(NSData *)

data

透明通道，发送广播数据

参数

[in]

*data

发送的数据指针。

注解

此透明通道用于承载应用层数据，广播给所有房间内用户。

返回

返回错误代码。

setOption:value:()

- (AVDResult) setOption:		(enum AVDRoomOption)	type
value:		(NSString *)	svalue

设置房间选项

参数

[in]	type	房间选项类型。
[in]	svalue	房间选项值。

返回

返回错误代码。

updateAppData:value:()

- (AVDResult) updateAppData:		(NSString *)	key
value:		(NSString *)	value

修改应用层的房间数据

参数

[in]	*key	房间数据关键字。
[in]	*value	房间数据对应关键字的信息内容

返回

返回错误代码。

updateRoomStatus:()

- (AVDResult) updateRoomStatus:

(enum AVDRoomStatus)

status

更新房间状态

参数

[in]

status

房间状态。

返回

返回错误代码。

参见

RoomStatus

属性说明

delegate

- (id<AVDRoomDelegate>) delegate

readwritenonatomicweak

房间逻辑回调代理

userManager

- (AVDUserManager*) userManager

readwritenonatomicstrong

房间用户管理模块接口

---

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

• AVDRoom.h