Inheritance diagram for AlivcLivePusher:

Instance Methods
(int)	- addDynamicWaterMarkImageDataWithPath:x:y:w:h:
	添加动态贴纸,最多支持添加5个贴纸 More...

(int)	- addMixAudio:format:audioSample:
	添加音频混流设置 More...

(int)	- addMixVideo:width:height:rotation:displayX:displayY:displayW:displayH:adjustHeight:
	添加视频混流设置 More...

(int)	- addWatermarkWithPath:watermarkCoordX:watermarkCoordY:watermarkWidth:
	添加水印最多支持3个水印 More...

(void)	- changeMixVideoPosition:displayX:displayY:displayW:displayH:
	改变视频混流位置 More...

(void)	- destory
	销毁推流引擎 More...

(int)	- enableAudioVolumeIndication:smooth:reportVad:
	设置音量回调频率和平滑系数 More...

(int)	- enableSpeakerphone:
	设置音频输出为听筒还是扬声器 More...

(int)	- focusCameraAtAdjustedPoint:autoFocus:
	对焦 More...

(float)	- getCurrentExposure
	获取当前曝光度 More...

(float)	- getCurrentZoom
	获取当前变焦值 More...

(AlivcLivePushStatsInfo *)	- getLivePushStatusInfo
	获取推流数据统计 More...

(AlivcLivePushStatus)	- getLiveStatus
	获取当前推流状态 More...

(float)	- getMaxZoom
	获取支持的最大变焦值 More...

(NSString *)	- getPushURL
	获取当前推流URL More...

(float)	- getSupportedMaxExposure
	获取支持最大曝光度 More...

(float)	- getSupportedMinExposure
	获取支持最小曝光度 More...

(AlivcLivePushVideoEncoderModeHardCodec)	- getVideoCodecType
	获取当前视频编码格式 More...

(instancetype)	- initWithConfig:
	创建一个推流引擎实例 More...

(bool)	- inputMixAudioData:data:size:pts:
	输入音频混流数据 More...

(void)	- inputMixVideoData:data:width:height:stride:size:pts:rotation:
	输入视频混流数据 More...

(BOOL)	- isCameraAutoFocusFaceModeSupported
	摄像头是否支持人脸聚焦 More...

(BOOL)	- isEnableSpeakerphone
	获取当前音频输出为听筒还是扬声器 More...

(BOOL)	- isPushing
	获取是否正在推流 More...

(int)	- muteLocalCamera:
	关闭/打开视频（非互动模式暂不支持该API，调用无任何效果） More...

(int)	- pause
	暂停摄像头推流，如果pushCongfig 中设置了pauseImg图片，将推设置的静态图片 More...

(int)	- pauseBGM
	暂停播放背景音乐 More...

(int)	- reconnectPushAsync
	重连异步接口 More...

(int)	- reconnectPushAsync:
	推流URL的重连异步接口 More...

(int)	- refreshPushURLToken:
	刷新Token鉴权信息，传入一个新的推流URL，包含未过期的新token信息，房间ID/用户ID/sdkAppId需要和之前保持一样 More...

(void)	- removeDynamicWaterMark:
	删除动态贴纸 More...

(void)	- removeMixAudio:
	移除音频混流 More...

(void)	- removeMixVideo:
	移除视频混流设置 More...

(int)	- restartPush
	重新推流同步接口 More...

(int)	- restartPushAsync
	重新推流异步接口 More...

(int)	- resume
	恢复摄像头推流同步接口 More...

(int)	- resumeAsync
	恢复推流异步接口 More...

(int)	- resumeBGM
	恢复播放背景音乐 More...

(void)	- sendAudioSampleBuffer:withType:
	发送自定义的audio SampleBuffer More...

(int)	- sendMessage:repeatCount:delayTime:KeyFrameOnly:
	设置自定义Message (SEI) More...

(void)	- sendPCMData:size:sampleRate:channel:pts:
	发送自定义音频数据 More...

(void)	- sendVideoData:width:height:size:pts:rotation:
	发送自定义视频数据 More...

(void)	- sendVideoSampleBuffer:
	发送自定义video SampleBuffer More...

(int)	- setAudioDenoise:
	设置降噪开关 More...

(int)	- setAudioEffectReverbMode:
	设置混响音效模式 More...

(int)	- setAudioEffectVoiceChangeMode:
	设置变声音效模式 More...

(int)	- setAudioProfile:
	设置音频profile More...

(void)	- setAudioSampleDelegate:
	设置音频裸数据回调 More...

(int)	- setAutoFocus:
	设置自动对焦 More...

(void)	- setBGMDelegate:
	设置背景音乐监听回调 More...

(int)	- setBGMEarsBack:
	设置背景音乐耳返开关 More...

(int)	- setBGMLoop:
	设置背景音乐是否循环播放 More...

(int)	- setBGMVolume:
	设置背景音乐混音音乐音量 More...

(BOOL)	- setCameraAutoFocusFaceModeEnabled:
	设置摄像头人脸对焦 More...

(int)	- setCaptureVolume:
	设置背景音乐混音人声音量 More...

(void)	- setCustomDetectorDelegate:
	设置用户自定义人脸识别回调 More...

