简易房间接口类 更多...
类 AVDEasyRoom 继承关系图:
类方法 | |
| (AVDEasyRoom *) | + obtain: |
| 获取或创建房间接口 更多... | |
属性 | |
| id< AVDEasyRoomDelegate > | delegate |
| 房间逻辑回调代理 更多... | |
| AVDVideoParams * | videoParams |
| 视频参数 更多... | |
| AVDAudioParams * | audioParams |
| 音频参数 更多... | |
| AVDRoomId | roomId |
| 当前的房间Id 更多... | |
| AVDRoomInfo * | roomInfo |
| 当前的房间信息 更多... | |
| AVDUserId | selfUserId |
| 自己的用户ID 更多... | |
| AVDUser * | selfUser |
| 自己的用户信息 更多... | |
| NSMutableArray * | participants |
| 参会者列表用户信息， 数组中存放AVDUser对象 更多... | |
详细描述
简易房间接口类
简易房间接口定义了独立的简易房间对象创建和释放、房间功能操作。
函数文档
◆ __attribute__()
| - (( unavailable("init is not a supported initializer for this class.") __attribute__ |
◆ attachRender:render:()
| - (AVDResult) attachRender: | (AVDUserId) | userId | |
| render: | (id< AVDVideoRenderer >) | render | |
关联视频数据和显示对象，在render中显示视频
- 参数
-
[in] userId 摄像头Id，唯一标示一路共享的摄像头视频。 [in] *render 显示对象接口指针。
- 注解
- 视频数据可以在多个显示对象上显示，而一个显示对象某一时刻只能显示一路视频。 在本地视频发布到房间中，或者远端视频订阅成功后，调用此接口完成视频与显示对象的对接，从而在显示对象中显示视频。
- 返回
- 返回错误代码。
- 参见
- IVideoRender
◆ destory()
| - (void) destory |
释放房间接口
- 注解
- 释放房间后，App层不能再使用当前房间指针，所有引用房间指针处均需设置为NULL。
◆ detachRender:()
解除摄像头视频数据的所有显示对象关联
- 参数
-
[in] userId 摄像头Id，唯一标示一路共享的摄像头视频。
- 返回
- 返回错误代码。
◆ enableStats:()
| - (AVDResult) enableStats: | (BOOL) | isEnable |
当前房间启用或关闭流量统计功能
- 参数
-
[in] isEnable 启用或关闭。
- 返回
- 返回错误代码： AVD_OK 成功
◆ getOption:()
| - (NSString*) getOption: | (enum AVDRoomOption) | type |
获取房间选项
- 参数
-
[in] type 房间选项类型。
- 返回
- 返回选项内容，根据选项说明解析。
◆ getRoomStats()
| - (AVDRoomStats*) getRoomStats |
获取房间的流量统计信息
- 返回
- 返回房间流量统计信息。
- 参见
- RoomStats
◆ getVideoMixer()
| - (AVDVideoMixer*) getVideoMixer |
获取视频混频布局接口
- 返回
- 混频布局接口
◆ ismuteMicrophone()
| - (BOOL) ismuteMicrophone |
判断本地麦克风是否静默
- 返回
- 返回静默状态。
◆ isWorking()
| - (BOOL) isWorking |
◆ joinWithUser:delegate:()
房间加入退出逻辑
当前用户加入房间
- 参数
-
[in] *user 用户信息：用户Id(不能包含'{'、'}'字符)，用户名，用户数据等；当应用层必须传入有效的user.UserId，来唯一标识一个用户。 [in] joinresult 加房间回调接口。
- 返回
- 返回错误代码。
- 参见
- User
◆ kickoutUser:userId:()
房间中踢出用户
- 参数
-
[in] reason 踢出用户的理由代码。 [in] userId 被踢出用户Id。
- 注解
- 被踢用户将会在onLeaveIndication中接收到回调，被踢用户直接调用 leave 离开房间即可。
- 返回
- 返回错误代码。
- 参见
- onLeaveIndication
◆ leave:()
当前用户离开房间
- 参数
-
[in] reason 用户离开房间的原因代码，正常离开为AVD_OK。
- 注解
- 当前用户离开房间后，当前房间对象和房间的各功能模块都处于离会状态，功能操作无效。
- 返回
- 返回错误代码。
◆ muteMicrophone()
| - (AVDResult) muteMicrophone |
本地麦克风静默
- 返回
- 返回错误代码。
◆ obtain:()
| + (AVDEasyRoom*) obtain: | (AVDRoomId) | roomID |
获取或创建房间接口
- 参数
-
[in] roomId 房间Id。
- 注解
- 只支持单用户应用，不支持多用户应用。
- 返回
- 返回房间接口指针。
◆ previewCamera:()
| - (AVDResult) previewCamera: | (id< AVDVideoRenderer >) | render |
预览本地缺省摄像头视频
- 参数
-
[in] *render 显示对象接口指针
- 注解
- 本地视频在发布到会议前，可以调用此接口进行视频预览；视频发布到会议中后，需要使用attachRender接口来进行视频显示，此时此接口无效。 只支持单个视频输入设备，如果设置了 FakeVideoCapturer 优先使用外部导入视频； 如果没有设置外部导入视频源，根据设置使用缺省视频设备。
- 返回
- 返回错误代码。
- 参见
- IVideoRender
◆ publishCamera()
| - (AVDResult) publishCamera |
发布缺省摄像头视频
- 返回
- 返回错误代码。
- 注解
- 发布操作为异步操作，操作结果在 onPublishResult 中返回。
- 参见
- onPublishResult
◆ publishMicrophone()
| - (AVDResult) publishMicrophone |
打开本地麦克风发布到房间中
- 返回
- 返回错误代码。
- 注解
- 为异步操作，操作结果在 onOpenMicrophoneResult 中返回。 只支持单个音频输入设备，如果设置了 FakeAudioCapturer优先使用外部导入音频； 如果没有设置外部导入音频源，根据设置使用缺省音频设备。
- 参见
- onOpenMicrophoneResult
◆ sendPrivateData:toUserId:()
透明通道，发送私有数据
- 参数
-
[in] *data 发送的数据指针。 [in] toId 目的用户Id。
- 注解
- 此透明通道用于承载应用层数据，发送给房间内某一特定用户。
- 返回
- 返回错误代码。
◆ sendPublicData:()
| - (AVDResult) sendPublicData: | (NSData *) | data |
透明通道，发送广播数据
- 参数
-
[in] *data 发送的数据指针。
- 注解
- 此透明通道用于承载应用层数据，广播给所有房间内用户。
- 返回
- 返回错误代码。
◆ setAudioMixerDataListener:sampleRate:()
| - (AVDResult) setAudioMixerDataListener: | (id< AVDAudioRenderer >) | listener | |
| sampleRate: | (NSInteger) | sampleRate | |
音视频导出操作
设置获取混音数据回调接口
- 参数
-
[in] listener 混音数据回调指针。 [in] sampleRate 导出混音数据的采样率：16000,44100,48000。
- 返回
- 返回错误代码。
- 参见
- IAudioRender
- ro_audio_mixerdata_callback_buffered 单次混音数据回调“10ms数据”还是“1024samples数据”
- 注解
- 如果音视频同时混合出流，建议先设置视频，再设置音频的回调接口，有助于音视频时间戳对齐。
◆ setAudioSource:()
| - (AVDResult) setAudioSource: | (AVDFakeAudioCapturer *) | acapturer |
开启直播（主播）或对讲（观众）前: 设置音频的输入数据源
- 参数
-
[in] *acapturer 音频的输入数据源。
- 返回
- 返回错误代码。
- 参见
- FakeAudioCapturer
◆ setOption:value:()
| - (AVDResult) setOption: | (enum AVDRoomOption) | type | |
| value: | (NSString *) | svalue | |
设置房间选项
- 参数
-
[in] type 房间选项类型。 [in] svalue 选项内容，根据选项说明填入。
- 返回
- 返回错误代码。
◆ setVideoMixerDataListener:()
| - (AVDResult) setVideoMixerDataListener: | (id< AVDVideoRenderer >) | listener |
设置获取视频数据回调接口,此数据仅回调一份数据：数据为主视频+各个Overlay的视频，视频大小为主视频大小；如使用ILivecast接口，不需要设置此接口。
- 参数
-
[in] listener 混音数据回调指针。
- 返回
- 返回错误代码。
- 参见
- IVideoRender
- 注解
- 如果音视频同时混合出流，建议先设置视频，再设置音频的回调接口，有助于音视频时间戳对齐。
◆ setVideoSource:()
| - (AVDResult) setVideoSource: | (AVDFakeVideoCapturer *) | vcapturer |
音视频操作
开启直播（主播）或对讲（观众）前: 设置视频的输入数据源
- 参数
-
[in] *vcapturer 视频的输入数据源。
- 返回
- 返回错误代码。
- 参见
- FakeVideoCapturer
◆ switchCamera()
| - (AVDResult) switchCamera |
视频切换摄像头
- 返回
- 返回错误代码。
◆ unmuteMicrophone()
| - (AVDResult) unmuteMicrophone |
本地麦克风静默取消
- 返回
- 返回错误代码。
◆ unpreviewCamera()
| - (AVDResult) unpreviewCamera |
取消预览缺省摄像头视频
- 返回
- 返回错误代码。
◆ unpublishCamera()
| - (AVDResult) unpublishCamera |
取消发布缺省摄像头视频
- 返回
- 返回错误代码。
- 注解
- 取消发布操作为异步操作，操作结果在 onUnpublishResult 中返回。
- 参见
- onUnpublishResult
◆ unpublishMicrophone()
| - (AVDResult) unpublishMicrophone |
关闭本地麦克风发布到房间中
- 返回
- 返回错误代码。
- 注解
- 为异步操作，操作结果在 onCloseMicrophoneResult 中返回。
- 参见
- onCloseMicrophoneResult
属性说明
◆ audioParams
|
readwritenonatomicretain |
音频参数
◆ delegate
|
readwritenonatomicweak |
房间逻辑回调代理
◆ participants
|
readnonatomicretain |
参会者列表用户信息， 数组中存放AVDUser对象
◆ roomId
|
readnonatomicretain |
当前的房间Id
◆ roomInfo
|
readnonatomicretain |
当前的房间信息
◆ selfUser
|
readnonatomicretain |
自己的用户信息
◆ selfUserId
|
readnonatomicretain |
自己的用户ID
◆ videoParams
|
readwritenonatomicretain |
视频参数
该类的文档由以下文件生成:
