AVDLivecast Class Reference

Inherits from NSObject
Declared in AVDLivecast.h
AVDLivecast.mm

Overview

  • 直播接口类

*

  • 直播接口定义了直播对象创建和释放、直播功能操作。

  streamStatsdelegate

< 直播回调代理

@property (nonatomic, weak) id<AVDStreamStatsDelegate> streamStatsdelegate

Discussion

< 直播回调代理

Declared In

AVDLivecast.h

  videoParams

< 直播推流状态回调代理

@property (nonatomic, retain) AVDVideoParams *videoParams

Discussion

< 直播推流状态回调代理

Declared In

AVDLivecast.h

  audioParams

< 视频参数

@property (nonatomic, retain) AVDAudioParams *audioParams

Discussion

< 视频参数

Declared In

AVDLivecast.h

  status

< 音频参数

@property (nonatomic, assign, readonly) enum AVDLivecastStatus status

Discussion

< 音频参数

Declared In

AVDLivecast.h

  isMicrophoneMute

< 直播状态

@property (nonatomic, assign, readonly) BOOL isMicrophoneMute

Discussion

< 直播状态

Declared In

AVDLivecast.h

+ setLivecastId:

设置直播Id

+ (AVDResult)setLivecastId:(AVDRoomId)castId

Discussion

设置直播Id

  • @return 返回错误代码。

  • @note 直播Id唯一标识一个直播,设置后才能使用直播接口。

Declared In

AVDLivecast.h

+ instance

获取直播接口

+ (AVDLivecast *)instance

Discussion

获取直播接口

  • @return 返回直播接口指针。

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

  • @sa setLivecastId

Declared In

AVDLivecast.h

+ destory

释放直播接口

+ (void)destory

Discussion

释放直播接口

Declared In

AVDLivecast.h

– initContext

直播对象初始化

- (AVDResult)initContext

Discussion

直播对象初始化

*

  • @return 返回错误代码。

Declared In

AVDLivecast.h

– uninit

直播对象反初始化

- (AVDResult)uninit

Discussion

直播对象反初始化

  • @return 返回错误代码。

Declared In

AVDLivecast.h

– setDisplayView:

设置视频显示窗口

- (AVDResult)setDisplayView:(id<AVDVideoRenderer>)render

Discussion

设置视频显示窗口

  • @param[in] render 本地预览render接口。

  • @return 返回错误代码。

  • @sa IVideoRender

Declared In

AVDLivecast.h

– setVideoSource:

设置视频外部导入数据源

- (AVDResult)setVideoSource:(AVDFakeVideoCapturer *)vcapturer

Discussion

设置视频外部导入数据源

*

  • @param[in] vcapturer 视频外部导入数据源。

  • @return 返回错误代码。

  • @sa FakeVideoCapturer

Declared In

AVDLivecast.h

– setAudioSource:

设置音频外部导入数据源

- (AVDResult)setAudioSource:(AVDFakeAudioCapturer *)acapturer

Discussion

设置音频外部导入数据源

*

  • @param[in] acapturer 音频外部导入数据源。

  • @return 返回错误代码。

  • @sa FakeAudioCapturer

Declared In

AVDLivecast.h

– startPreview

预览本地缺省摄像头视频

- (AVDResult)startPreview

Discussion

预览本地缺省摄像头视频

  • @return 返回错误代码。

Declared In

AVDLivecast.h

– stopPreview

取消预览缺省摄像头视频

- (AVDResult)stopPreview

Discussion

取消预览缺省摄像头视频

  • @return 返回错误代码。

Declared In

AVDLivecast.h

– switchCamera

视频切换摄像头

- (AVDResult)switchCamera

Discussion

视频切换摄像头

  • @return 返回错误代码。

Declared In

AVDLivecast.h

– muteMicrophone

本地麦克风静默

- (AVDResult)muteMicrophone

Discussion

本地麦克风静默

  • @return 返回错误代码。

Declared In

AVDLivecast.h

– unmuteMicrophone

本地麦克风静默取消

- (AVDResult)unmuteMicrophone

Discussion

本地麦克风静默取消

  • @return 返回错误代码。

Declared In

AVDLivecast.h

– captureImage:

抓取直播图像

- (AVDResult)captureImage:(NSInteger)quality

Discussion

抓取直播图像

*

  • @param[in] quality 图像质量:0-100, 0最差,100最好。

  • @return 返回错误代码。

  • @note 目前在直播状态下,播放端无法抓取视频(rtmp播放器播放的时候)

Declared In

AVDLivecast.h

– publisRTMP:

开始直播

- (AVDResult)publisRTMP:(NSString *)pushUrl

Discussion

开始直播

*

  • @param[in] pushUrl 直播rtmp推流地址。

  • @return 返回错误代码。

Declared In

AVDLivecast.h

– unpublish

停止直播

- (AVDResult)unpublish

Discussion

停止直播

*

  • @return 返回错误代码。

Declared In

AVDLivecast.h

– isInRoom

判断是否正在连麦中

- (BOOL)isInRoom

Discussion

判断是否正在连麦中

  • @return 是否正在连麦。

Declared In

AVDLivecast.h

– attachRoom:

直播开始连麦

- (AVDResult)attachRoom:(AVDEasyRoom *)room

Discussion

直播开始连麦

*

  • @param[in] room 互动房间接口。

  • @return 返回错误代码。

  • @note 互动房间通过创建IEasyRoom操作,需要先创建IEasyRoom接口,然后与直播接口进行挂接

  • 直播互动挂接,系统内部会实现以下缺省操作:

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

Declared In

AVDLivecast.h

– detachRoom

直播停止连麦

- (AVDResult)detachRoom

Discussion

直播停止连麦

  • @return 返回错误代码。

Declared In

AVDLivecast.h

– setOption:value:

设置房间选项

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

Discussion

设置房间选项

*

  • @param[in] type 房间选项类型。

  • @param[in] svalue 选项内容,根据选项说明填入。

  • @return 返回错误代码。

Declared In

AVDLivecast.h

– getOption:

获取房间选项

- (NSString *)getOption:(enum AVDRoomOption)type

Discussion

获取房间选项

*

  • @param[in] type 房间选项类型。

  • @return 返回选项内容,根据选项说明解析。

Declared In

AVDLivecast.h