(void)	- setCustomFilterDelegate:
	设置用户自定义滤镜回调 More...

(void)	- setErrorDelegate:
	设置推流错误监听回调 More...

(int)	- setExposure:
	设置曝光度 More...

(int)	- setFlash:
	闪光灯开关 More...

(void)	- setInfoDelegate:
	设置推流状态监听回调 More...

(int)	- setLiveMixTranscodingConfig:
	设置云端的混流（转码）参数一个直播间中可能有不止一位主播，而且每个主播都有自己的画面和声音，但对于 CDN 观众来说，他们只需要一路直播流所以您需要将多路音视频流混成一路标准的直播流，这就需要混流转码在连麦场景下，需要将主播和连麦观众音视频流混成一路标准的直播流，供CDN观众观看在PK场景下，需要将进行PK的多个主播的音视频流混成一路标准的直播流，供CDN观众观看 More...

(int)	- setLogLevel:
	设置Log级别 More...

(int)	- setLogPath:maxPartFileSizeInKB:
	设置Log路径 More...

(int)	- setMinVideoBitrate:
	设置最小码率 More...

(void)	- setMixVideoMirror:isMirror:
	改变视频混流镜像 More...

(void)	- setMute:
	静音推流 More...

(void)	- setNetworkDelegate:
	设置推流网络监听回调 More...

(void)	- setpreviewDisplayMode:
	设置预览显示模式 More...

(void)	- setPreviewMirror:
	预览镜像开关 More...

(void)	- setPushMirror:
	推流镜像开关 More...

(int)	- setQualityMode:
	设置推流模式 More...

(void)	- setResolution:
	设置推流分辨率 More...

(void)	- setSnapshotDelegate:
	设置截图回调 More...

(int)	- setTargetVideoBitrate:
	设置目标码率 More...

(void)	- setWatermark:rect:
	添加水印(互动模式下使用该接口添加水印) More...

(void)	- setWatermarkVisible:
	设置水印显示和隐藏 More...

(int)	- setZoom:
	缩放 More...

(void)	- snapshot:interval:
	截图 More...

(int)	- startBGMWithMusicPathAsync:
	播放背景音乐 More...

(int)	- startIntelligentDenoise
	开启智能降噪 More...

(int)	- startPreview:
	开始预览同步接口 More...

(int)	- startPreviewAsync:
	开始预览异步接口 More...

(int)	- startPushWithURL:
	开始推流同步接口 More...

(int)	- startPushWithURLAsync:
	开始推流异步接口 More...

(BOOL)	- startRecording:
	开启本地音视频流录制 More...

(int)	- startScreenCapture:
	开始屏幕分享（该接口支持 iOS 11.0 及以上的 iPhone 和 iPad）。 More...

(int)	- startScreenShare
	启动屏幕分享 More...

(int)	- stopBGMAsync
	停止播放背景音乐 More...

(int)	- stopIntelligentDenoise
	关闭智能降噪 More...

(int)	- stopPreview
	停止预览 More...

(int)	- stopPush
	停止推流 More...

(void)	- stopRecording
	停止本地音视频流录制 More...

(int)	- stopScreenShare
	停止屏幕分享 More...

(int)	- switchCamera
	切换摄像头 More...

Class Methods
("Use AlivcLiveBase->getSDKVersion instead.")	+ __deprecated_msg
	获取SDK版本号 More...

(void)	+ hideDebugView
	隐藏调试悬浮窗 More...

(void)	+ showDebugView
	显示调试悬浮窗 More...

Method Documentation

◆ __deprecated_msg

+ ("Use AlivcLiveBase->getSDKVersion instead.") __deprecated_msg

获取SDK版本号

Returns: 版本号

◆ addDynamicWaterMarkImageDataWithPath:x:y:w:h:

- (int) addDynamicWaterMarkImageDataWithPath:	(NSString *)	waterMarkDirPath
x:	(float)	x
y:	(float)	y
w:	(float)	w
h:	(float)	h

添加动态贴纸,最多支持添加5个贴纸

Parameters

waterMarkDirPath：贴纸图片sequence目录
显示屏幕x位置（0~1.0f)
显示屏幕y位置（0~1.0f)
显示屏幕宽
显示屏幕高

Note: 注：当前SDK暂时只支持在livePushMode = AlivcLivePushBasicMode 模式下添加动态贴纸，AlivcLivePushInteractiveMode模式下暂时不支持添加动态贴纸

Returns: 返回动态贴纸的id号，删除贴纸传此id

◆ addMixAudio:format:audioSample:

- (int) addMixAudio:	(int)	channels
format:	(int)	format
audioSample:	(int)	audioSample

添加音频混流设置

Parameters

channels	声道数
format	音频格式 AlivcLivePushAudioFormat
audioSample	音频采样率

Returns: 返回对应音频混流标识ID 注：当前SDK暂时只支持在livePushMode = AlivcLivePushBasicMode 模式下添加音频混流，AlivcLivePushInteractiveMode模式下暂时不支持添加音频混流

◆ addMixVideo:width:height:rotation:displayX:displayY:displayW:displayH:adjustHeight:

