直播主播接口类 更多...
类 AVDMainBroadcaster 继承关系图:
类方法 | |
| (AVDMainBroadcaster *) | + obtain: |
| 获取或创建直播主播房间对象 更多... | |
 类方法 继承自 AVDLivecast | |
| (AVDResult) | + setLivecastId: |
| 设置直播Id 更多... | |
| (AVDLivecast *) | + instance |
| 获取直播接口 更多... | |
| (void) | + destory |
| 释放直播接口 更多... | |
属性 | |
| id< AVDMainBroadcasterDelegate > | delegate2 |
| 直播回调代理 更多... | |
| 属性 继承自 AVDLivecast | |
| id< AVDLivecastDelegate > | delegate |
| 直播回调代理 更多... | |
| id< AVDStreamStatsDelegate > | streamStatsdelegate |
| 直播推流状态回调代理 更多... | |
| AVDVideoParams * | videoParams |
| 视频参数 更多... | |
| AVDAudioParams * | audioParams |
| 音频参数 更多... | |
| enum AVDLivecastStatus | status |
| 直播状态 更多... | |
| BOOL | isMicrophoneMute |
| 麦克风是否mute状态 更多... | |
详细描述
直播主播接口类
直播主播接口定义了直播主播对象创建、直播发布和关闭操作。
函数文档
◆ __attribute__()
| - (( unavailable("init is not a supported initializer for this class.") __attribute__ |
实现了 AVDLivecast.
◆ addLiveSubVideo:zorder:x:y:w:h:()
| - (AVDResult) addLiveSubVideo: | (AVDDeviceId) | deviceId | |
| zorder: | (NSInteger) | zorder | |
| x: | (float) | x | |
| y: | (float) | y | |
| w: | (float) | w | |
| h: | (float) | h | |
添加视频到直播视频特定位置
- 参数
-
[in] deviceId 摄像头Id，唯一标示一路共享的摄像头视频。 [in] zorder 多个视频覆盖时，前后位置，zorder越小，视频越在前面，后面会被覆盖；取值0-n [in] x 此视频在直播视频的左上角左边位置，即x坐标，取值0.0~1.0，内部取值为：width (直播视频）x X [in] y 此视频在直播视频的左上角上边位置，即y坐标，取值0.0~1.0，内部取值为：height(直播视频）x Y [in] w 此视频在直播视频的宽度比例，取值0.0~1.0，内部取值为：width (直播视频）x W [in] h 此视频在直播视频的高度比例，取值0.0~1.0，内部取值为：height(直播视频）x H
- 返回
- 返回错误代码。
- 参见
- addMixerOverlayVideo
◆ autoLayoutParams:w:h:x_begin:y_begin:()
| - (AVDResult) autoLayoutParams: | (BOOL) | isTopdown | |
| w: | (float) | w | |
| h: | (float) | h | |
| x_begin: | (float) | x_begin | |
| y_begin: | (float) | y_begin | |
直播视频自动布局的布局参数设置
- 参数
-
[in] isTopdown 各子视频在直播视频上的排列顺序，true: 从上往下（左到右）排列； false: 从下往上（左到右）排列 [in] w 各子视频相对直播视频的宽度比例，取值0.0~1.0，内部取值为：width (直播视频）x W [in] h 各子视频相对直播视频的高度比例，取值0.0~1.0，内部取值为：height(直播视频）x H [in] x_begin 初始子视频在直播视频的左上角左边位置，即x坐标，取值0.0~1.0，内部取值为：width (直播视频）x x_begin [in] y_begin 初始子视频在直播视频的左上角上边位置，即y坐标，取值0.0~1.0，内部取值为：height(直播视频）x y_begin
- 返回
- 返回错误代码。
- 注解
- 缺省设置为：vl_auto_overlay布局类型，从下往上排列; w=h=0.3f; x_begin=0.7f; y_begin=0.7f;
◆ clearLiveSubVideos()
| - (void) clearLiveSubVideos |
清理掉所有的混屏视频，包括主视频；如果需要再次开启合屏，需要重新设置直播视频和Overlay视频。
- 返回
- 返回错误代码。
◆ getPublishedVideos()
| - (NSArray*) getPublishedVideos |
获取房间中已发布视频列表
- 返回
- 返回视频列表。
- 注解
- 视频列表包含摄像头、虚拟导入视频、屏幕共享视频；
◆ kickoutUser:userId:()
房间中踢出用户
- 参数
-
[in] reason 踢出用户的理由代码。 [in] userId 被踢出用户Id。
- 注解
- 被踢用户将会在onLivecastStatus中接收到回调状态改变，从连麦状态到观看直播
- 返回
- 返回错误代码。
◆ obtain:()
| + (AVDMainBroadcaster*) obtain: | (AVDRoomId) | roomId |
获取或创建直播主播房间对象
- 参数
-
[in] roomId 直播房间Id。
- 返回
- 返回直播主播接口指针。
◆ publish:render:()
| - (AVDResult) publish: | (NSString *) | pushUrl | |
| render: | (id< AVDVideoRenderer >) | preview | |
开启直播
- 参数
-
[in] pushUrl 直播rtmp推流地址。 [in] *preview 本地预览render接口。
- 返回
- 返回错误代码。
- 参见
- onPublishResult
◆ removeLiveSubVideo:()
| - (void) removeLiveSubVideo: | (AVDDeviceId) | deviceId |
移除直播视频上的某一视频
- 参数
-
[in] deviceId 摄像头Id，唯一标示一路共享的摄像头视频。
- 返回
- 返回错误代码。
◆ setLiveMainVideo:()
| - (AVDResult) setLiveMainVideo: | (AVDDeviceId) | deviceId |
切换直播视频的主视频（若主视频掉线，本地主播视频切为主视频）
- 参数
-
[in] deviceId 摄像头Id，唯一标示一路共享的摄像头视频。
- 返回
- 返回错误代码。
- 注解
- 直播视频的主视频在vl_auto_overlay模式下可以做切换，缺省为主播视频
◆ setLiveVideoBackgroud:()
| - (AVDResult) setLiveVideoBackgroud: | (NSString *) | background |
设置直播视频背景图片
- 参数
-
[in] background 直播背景图
- 返回
- 返回错误代码。
◆ setLiveVideoScaleType:()
| - (AVDResult) setLiveVideoScaleType: | (enum AVDScalingType) | scale |
设置直播视频合屏时采用的拉伸方式
- 参数
-
[in] scale 各子视频合屏时采用的拉伸方式，参考ScaleType
- 返回
- 返回错误代码。
◆ setLiveVideoTypeaSize:width:height:()
| - (AVDResult) setLiveVideoTypeaSize: | (enum AVDMixerVideoLayoutType) | layout | |
| width: | (NSInteger) | width | |
| height: | (NSInteger) | height | |
设置直播视频参数
- 参数
-
[in] layout 各子视频在直播视频中的布局类型 [in] width 直播视频图像宽 [in] height 直播视频图像高
- 返回
- 返回错误代码。
◆ unpublish()
| - (AVDResult) unpublish |
◆ updateLiveSubVideo:zorder:x:y:w:h:()
| - (AVDResult) updateLiveSubVideo: | (AVDDeviceId) | deviceId | |
| zorder: | (NSInteger) | zorder | |
| x: | (float) | x | |
| y: | (float) | y | |
| w: | (float) | w | |
| h: | (float) | h | |
更新附加视频在直播视频上显示的位置
- 参数
-
[in] deviceId 摄像头Id，唯一标示一路共享的摄像头视频。 [in] zorder 多个视频覆盖时，前后位置，zorder越小，视频越在前面，后面会被覆盖；取值0-n [in] x 此视频在直播视频的左上角左边位置，即x坐标，取值0.0~1.0，内部取值为：width (直播视频）x X [in] y 此视频在直播视频的左上角上边位置，即y坐标，取值0.0~1.0，内部取值为：height(直播视频）x Y [in] w 此视频在直播视频的宽度比例，取值0.0~1.0，内部取值为：width (直播视频）x W [in] h 此视频在直播视频的高度比例，取值0.0~1.0，内部取值为：height(直播视频）x H
- 返回
- 返回错误代码。
属性说明
◆ delegate2
|
readwritenonatomicweak |
直播回调代理
该类的文档由以下文件生成:
