AVDRoom Class Reference
| Inherits from | NSObject |
|---|---|
| Declared in | AVDRoom.h AVDRoom.mm |
userManager
< 房间逻辑回调代理
@property (nonatomic, strong) AVDUserManager *userManagerDiscussion
< 房间逻辑回调代理
Declared In
AVDRoom.h
+ obtain:
获取房间对象
+ (AVDRoom *)obtain:(AVDRoomId)roomIDReturn Value
返回房间对象指针。
Discussion
获取房间对象
Note: 房间对象的生命周期由AVD SDK来管理，应用层通过obtain获取一个房间对象，房间最终不使用的时候调用destory来释放。
Declared In
AVDRoom.h
– joinWithUser:delegate:
当前用户加入房间
- (AVDResult)joinWithUser:(AVDUser *)user delegate:(id<AVDRoomJoinDelegate>)joinresultReturn Value
返回错误代码。
Discussion
当前用户加入房间
@param[in] user 用户信息：用户Id，用户名，用户数据等；当应用层必须传入有效的user.UserId，来唯一标识一个用户。 @param[in] password 密码：如果是主持人请用主持人密码；如果是其他参会者，请用房间密码。 @param[in] joinresult 加房间回调接口。
Declared In
AVDRoom.h
– leave:
当前用户离开房间
- (AVDResult)leave:(AVDResult)reasonReturn Value
返回错误代码。
Discussion
当前用户离开房间
@param[in] reason 用户离开房间的原因代码，正常离开为AVD_OK。
Note: 当前用户离开房间后，当前房间对象和房间的各功能模块都处于离会状态，功能操作无效。
Declared In
AVDRoom.h
– reJoin
重新加入当前房间
- (AVDResult)reJoinReturn Value
返回错误代码。
Discussion
重新加入当前房间
Note: 当用户主动离开房间或者中间网络断线后离开房间后，可以重新调用此函数加入房间。
Declared In
AVDRoom.h
– kickoutUser:userId:
房间中踢出用户
- (AVDResult)kickoutUser:(AVDResult)reason userId:(AVDUserId)userIdReturn Value
返回错误代码。
Discussion
房间中踢出用户
@param[in] reason 踢出用户的理由代码。 @param[in] userId 被踢出用户Id。
Note: 被踢用户将会在onLeaveIndication中接收到回调，被踢用户直接调用 leave 离开房间即可。
Declared In
AVDRoom.h
– updateRoomStatus:
更新房间状态
- (AVDResult)updateRoomStatus:(enum AVDRoomStatus)statusReturn Value
返回错误代码。
Discussion
更新房间状态
@param[in] status 房间状态。
Declared In
AVDRoom.h
– getRoomStatus
获取房间状态
- (enum AVDRoomStatus)getRoomStatusReturn Value
返回房间状态。
Discussion
获取房间状态
Declared In
AVDRoom.h
– getRoomId
获取房间Id
- (AVDRoomId)getRoomIdReturn Value
返回房间Id。
Discussion
获取房间Id
Declared In
AVDRoom.h
– getAppRoomId
获取房间应用层Id
- (NSString *)getAppRoomIdReturn Value
返回房间应用层Id。
Discussion
获取房间应用层Id
Note: 房间应用层Id在应用层安排当前房间的时候由应用层来指定，方便应用层查找、标示房间。
Declared In
AVDRoom.h
– getRoomName
获取房间名
- (NSString *)getRoomNameReturn Value
返回房间名。
Discussion
获取房间名
Declared In
AVDRoom.h
– getRoomTopic
获取房间主题
- (NSString *)getRoomTopicReturn Value
返回房间主题。
Discussion
获取房间主题
Declared In
AVDRoom.h
– getRoomInfo
获取房间信息
- (AVDRoomInfo *)getRoomInfoReturn Value
返回房间信息。
Discussion
获取房间信息
Declared In
AVDRoom.h
– sendPublicData:
透明通道，发送广播数据
- (AVDResult)sendPublicData:(NSData *)dataReturn Value
返回错误代码。
Discussion
透明通道，发送广播数据
@param[in] *data 发送的数据指针。
Note: 此透明通道用于承载应用层数据，广播给所有房间内用户。
Declared In
AVDRoom.h
– sendPrivateData:toUserId:
透明通道，发送私有数据
- (AVDResult)sendPrivateData:(NSData *)data toUserId:(AVDUserId)toIdReturn Value
返回错误代码。
Discussion
透明通道，发送私有数据
@param[in] *data 发送的数据指针。 @param[in] toId 目的用户Id。
Note: 此透明通道用于承载应用层数据，发送给房间内某一特定用户。
Declared In
AVDRoom.h
– getAppData:
返回应用层的房间数据
- (NSString *)getAppData:(NSString *)keyReturn Value
返回应用层的相应关键字的房间数据。
Discussion
返回应用层的房间数据
@param[in] *key 房间数据关键字。
Note: 应用层的房间数据方便应用层在房间中保留关于房间的一些业务逻辑数据，可以获取和修改应用层的房间数据。
Declared In
AVDRoom.h
– updateAppData:value:
修改应用层的房间数据
- (AVDResult)updateAppData:(NSString *)key value:(NSString *)valueReturn Value
返回错误代码。
Discussion
修改应用层的房间数据
@param[in] key 房间数据关键字。 @param[in] value 房间数据对应关键字的信息内容
Declared In
AVDRoom.h
– enableStats:
当前房间启用或关闭流量统计功能 @param[in] isEnable 启用或关闭。
- (AVDResult)enableStats:(BOOL)isEnableReturn Value
返回错误代码： AVD_OK 成功
Discussion
当前房间启用或关闭流量统计功能 @param[in] isEnable 启用或关闭。
Declared In
AVDRoom.h
– getRoomStats
获取房间的流量统计信息
- (AVDRoomStats *)getRoomStatsReturn Value
返回房间流量统计信息。
Discussion
获取房间的流量统计信息
Declared In
AVDRoom.h
– getMediaStats:
获取某路媒体（音频或者视频）的流量统计信息 @param[in] deviceId 设备Id。
- (AVDMediaStats *)getMediaStats:(AVDDeviceId)deviceIdReturn Value
返回媒体统计信息。
Discussion
获取某路媒体（音频或者视频）的流量统计信息 @param[in] deviceId 设备Id。
Declared In
AVDRoom.h
– setOption:value:
设置房间选项
- (AVDResult)setOption:(enum AVDRoomOption)type value:(NSString *)svalueReturn Value
返回错误代码。
Discussion
设置房间选项
@param[in] type 房间选项类型。 @param[in] svalue 房间选项值。
Declared In
AVDRoom.h
– getOption:
获取房间选项
- (NSString *)getOption:(enum AVDRoomOption)typeReturn Value
返回房间选项值。
Discussion
获取房间选项
@param[in] type 房间选项类型。
Declared In
AVDRoom.h