- (int) addMixVideo:	(int)	format
width:	(int)	width
height:	(int)	height
rotation:	(int)	rotation
displayX:	(float)	displayX
displayY:	(float)	displayY
displayW:	(float)	displayW
displayH:	(float)	displayH
adjustHeight:	(bool)	adjustHeight

添加视频混流设置

Parameters

format	原始视频数据格式 AlivcLivePushVideoFormat
width	图像宽
height	图像高
rotation	图像角度
displayX	图像要放置到屏幕的左上角坐标x
displayY	图像要放置到屏幕的左上角坐标y
displayW	图像显示的宽度
displayH	图像显示的高度
adjustHeight	图像自适应的高度

Returns: 返回对应视频混流标识ID

Note: 注：当前SDK暂时只支持在livePushMode = AlivcLivePushBasicMode 模式下添加视频混流设置，AlivcLivePushInteractiveMode模式下暂时不支持添加视频混流设置

◆ addWatermarkWithPath:watermarkCoordX:watermarkCoordY:watermarkWidth:

- (int) addWatermarkWithPath:	(NSString *)	path
watermarkCoordX:	(CGFloat)	coordX
watermarkCoordY:	(CGFloat)	coordY
watermarkWidth:	(CGFloat)	width

添加水印最多支持3个水印

Parameters

path	水印路径
coordX	水印左上顶点x的相对坐标 [0,1]
coordY	水印左上顶点y的相对坐标 [0,1]
width	水印的相对宽度 (水印会根据水印图片实际大小和水印宽度等比缩放) (0,1]

Returns: 0:success 非0:failure

Note: 注：当前SDK暂时只支持在livePushMode = AlivcLivePushBasicMode 模式下添加水印，AlivcLivePushInteractiveMode模式下使用setWatermark添加水印

◆ changeMixVideoPosition:displayX:displayY:displayW:displayH:

- (void) changeMixVideoPosition:	(int)	handler
displayX:	(float)	displayX
displayY:	(float)	displayY
displayW:	(float)	displayW
displayH:	(float)	displayH

改变视频混流位置

Parameters

handler	视频混流标识ID，通过addMixVideo接口获得
displayX	图像要放置到屏幕的左上角坐标x
displayY	图像要放置到屏幕的左上角坐标y
displayW	图像显示的宽度
displayH	图像显示的高度

Note: 注：当前SDK暂时只支持在livePushMode = AlivcLivePushBasicMode 模式下改变视频混流位置，AlivcLivePushInteractiveMode模式下暂时不支持改变视频混流位置

◆ destory

- (void) destory

销毁推流引擎

◆ enableAudioVolumeIndication:smooth:reportVad:

- (int) enableAudioVolumeIndication:	(int)	interval
smooth:	(int)	smooth
reportVad:	(int)	reportVad

设置音量回调频率和平滑系数

Parameters

interval	时间间隔，单位毫秒，最小值不得小于10ms, 建议设置300-500ms, <= 0表示不启用音量提示和说话人提示功能
smooth	平滑系数，数值越大平滑程度越高，反之越低，实时性越好，建议设置3，范围[0, 9];
reportVad	说话人检测开关 1: 打开本地人声检测 0: 关闭本地人声检测

Returns

0: 成功
<0: 失败

Note: 设置之后，音频音量和说话人uid会分别通过 onMicrophoneVolumeUpdate: 和 onPlayoutVolumeUpdate: 回调

◆ enableSpeakerphone:

- (int) enableSpeakerphone: (BOOL) enable

设置音频输出为听筒还是扬声器

Parameters

enable

YES: 扬声器模式(默认)
NO: 听筒模式

Returns

0: 成功
<0: 失败

◆ focusCameraAtAdjustedPoint:autoFocus:

- (int) focusCameraAtAdjustedPoint:	(CGPoint)	point
autoFocus:	(bool)	autoFocus

对焦

Parameters

point	对焦的点，point.x和point.y的取值是(0,1)，表示当前点相对于渲染view的相对位置
autoFocus	是否自动对焦

Returns: 0:success 非0:failure

◆ getCurrentExposure

- (float) getCurrentExposure

获取当前曝光度

Returns: 曝光度

◆ getCurrentZoom

- (float) getCurrentZoom

获取当前变焦值

Returns: 当前变焦值

◆ getLivePushStatusInfo

- (AlivcLivePushStatsInfo *) getLivePushStatusInfo

获取推流数据统计

Returns: 推流数据 AlivcLivePushStatsInfo

◆ getLiveStatus

- (AlivcLivePushStatus) getLiveStatus

获取当前推流状态

Returns: 推流状态 AlivcLivePushStatus

◆ getMaxZoom

- (float) getMaxZoom

获取支持的最大变焦值

Returns: 最大变焦值

◆ getPushURL

- (NSString *) getPushURL

获取当前推流URL

Returns: 推流URL

◆ getSupportedMaxExposure

- (float) getSupportedMaxExposure

获取支持最大曝光度

Returns: 最大曝光度

◆ getSupportedMinExposure

- (float) getSupportedMinExposure

获取支持最小曝光度

Returns: 最小曝光度

◆ getVideoCodecType

- (AlivcLivePushVideoEncoderModeHardCodec) getVideoCodecType

获取当前视频编码格式

Returns

