AVDLivecast类 参考

直播接口类 更多...

类 AVDLivecast 继承关系图:

构造函数
(AVDResult)	- initContext
	直播对象初始化 更多...
(AVDResult)	- uninit
	直播对象反初始化 更多...
(AVDResult)	- setDisplayView:
	设置视频显示窗口 更多...
(AVDResult)	- setVideoSource:
	设置视频外部导入数据源 更多...
(AVDResult)	- setAudioSource:
	设置音频外部导入数据源 更多...
(AVDResult)	- startPreview
	预览本地缺省摄像头视频 更多...
(AVDResult)	- stopPreview
	取消预览缺省摄像头视频 更多...
(AVDResult)	- switchCamera
	视频切换摄像头 更多...
(AVDResult)	- muteMicrophone
	本地麦克风静默 更多...
(AVDResult)	- unmuteMicrophone
	本地麦克风静默取消 更多...
(AVDResult)	- captureImage:
	抓取直播图像 更多...
(AVDResult)	- publisRTMP:
	开始直播 更多...
(AVDResult)	- unpublish
	停止直播 更多...
(BOOL)	- isInRoom
	判断是否正在连麦中 更多...
(AVDResult)	- attachRoom:
	直播开始连麦 更多...
(AVDResult)	- detachRoom
	直播停止连麦 更多...
(AVDResult)	- setOption:value:
	设置房间选项 更多...
(NSString *)	- getOption:
	获取房间选项 更多...
((unavailable("init is not a supported initializer for this class.")	- __attribute__

类方法
(AVDResult)	+ setLivecastId:
	设置直播Id 更多...
(AVDLivecast *)	+ instance
	获取直播接口 更多...
(void)	+ destory
	释放直播接口 更多...

属性
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__

在 AVDLivecastViewer , 以及 AVDMainBroadcaster 内被实现.

attachRoom:()

- (AVDResult) attachRoom:

(AVDEasyRoom *)

room

直播开始连麦

参数

[in]

room

互动房间接口。

返回

返回错误代码。

注解

互动房间通过创建IEasyRoom操作，需要先创建IEasyRoom接口，然后与直播接口进行挂接 直播互动挂接，系统内部会实现以下缺省操作：

1. 自动挂接直播的采集音视频流到房间的采集音视频流
2. 自动挂接房间的合屏视频流和混音音频流到直播推送音视频流

参见

IEasyRoom

captureImage:()

- (AVDResult) captureImage:

(NSInteger)

quality

抓取直播图像

参数

[in]	fileName	图像保存地址，绝对地址。
[in]	quality	图像质量：0-100, 0最差，100最好。

返回

返回错误代码。

注解

目前在直播状态下，播放端无法抓取视频（rtmp播放器播放的时候）

destory()

+ (void) destory

释放直播接口

detachRoom()

- (AVDResult) detachRoom

直播停止连麦

返回

返回错误代码。

getOption:()

- (NSString*) getOption:

(enum AVDRoomOption)

type

获取房间选项

参数

[in]

type

房间选项类型。

返回

返回选项内容，根据选项说明解析。

initContext()

- (AVDResult) initContext

直播对象初始化

参数

[in]

*listener

回调接口指针。

返回

返回错误代码。

参见

IListener

instance()

+ (AVDLivecast*) instance

获取直播接口

返回

返回直播接口指针。

注解

当前需要先设置直播Id，后才能使用下面所有接口。

参见

setLivecastId

isInRoom()

- (BOOL) isInRoom

判断是否正在连麦中

返回

是否正在连麦。

muteMicrophone()

- (AVDResult) muteMicrophone

本地麦克风静默

返回

返回错误代码。

publisRTMP:()

- (AVDResult) publisRTMP:

(NSString *)

pushUrl

开始直播

参数

[in]

pushUrl

直播rtmp推流地址。

返回

返回错误代码。

setAudioSource:()

- (AVDResult) setAudioSource:

(AVDFakeAudioCapturer *)

acapturer

设置音频外部导入数据源

参数

[in]

*acapturer

音频外部导入数据源。

返回

返回错误代码。

参见

FakeAudioCapturer

setDisplayView:()

- (AVDResult) setDisplayView:

(id< AVDVideoRenderer >)

render

设置视频显示窗口

参数

[in]

*render

本地预览render接口。

返回

返回错误代码。

参见

IVideoRender

setLivecastId:()

+ (AVDResult) setLivecastId:

(AVDRoomId)

castId

设置直播Id

返回

返回错误代码。

注解

直播Id唯一标识一个直播，设置后才能使用直播接口。

setOption:value:()

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

设置房间选项

参数

[in]	type	房间选项类型。
[in]	svalue	选项内容，根据选项说明填入。

返回

返回错误代码。

setVideoSource:()

- (AVDResult) setVideoSource:

(AVDFakeVideoCapturer *)

vcapturer

设置视频外部导入数据源

参数

[in]

*vcapturer

视频外部导入数据源。

返回

返回错误代码。

参见

FakeVideoCapturer

startPreview()

- (AVDResult) startPreview

预览本地缺省摄像头视频

返回

返回错误代码。

stopPreview()

- (AVDResult) stopPreview

取消预览缺省摄像头视频

返回

返回错误代码。

switchCamera()

- (AVDResult) switchCamera

视频切换摄像头

返回

返回错误代码。

uninit()

- (AVDResult) uninit

直播对象反初始化

返回

返回错误代码。

unmuteMicrophone()

- (AVDResult) unmuteMicrophone

本地麦克风静默取消

返回

返回错误代码。

unpublish()

- (AVDResult) unpublish

停止直播

返回

返回错误代码。

在 AVDMainBroadcaster 内被实现.

属性说明

audioParams

- (AVDAudioParams*) audioParams

readwritenonatomicretain

音频参数

delegate

- (id<AVDLivecastDelegate>) delegate

readwritenonatomicweak

直播回调代理

isMicrophoneMute

- (BOOL) isMicrophoneMute

readnonatomicassign

麦克风是否mute状态

status

- (enum AVDLivecastStatus) status

readnonatomicassign

直播状态

streamStatsdelegate

- (id<AVDStreamStatsDelegate>) streamStatsdelegate

readwritenonatomicweak

直播推流状态回调代理

videoParams

- (AVDVideoParams*) videoParams

readwritenonatomicretain

视频参数

---

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

• AVDLivecast.h