AlivcLivePushVideoEncoderModeHardCodecH264: H264
AlivcLivePushVideoEncoderModeHardCodecHEVC: HEVC

◆ hideDebugView

+ (void) hideDebugView

隐藏调试悬浮窗

◆ initWithConfig:

- (instancetype) initWithConfig: (AlivcLivePushConfig *) config

创建一个推流引擎实例

Parameters

config 推流配置信息 AlivcLivePushConfig

Returns: self:success nil:failure

Note: 同一时间只会存在一个主推流引擎实例

◆ inputMixAudioData:data:size:pts:

- (bool) inputMixAudioData:	(int)	handler
data:	(long)	dataptr
size:	(int)	size
pts:	(long)	pts

输入音频混流数据

Parameters

handler	音频混流标识ID，通过addMixAudio接口获得
dataptr	数据buffer的地址
size	音频数据的大小
pts	时间戳（单位微秒）

Returns: success:true, failed:false

Note: 注：当前SDK暂时只支持在livePushMode = AlivcLivePushBasicMode 模式下输入音频混流数据，AlivcLivePushInteractiveMode模式下暂时不支持输入音频混流数据

◆ inputMixVideoData:data:width:height:stride:size:pts:rotation:

- (void) inputMixVideoData:	(int)	handler
data:	(long)	dataptr
width:	(int)	width
height:	(int)	height
stride:	(int)	stride
size:	(int)	size
pts:	(long)	pts
rotation:	(int)	rotation

输入视频混流数据

Parameters

handler	视频混流标识ID，通过addMixVideo接口获得
dataptr	数据buffer的地址
width	图像宽
height	图像高
stride	图像存储时内存中每行像素所占用的空间
size	此帧图像的大小
pts	时间戳（单位微秒）
rotation	图像角度

Note: 注：当前SDK暂时只支持在livePushMode = AlivcLivePushBasicMode 模式下输入视频混流数据，AlivcLivePushInteractiveMode模式下暂时不支持输入视频混流数据

◆ isCameraAutoFocusFaceModeSupported

- (BOOL) isCameraAutoFocusFaceModeSupported

摄像头是否支持人脸聚焦

Returns

YES: 支持
NO: 不支持

Note: 在camera没有打开的情况下返回 NO，在camera打开的情况下，如果当前camera同时支持人脸识别和对焦功能则返回 YES

◆ isEnableSpeakerphone

- (BOOL) isEnableSpeakerphone

获取当前音频输出为听筒还是扬声器

Returns

YES: 扬声器模式；
NO: 听筒模式

◆ isPushing

- (BOOL) isPushing

获取是否正在推流

Returns: YES:正在推流 NO:未推流

◆ muteLocalCamera:

- (int) muteLocalCamera: (BOOL) mute

关闭/打开视频（非互动模式暂不支持该API，调用无任何效果）

Parameters

mute	YES表示不发送视频数据；NO表示恢复正常

Returns

0: 表示Success
非0: 表示Failure

◆ pause

- (int) pause

暂停摄像头推流，如果pushCongfig 中设置了pauseImg图片，将推设置的静态图片

Returns: 0:success 非0:failure

◆ pauseBGM

- (int) pauseBGM

暂停播放背景音乐

Returns: 0:success 非0:failure

◆ reconnectPushAsync

- (int) reconnectPushAsync

重连异步接口

Returns: 0:success 非0:failure

◆ reconnectPushAsync:

- (int) reconnectPushAsync: (NSString *) pushURL

推流URL的重连异步接口

Returns: 0:success 非0:failure

◆ refreshPushURLToken:

- (int) refreshPushURLToken: (NSString *_Nonnull) pushUrl

刷新Token鉴权信息，传入一个新的推流URL，包含未过期的新token信息，房间ID/用户ID/sdkAppId需要和之前保持一样

该方法用于更新鉴权信息推流URL中的token信息，主要为了防止鉴权过期，导致推流失败，当我们收到 onPushURLTokenWillExpire 回调时，应用应当更新鉴权信息

Parameters

pushURL 推流URL

Returns

0: 成功
<0: 失败

◆ removeDynamicWaterMark:

- (void) removeDynamicWaterMark: (int) vid

删除动态贴纸

Parameters

vid:贴纸id，addDynamicWaterMarkImageDataWithPath时返回

◆ removeMixAudio:

- (void) removeMixAudio: (int) handler

移除音频混流

Parameters

handler 音频混流标识ID，通过addMixAudio接口获得

Note: 注：当前SDK暂时只支持在livePushMode = AlivcLivePushBasicMode 模式下移除音频混流，AlivcLivePushInteractiveMode模式下暂时不支持移除音频混流

◆ removeMixVideo:

- (void) removeMixVideo: (int) handler

移除视频混流设置

Parameters

handler 视频混流标识ID，通过addMixVideo接口获得

◆ restartPush

- (int) restartPush

重新推流同步接口

Returns: 0:success 非0:failure

◆ restartPushAsync

- (int) restartPushAsync

重新推流异步接口

Returns: 0:success 非0:failure

◆ resume

- (int) resume

恢复摄像头推流同步接口

Returns: 0:success 非0:failure

◆ resumeAsync

- (int) resumeAsync

恢复推流异步接口

Returns: 0:success 非0:failure

◆ resumeBGM

- (int) resumeBGM

恢复播放背景音乐

Returns: 0:success 非0:failure

◆ sendAudioSampleBuffer:withType:

- (void) sendAudioSampleBuffer:	(CMSampleBufferRef)	sampleBuffer
withType:	(RPSampleBufferType)	sampleBufferType

发送自定义的audio SampleBuffer

只限于replaykit录屏直播使用

Parameters

sampleBuffer	audio sample buffer
sampleBufferType	audio sample buffer type

Note: 注：当前SDK暂时只支持在livePushMode = AlivcLivePushBasicMode 模式下发送自定义的audio SampleBuffer，AlivcLivePushInteractiveMode模式下暂时不支持发送自定义的audio SampleBuffer

◆ sendMessage:repeatCount:delayTime:KeyFrameOnly:

- (int) sendMessage:	(NSString *)	msg
repeatCount:	(int)	count
delayTime:	(int)	time
KeyFrameOnly:	(bool)	isKeyFrame

设置自定义Message (SEI)

Parameters

msg	用户推流消息
count	重复次数
time	延时时间，单位毫秒
isKeyFrame	是否只发关键帧，该参数只支持在livePushMode = AlivcLivePushBasicMode 模式下设置，AlivcLivePushInteractiveMode模式下暂时不支持设置

Returns: 0:success 非0:failure

◆ sendPCMData:size:sampleRate:channel:pts:

- (void) sendPCMData:	(char *)	data
size:	(int)	size
sampleRate:	(int)	sampleRate
channel:	(int)	channel
pts:	(uint64_t)	pts

发送自定义音频数据

Parameters

data	音频数据
size	数据大小
sampleRate	采样率
channel	声道数
pts	时间戳（单位微秒）

◆ sendVideoData:width:height:size:pts:rotation:

- (void) sendVideoData:	(char *)	data
width:	(int)	width
height:	(int)	height
size:	(int)	size
pts:	(uint64_t)	pts
rotation:	(int)	rotation

发送自定义视频数据

Parameters

data	视频数据
width	视频宽度
height	视频高度
size	数据大小
pts	时间戳（单位微秒）
rotation	旋转

◆ sendVideoSampleBuffer:

- (void) sendVideoSampleBuffer: (CMSampleBufferRef) sampleBuffer

发送自定义video SampleBuffer

Parameters

sampleBuffer video sample buffer

Note: 当前SDK暂时只支持在livePushMode = AlivcLivePushBasicMode 模式下发送自定义video SampleBuffer，AlivcLivePushInteractiveMode模式下暂时不支持发送自定义video SampleBuffer

◆ setAudioDenoise:

- (int) setAudioDenoise: (bool) isOpen

设置降噪开关

Parameters

isOpen 是否打开降噪 true:开启 false:关闭默认:true

Returns: 0:success 非0:failure

◆ setAudioEffectReverbMode:

- (int) setAudioEffectReverbMode: (AlivcLivePushAudioEffectReverbMode) mode

设置混响音效模式

Parameters

mode	参考 AlivcLivePushAudioEffectReverbMode 对应的混响模式

Returns

0：成功
非0：失败

Note: 推流前和推流过程中调用都生效

◆ setAudioEffectVoiceChangeMode:

- (int) setAudioEffectVoiceChangeMode: (AlivcLivePushAudioEffectVoiceChangeMode) mode

设置变声音效模式

Parameters

mode	参考 AlivcLivePushAudioEffectVoiceChangerMode 对应的变声音效模式值

Returns

0：成功
非0：失败

Note: 推流前和推流过程中调用都生效

◆ setAudioProfile:

- (int) setAudioProfile: (AlivcLiveAudioProfile) audio_profile

设置音频profile

Parameters

audio_profile 音频采集/编码模式参数, 详见 AlivcLiveAudioProfile;

Returns

0: 成功
其他: 失败

Note: 只支持 startPushWithURL 前设置有效；

◆ setAudioSampleDelegate:

- (void) setAudioSampleDelegate: (id< AlivcLivePusherAudioSampleDelegate >) delegate

设置音频裸数据回调

Parameters

delegate AlivcLivePusherAudioSampleDelegate

◆ setAutoFocus:

- (int) setAutoFocus: (bool) autoFocus

设置自动对焦

Parameters

autoFocus true:自动对焦 false:手动对焦

Returns: 0:success 非0:failure

◆ setBGMDelegate:

- (void) setBGMDelegate: (id< AlivcLivePusherBGMDelegate >) delegate

设置背景音乐监听回调

Parameters

delegate AlivcLivePusherBGMDelegate

◆ setBGMEarsBack:

- (int) setBGMEarsBack: (bool) isOpen

设置背景音乐耳返开关

Parameters

isOpen 是否打开耳返 true:开启耳返 false:关闭耳返

Returns: 0:success 非0:failure

◆ setBGMLoop:

- (int) setBGMLoop: (bool) isLoop

设置背景音乐是否循环播放

Parameters

isLoop 是否循环 true:循环 false:不循环

Returns: 0:success 非0:failure

◆ setBGMVolume:

- (int) setBGMVolume: (int) volume

设置背景音乐混音音乐音量

Parameters

volume 音乐音量大小范围:[0 ~ 100] 默认:50

Returns: 0:success 非0:failure

◆ setCameraAutoFocusFaceModeEnabled:

- (BOOL) setCameraAutoFocusFaceModeEnabled: (BOOL) enable

设置摄像头人脸对焦

Parameters

enable YES: 开启; NO:关闭

Returns

YES: 成功
NO: 失败

Note: 如果 isCameraAutoFocusFaceModeSupported 返回 YES 且此调用enable为 YES 的情况下，实时对焦到采集到数据的人脸上

◆ setCaptureVolume:

- (int) setCaptureVolume: (int) volume

设置背景音乐混音人声音量

Parameters

volume 人声音量大小范围:[0 ~ 100] 默认:50

Returns: 0:success 非0:failure

◆ setCustomDetectorDelegate:

- (void) setCustomDetectorDelegate: (id< AlivcLivePusherCustomDetectorDelegate >) delegate

设置用户自定义人脸识别回调

Parameters

delegate AlivcLivePusherCustomDetectorDelegate

◆ setCustomFilterDelegate:

- (void) setCustomFilterDelegate: (id< AlivcLivePusherCustomFilterDelegate >) delegate

设置用户自定义滤镜回调

Parameters

delegate AlivcLivePusherCustomFilterDelegate

◆ setErrorDelegate:

- (void) setErrorDelegate: (id< AlivcLivePusherErrorDelegate >) delegate

设置推流错误监听回调

Parameters

delegate AlivcLivePusherErrorDelegate

◆ setExposure:

- (int) setExposure: (float) exposure

设置曝光度

Parameters

exposure 曝光度

Returns: 0:success 非0:failure

◆ setFlash:

- (int) setFlash: (bool) flash

闪光灯开关

Parameters

flash true:打开闪光灯 false:关闭闪光灯

Returns: 0:success 非0:failure

◆ setInfoDelegate:

- (void) setInfoDelegate: (id< AlivcLivePusherInfoDelegate >) delegate

设置推流状态监听回调

Parameters

delegate AlivcLivePusherInfoDelegate

◆ setLiveMixTranscodingConfig:

- (int) setLiveMixTranscodingConfig: (AlivcLiveTranscodingConfig *) config

设置云端的混流（转码）参数一个直播间中可能有不止一位主播，而且每个主播都有自己的画面和声音，但对于 CDN 观众来说，他们只需要一路直播流所以您需要将多路音视频流混成一路标准的直播流，这就需要混流转码在连麦场景下，需要将主播和连麦观众音视频流混成一路标准的直播流，供CDN观众观看在PK场景下，需要将进行PK的多个主播的音视频流混成一路标准的直播流，供CDN观众观看

Parameters

config 参考AlivcLiveDef.h中关于AlivcLiveTranscodingConfig的介绍，如果传入nil，则取消云端混流转码

Returns: 0:success 非0:failure

Note: 若主播还在房间中但不再需要混流，请务必传入 nil 进行取消，因为当发起混流后，云端混流模块就会开始工作，不及时取消混流可能会引起不必要的计费损失

◆ setLogLevel:

- (int) setLogLevel: ("Use AlivcLiveBase->setLogLevel instead.") __deprecated_msg

设置Log级别

Parameters

level Log级别 default:AlivcLivePushLogLevelError

Returns: 0:success 非0:failure

◆ setLogPath:maxPartFileSizeInKB:

- (int) setLogPath:	(NSString *)	logPath
maxPartFileSizeInKB:	("Use AlivcLiveBase->setLogPath:maxPartFileSizeInKB instead.")	__deprecated_msg

设置Log路径

Parameters

logPath	Log路径
maxPartFileSizeInKB	每个分片最大大小。最终日志总体积是 5*最大分片大小

Returns: 0:success 非0:failure

◆ setMinVideoBitrate:

- (int) setMinVideoBitrate: (int) minBitrate

设置最小码率

Parameters

minBitrate 最小码率 [100 5000](Kbps)

Returns: 0:success 非0:failure

◆ setMixVideoMirror:isMirror:

- (void) setMixVideoMirror:	(int)	handler
isMirror:	(BOOL)	isMirror

改变视频混流镜像

Parameters

handler	视频混流标识ID，通过addMixVideo接口获得
isMirror	是否镜像

Note: 注：当前SDK暂时只支持在livePushMode = AlivcLivePushBasicMode 模式下改变视频混流镜像，AlivcLivePushInteractiveMode模式下暂时不支持改变视频混流镜像

◆ setMute:

- (void) setMute: (bool) mute

静音推流

Parameters

mute	true:静音推流 false:正常推流

◆ setNetworkDelegate:

- (void) setNetworkDelegate: (id< AlivcLivePusherNetworkDelegate >) delegate

设置推流网络监听回调

Parameters

delegate AlivcLivePusherNetworkDelegate

◆ setpreviewDisplayMode:

- (void) setpreviewDisplayMode: (AlivcPusherPreviewDisplayMode) displayMode

设置预览显示模式

Parameters

displayMode 预览显示模式

◆ setPreviewMirror:

- (void) setPreviewMirror: (bool) mirror

预览镜像开关

Parameters

mirror true:打开预览镜像 false:关闭预览镜像

◆ setPushMirror:

- (void) setPushMirror: (bool) mirror

推流镜像开关

Parameters

mirror true:打开推流镜像 false:关闭推流镜像

◆ setQualityMode:

- (int) setQualityMode: (AlivcLivePushQualityMode) qualityMode

设置推流模式

Parameters

qualityMode 推流模式 : 选择 ResolutionFirst 模式时，SDK内部会优先保障推流视频的清晰度; 选择 FluencyFirst 模式时，SDK内部会优先保障推流视频的流畅度，此接口只支持这两种模式。设置后码率设置失效。

Returns: 0:success 非0:failure

◆ setResolution:

- (void) setResolution: (AlivcLivePushResolution) resolution

设置推流分辨率

Parameters

resolution 推流分辨率

◆ setSnapshotDelegate:

- (void) setSnapshotDelegate: (id< AlivcLivePusherSnapshotDelegate >) delegate

设置截图回调

Parameters

delegate AlivcLivePusherSnapshotDelegate

◆ setTargetVideoBitrate:

- (int) setTargetVideoBitrate: (int) targetBitrate

设置目标码率

Parameters

targetBitrate 目标码率 [100 5000](Kbps)

Returns: 0:success 非0:failure

◆ setWatermark:rect:

- (void) setWatermark:	(nullable UIImage *)	image
rect:	(CGRect)	rect

添加水印(互动模式下使用该接口添加水印)

Note: 水印位置是通过 rect 参数来指定，rect 是一个四元组参数，其格式为 (x，y，width，height)，其中x和y是水印的坐标，取值范围为0 1的浮点数。width：水印的宽度，取值范围为0 - 1的浮点数，height：不需要设置的，SDK 内部会根据水印图片的宽高比自动计算高度。例如：当推流分辨率是 720 × 1280时，rect 参数为（0.1，0.1，0.3，0.0），则水印的左上角坐标点就是（720 × 0.1，1280 × 0.1）即（72，128），水印的宽度是720x0.3=216，水印高度是根据水印图片的宽高比自动算出来。

Parameters

image	水印图片，使用透明底色的 png 格式。
rect	水印相对于推流分辨率的相对坐标，x，y，width，height 取值范围0 - 1。

◆ setWatermarkVisible:

- (void) setWatermarkVisible: (bool) visable

设置水印显示和隐藏

Parameters

visable true:显示水印，false:隐藏水印

◆ setZoom:

- (int) setZoom: (float) zoom

缩放

Parameters

zoom	缩放值[0:MaxZoom]

Returns: 0:success 非0:failure

◆ showDebugView

+ (void) showDebugView

显示调试悬浮窗

Note: 注意：Debug悬浮窗会占用一定的系统资源，只可用于APP研发的Debug阶段，Release版本请勿调用此接口

◆ snapshot:interval:

- (void) snapshot:	(int)	count
interval:	(int)	interval

截图

Parameters

count截图次数
interval	截图间隔

Note: livePushMode = AlivcLivePushBasicMode 基础模式下可以指定count和interval， AlivcLivePushInteractiveMode模式下暂时不支持指定count和interval，传递任何值都不做解析，每次只截图一张画面

◆ startBGMWithMusicPathAsync:

- (int) startBGMWithMusicPathAsync: (NSString *) path

播放背景音乐

Parameters

path 背景音乐路径

Returns: 0:success 非0:failure

◆ startIntelligentDenoise

- (int) startIntelligentDenoise

开启智能降噪

Returns

0: 成功
非0: 返回错误码

智能降噪功能以插件形式提供，直播SDK采用插件形式提供音视频增强能力，可通过[官网组件文档] 进行组建下载，参考插件集成文档集成进直播推流引擎 https://help.aliyun.com/document_detail/600551.html
调用该接口前，请确保已集成了直播官网提供的pulginAliDenoise.framework
此接口可以通话过程中控制打开智能降噪功能，通话过程中可以支持开启和关闭智能降噪
默认关闭，开启后可能导致功耗增加，智能降噪适合于会议，教育等语音通讯为主的场景，不适合有背景音乐的场景

◆ startPreview:

- (int) startPreview: (UIView *) previewView

开始预览同步接口

Parameters

previewView 预览view

Returns: 0:success 非0:failure

◆ startPreviewAsync:

- (int) startPreviewAsync: (UIView *) preview

开始预览异步接口

Parameters

preview 预览view

Returns: 0:success 非0:failure

◆ startPushWithURL:

- (int) startPushWithURL: (NSString *) pushURL

开始推流同步接口

Parameters

pushURL 推流URL

Returns: 0:success 非0:failure

◆ startPushWithURLAsync:

- (int) startPushWithURLAsync: (NSString *) pushURL

开始推流异步接口

Parameters

pushURL 推流URL

Returns: 0:success 非0:failure

◆ startRecording:

- (BOOL) startRecording: (AlivcLiveLocalRecoderConfig *_Nullable) config

开启本地音视频流录制

Note: 开启后把直播中的音视频内容录制到本地的一个文件。调用接口后，通过onMediaRecordEvent回调通知录制状态

Parameters

config 本地录制参数，参见AlivcLiveLocalRecoderConfig

◆ startScreenCapture:

- (int) startScreenCapture: (NSString *) appGroup

开始屏幕分享（该接口支持 iOS 11.0 及以上的 iPhone 和 iPad）。

该接口开始 iOS 系统的屏幕分享，可以实现录屏推流功能该接口配合AlivcLibReplayKitExt.framework使用，在Extension进程中添加AlivcLibReplayKitExt.framework库完成屏幕采集和发送在Host APP中接收音视频数据，完成推流。

Parameters

appGroup App group ID 主 App 与 Extension 共享的 Application Group Identifier，当前接口仅支持主 App 与 Extension 属于同一个App * Group的情况，如果不存在App Group，不可调用该接口。

Note: 注：当前SDK暂时只支持在livePushMode = AlivcLivePushBasicMode 模式下开始屏幕分享（录屏推流），AlivcLivePushInteractiveMode模式下暂时不支持开始屏幕分享（录屏推流）

◆ startScreenShare

- (int) startScreenShare

启动屏幕分享

Returns

0：成功
非0：失败

◆ stopBGMAsync

- (int) stopBGMAsync

停止播放背景音乐

Returns: 0:success 非0:failure

◆ stopIntelligentDenoise

- (int) stopIntelligentDenoise

关闭智能降噪

Note: 此接口可以通话过程中控制关闭智能降噪功能

◆ stopPreview

- (int) stopPreview

停止预览

Returns: 0:success 非0:failure

◆ stopPush

- (int) stopPush

停止推流

Returns: 0:success 非0:failure

◆ stopRecording

- (void) stopRecording

停止本地音视频流录制

Note: 如果录制任务在结束推流前尚未通过本接口停止，则结束推流后录制任务会自动被停止。

◆ stopScreenShare

- (int) stopScreenShare

停止屏幕分享

Returns

0：成功
非0：失败

◆ switchCamera

- (int) switchCamera

切换摄像头

Returns: 0:success 非0:failure

The documentation for this class was generated from the following file:

AlivcLivePusher.h

Instance Methods

Class Methods

Method Documentation

◆ __deprecated_msg

◆ addDynamicWaterMarkImageDataWithPath:x:y:w:h:

◆ addMixAudio:format:audioSample:

◆ addMixVideo:width:height:rotation:displayX:displayY:displayW:displayH:adjustHeight:

◆ addWatermarkWithPath:watermarkCoordX:watermarkCoordY:watermarkWidth:

◆ changeMixVideoPosition:displayX:displayY:displayW:displayH:

◆ destory

◆ enableAudioVolumeIndication:smooth:reportVad:

◆ enableSpeakerphone:

◆ focusCameraAtAdjustedPoint:autoFocus:

◆ getCurrentExposure

◆ getCurrentZoom

◆ getLivePushStatusInfo

◆ getLiveStatus

◆ getMaxZoom

◆ getPushURL

◆ getSupportedMaxExposure

◆ getSupportedMinExposure

◆ getVideoCodecType

◆ hideDebugView

◆ initWithConfig:

◆ inputMixAudioData:data:size:pts:

◆ inputMixVideoData:data:width:height:stride:size:pts:rotation:

◆ isCameraAutoFocusFaceModeSupported

◆ isEnableSpeakerphone

◆ isPushing

◆ muteLocalCamera:

◆ pause

◆ pauseBGM

◆ reconnectPushAsync

◆ reconnectPushAsync:

◆ refreshPushURLToken:

◆ removeDynamicWaterMark:

◆ removeMixAudio:

◆ removeMixVideo:

◆ restartPush

◆ restartPushAsync

◆ resume

◆ resumeAsync

◆ resumeBGM

◆ sendAudioSampleBuffer:withType:

◆ sendMessage:repeatCount:delayTime:KeyFrameOnly:

◆ sendPCMData:size:sampleRate:channel:pts:

◆ sendVideoData:width:height:size:pts:rotation:

◆ sendVideoSampleBuffer:

◆ setAudioDenoise:

◆ setAudioEffectReverbMode:

◆ setAudioEffectVoiceChangeMode:

◆ setAudioProfile:

◆ setAudioSampleDelegate:

◆ setAutoFocus:

◆ setBGMDelegate:

◆ setBGMEarsBack:

◆ setBGMLoop:

◆ setBGMVolume:

◆ setCameraAutoFocusFaceModeEnabled:

◆ setCaptureVolume:

◆ setCustomDetectorDelegate:

◆ setCustomFilterDelegate:

◆ setErrorDelegate:

◆ setExposure:

◆ setFlash:

◆ setInfoDelegate:

◆ setLiveMixTranscodingConfig:

◆ setLogLevel:

◆ setLogPath:maxPartFileSizeInKB:

◆ setMinVideoBitrate:

◆ setMixVideoMirror:isMirror:

◆ setMute:

◆ setNetworkDelegate:

◆ setpreviewDisplayMode:

◆ setPreviewMirror:

◆ setPushMirror:

◆ setQualityMode:

◆ setResolution:

◆ setSnapshotDelegate:

◆ setTargetVideoBitrate: