@interface VeLiveFileRecorderManager : NSObject

直播录制管理对象。

成员函数 #

函数说明 #

startRecord:config: #

- (void)startRecord:(NSString *)path config:(VeLiveFileRecorderConfiguration *)config;

开始直播录制。

传入参数

注意

• 请在调用 startPush: 推流成功之后，调用该方法，直播过程中的音视频数据将保存到本地；
• 本方法为异步操作；
• 开始录制后，会触发 onFileRecordingStarted 回调消息；
• 录制出现错误，会触发 onFileRecordingError:message: 回调消息。
  

stopRecord #

- (void)stopRecord;

停止本地直播录制。

注意

• 请在调用 startRecord:config: 成功开始录制之后，调用该方法；
• 本方法为异步操作；
• 停止录制，会触发 onFileRecordingStopped 回调消息；
• 录制出现错误，会触发 onFileRecordingError:message: 回调消息。
  

@interface VeLiveCameraDevice : NSObject

相机设备管理对象。

成员函数 #

函数说明 #

isTorchSupported #

- (BOOL)isTorchSupported;

是否支持闪光灯。

返回值

• YES：支持；
• NO：不支持。

注意

需要在调用 startVideoCapture: 启动相机采集后，调用本方法。

enableTorch: #

- (int)enableTorch:(BOOL)enable;

开启/关闭闪光灯。

传入参数

返回值

• =0：开启/关闭成功；
• ≠0：开启/关闭失败。

注意

需要在调用 startVideoCapture: 启动相机采集后，调用本方法。

setZoomRatio: #

- (int)setZoomRatio:(float)ratio;

设置摄像头的缩放倍数。

传入参数

返回值

• =0：缩放成功；
• ≠0：缩放失败。

注意

需要在调用 startVideoCapture: 启动相机采集后，调用本方法。

getCurrentZoomRatio #

- (float)getCurrentZoomRatio;

获取摄像头当前的缩放倍数。

返回值

• ≤0：表示不支持缩放；
• >0：支持缩放，数值表示当前缩放倍数。

注意

需要在调用 startVideoCapture: 启动相机采集后，调用本方法。

getMaxZoomRatio #

- (float)getMaxZoomRatio;

获取摄像头的最大缩放倍数。

返回值

• ≤0：表示不支持缩放；
• >0：支持缩放，数值表示最大缩放倍数。

注意

需要在调用 startVideoCapture: 启动相机采集后，调用本方法。

getMinZoomRatio #

- (float)getMinZoomRatio;

获取摄像头的最小缩放倍数。

返回值

• ≤0：表示不支持缩放；
• >0：支持缩放，数值表示最小缩放倍数。

注意

需要在调用 startVideoCapture: 启动相机采集后，调用本方法。

isAutoFocusEnabled #

- (BOOL)isAutoFocusEnabled;

是否支持自动对焦。

返回值

• YES：支持；
• NO：不支持。

注意

需要在调用 startVideoCapture: 启动相机采集后，调用本方法。

enableAutoFocus: #

- (int)enableAutoFocus:(BOOL)enable;

开启/关闭自动对焦功能。

传入参数

返回值

• =0：开启/关闭成功；
• ≠0：开启/关闭失败。

注意

需要在调用 startVideoCapture: 启动相机采集后，调用本方法。

setFocusPosition: #

- (int)setFocusPosition:(CGPoint)position;

设置摄像头的对焦位置。

传入参数

返回值

• =0：设置成功；
• ≠0：设置失败。

注意

需要在调用 startVideoCapture: 启动相机采集后，调用本方法。

isAutoExposureEnabled #

- (BOOL)isAutoExposureEnabled;

检查当前摄像头是否支持自动曝光功能。

返回值

• YES：支持。
• NO：不支持。

注意

在调用 startVideoCapture: 启动视频采集后，调用该方法。

enableAutoExposure: #

- (int)enableAutoExposure:(BOOL)enable;

开启或关闭自动曝光功能。

传入参数

返回值

• 0: 成功。
• ≠0: 失败。

注意

在调用 startVideoCapture: 启动视频采集后，调用该方法。

isExposurePositionSupported #

- (BOOL)isExposurePositionSupported;

检查当前使用的摄像头是否支持手动设置曝光点。

返回值

• YES: 支持。

• NO: 不支持。

注意

必须已调用 startVideoCapture: 使用 SDK 内部采集模块进行视频采集时，才能检查曝光点设置能力。

setExposurePosition: #

- (int)setExposurePosition:(CGPoint)position;

设置当前使用的摄像头的曝光点。

传入参数

返回值

• =0: 成功。
• ≠0: 失败。

注意

• 必须已调用 startVideoCapture: 使用 SDK 内部采集模块进行视频采集，并且使用 SDK 内部渲染时，才能设置曝光点。
• 曝光点设置为画布中央（即x和y均取 0.5）时，恢复系统默认值。
• 调用 stopVideoCapture: 关闭内部采集后，设置的曝光点失效。
  

setExposureCompensation: #

- (int)setExposureCompensation:(float)value;

设置当前使用的摄像头的曝光补偿。

传入参数

返回值

• =0：设置成功；
• ≠0：设置失败。

注意

• 必须已调用 startVideoCapture: 使用 SDK 内部采集模块进行视频采集时，才能设置曝光补偿。
• 调用 stopVideoCapture: 关闭内部采集后，设置的曝光补偿失效。
  

getMinExposureCompensation #

- (float)getMinExposureCompensation;

获取摄像头的最小曝光补偿。

返回值

• ≤0：表示不支持曝光补偿；
• >0：支持曝光补偿，数值表示最小曝光补偿。

注意

需要在调用 startVideoCapture: 启动相机采集后，调用本方法。

getMaxExposureCompensation #

- (float)getMaxExposureCompensation;

获取摄像头的最大曝光补偿。

返回值

• ≤0：表示不支持曝光补偿；
• >0：支持曝光补偿，数值表示最大曝光补偿。

注意

需要在调用 startVideoCapture: 启动相机采集后，调用本方法。

getCurrentExposureCompensation #

- (float)getCurrentExposureCompensation;

获取当前摄像头的曝光补偿。

返回值

当前摄像头的曝光补偿。0 代表无曝光补偿。取值范围为 [getMinExposureCompensation,getMaxExposureCompensation]。

注意

在调用 startVideoCapture: 启动视频采集后，调用该方法。

@interface VeLiveMediaPlayer : NSObject

媒体播放器对象。

成员函数 #

函数说明 #

prepare: #

- (int)prepare:(NSString *)url;

设置文件路径。支持的文件格式包括 MP3、AAC、M4A、WAV。

传入参数

返回值

• 0：成功；
• ≠0：失败。
  

destroy #

- (void)destroy;

销毁播放器实例。

setListener: #

- (void)setListener:(nullable id <VeLiveMediaPlayerListener>)listener;

设置播放状态的监听。

传入参数

注意

重复调用本方法，仅最后一次调用生效。

setFrameListener: #

- (void)setFrameListener:(nullable id <VeLiveMediaPlayerFrameListener>)listener;

设置音视频帧回调的监听。

传入参数

注意

重复调用本方法，仅最后一次调用生效。

enableMixer: #

- (void)enableMixer:(BOOL)enable;

开启/关闭音频是否混音到直播流。

传入参数

enableAutoEq:targetLufs: #

- (void)enableAutoEq:(float)sourceLufs targetLufs:(float)targetLufs;

开启/关闭自动音量均衡。

传入参数

setRenderView: #

- (void)setRenderView:(UIView *)view;

支持 MP4 格式的视频渲染。

传入参数

enableBGMLoop: #

- (void)enableBGMLoop:(BOOL)enable;

设置是否循环播放。

传入参数

start #

- (int)start;

开始播放。

返回值

• 0：成功；
• ≠0：失败。

注意

• 需要在调用 prepare: 设置文件路径后，调用本方法；
• 此方法为异步操作。当 SDK 收到开始播放 onStart 的回调后，开始播放。
  

stop #

- (int)stop;

停止播放。

返回值

• 0：成功；
• ≠0：失败。

注意

需要在调用 start 开始播放后，调用本方法。

pause #

- (void)pause;

暂停播放。

注意

需要在调用 start 开始播放后，调用本方法。

resume #

- (void)resume;

恢复播放。

注意

需要在调用 pause 暂停播放后，调用本方法。

seek: #

- (int)seek:(long)pos;

设置播放进度。

传入参数

返回值

• 0：成功；
• ≠0：失败。
  

getDuration #

- (long)getDuration;

获取文件的总时长，单位为 ms。

返回值

• >0：成功，音频文件时长；
• ≤0：失败。

注意

需要在调用 start 开始播放后，调用本方法。

setBGMVolume: #

- (void)setBGMVolume:(float)volume;

设置播放音频的音量。

传入参数

setVoiceVolume: #

- (void)setVoiceVolume:(float)volume;

设置音频采集音量。

传入参数

注意

需要在调用 start 开始播放背景音乐后，调用本方法。

@interface VeLiveAudioDevice : NSObject

音频设备管理类。该类提供了用于管理和控制音频设备，包括设置音量、获取当前音量、检查硬件耳返支持情况、开启或关闭耳返的方法。

成员函数 #

函数说明 #

setVoiceLoudness: #

- (void)setVoiceLoudness:(float)level;

设置音量响度。

传入参数

getVoiceLoudness #

- (float)getVoiceLoudness;

获取当前音量响度。

返回值

当前音量响度等级。

isSupportHardwareEcho #

- (BOOL)isSupportHardwareEcho;

查询是否支持硬件耳返。

返回值

• YES：支持；
• NO：不支持。
  

enableEcho: #

- (void)enableEcho:(BOOL)enable;

是否开启耳返功能。

传入参数

注意

需要在调用 startAudioCapture: 启动音频采集后，调用本方法。

isEnableEcho #

- (BOOL)isEnableEcho;

获取当前耳返开启状态。

返回值

• YES：开启；
• NO：关闭。

注意

需要在调用 startAudioCapture: 启动音频采集后，调用本方法。

@interface VeLiveMixerManager : NSObject

音视频混流器管理对象。支持添加/移除音视频流、发送自定义音视频帧、更新混流布局等。

成员函数 #

函数说明 #

addVideoStream #

- (int)addVideoStream;

添加一路需要混流的视频流到混流器中。

返回值

视频流 ID。

removeVideoStream: #

- (void)removeVideoStream:(int)streamId;

从混流器中移除一路非主路的视频流。

传入参数

addAudioStream #

- (int)addAudioStream;

添加一路音频流到混流器中。

返回值

音频流 ID。

addAudioStream: #

- (int)addAudioStream:(VeLiveAudioMixType)type;

添加一路音频流到混流器中，并指定混流类型。

传入参数

返回值

音频流 ID。

removeAudioStream: #

- (void)removeAudioStream:(int)streamId;

从混流器中移除一路非主路的音频流。

传入参数

setAudioStream:volume: #

- (void)setAudioStream:(int)streamId volume:(float)volume;

设置指定混流音频的音量。当你将 VeLiveAudioMixType 设置为 VeLiveAudioMixPlayAndPush 时，该方法同时控制该路音频在拉流端和本地的播放音量。

传入参数

getOriginVideoStream #

- (int)getOriginVideoStream;

获取主路视频流 ID。

getOriginAudioStream #

- (int)getOriginAudioStream;

获取主路音频流 ID。

getAppAudioStream #

- (int)getAppAudioStream;

获取屏幕推流 App 的音频流 ID。

sendCustomVideoFrame:streamId: #

- (void)sendCustomVideoFrame:(VeLiveVideoFrame *)frame streamId:(int)streamId;

发送指定混流 ID 的自定义视频帧数据。

传入参数

sendCustomAudioFrame:streamId: #

- (void)sendCustomAudioFrame:(VeLiveAudioFrame *)frame streamId:(int)streamId;

发送指定混流 ID 的自定义音频帧数据。

传入参数

updateStreamMixDescription: #

- (void)updateStreamMixDescription:(VeLiveStreamMixDescription *)mixDescription;

更新音视频混流的布局。

传入参数

@interface VeLivePusher (ScreenCapture)

推流引擎类。

成员函数 #

函数说明 #

startScreenCapture: #

- (void)startScreenCapture:(NSString *)applicationGroupIdentifier;

开启屏幕采集。

传入参数

stopScreenCapture #

- (void)stopScreenCapture;

停止屏幕采集。

注意

该方法用于结束当前屏幕采集流程，并释放相关资源。调用本方法后，pauseScreenCapture 和 resumeScreenCapture 将不再生效。

pauseScreenCapture #

- (void)pauseScreenCapture;

暂停屏幕采集。

注意

调用该方法后，屏幕采集将暂停输出数据，但不会销毁内部资源。您可通过 resumeScreenCapture 来恢复采集。如果当前采集已经停止或尚未开始，调用本方法不会产生任何效果。

resumeScreenCapture #

- (void)resumeScreenCapture;

恢复屏幕采集。

注意

在调用 pauseScreenCapture 暂停后，通过本方法可以恢复屏幕采集输出。如果屏幕采集已经停止或尚未开始，调用本方法不会产生任何效果。

@interface VeLiveVideoEffectManager : NSObject

视频特效管理对象。用于管理和设置视频特效，包括美颜、美形、美体、美妆、滤镜等。

成员函数 #

函数说明 #

setupWithConfig: #

- (int)setupWithConfig:(VeLiveVideoEffectLicenseConfiguration *)config;

视频特效许可证配置，用于初始化视频特效管理对象。

传入参数

返回值

• 0：调用成功；
• -1：调用失败。
  

updateLicense: #

- (void)updateLicense:(void (^)(int result, NSString *_Nullable message))completion;

在许可证过期后，可调用该方法更新 License，本方法仅对在线 License 有效。

传入参数

注意

• 需要通过调用 setupWithConfig: 设置视频特效许可证后调用；
• 本方法为异步操作。
  

setAlgoModelPath: #

- (int)setAlgoModelPath:(NSString *)path;

设置特效算法模型包的路径。

传入参数

返回值

• 0：调用成功；
• -1：调用失败。

注意

需要通过调用 setupWithConfig: 设置视频特效许可证后调用。

setEnable: #

- (int)setEnable:(BOOL)enable;

创建/销毁特效引擎。

传入参数

返回值

• 0：调用成功；
• -1：调用失败。

注意

• 该方法需要在调用 setupWithConfig: 和 setAlgoModelPath: 后调用；
• 该方法不直接开启/关闭视频特效，您需要在调用该方法后，调用 setComposeNodes: 开启视频特效；
• 通用场景下，特效引擎会随 EffectManager 销毁而销毁。如果您对性能有较高要求，也可以在不使用特效相关功能时，调用该方法销毁特效引擎；
• 如果重复创建/销毁特效引擎，会产生时间消耗。
  

setComposeNodes: #

- (int)setComposeNodes:(nullable NSArray<NSString *> *)nodes;

设置视频特效组合。支持设置 ComposeMakeup.bundle 中的功能，包括美颜、美形、美体、美妆等。

传入参数

返回值

• 0：调用成功；
• -1：调用失败。

注意

• 需要在调用 setEnable: 创建特效引擎后，调用本方法；
• 重复调用本方法，仅最后一次调用生效；
• 如果需要在当前的视频特效组合中叠加特效，可调用 appendComposeNodes: 方法。
  

appendComposeNodes: #

- (int)appendComposeNodes:(NSArray<NSString *> *)nodes;

调用本方法，会在 setComposeNodes: 设置的视频特效组合的基础上叠加特效。

传入参数

返回值

• 0：调用成功；
• -1：调用失败。

注意

需要在调用 setEnable: 创建特效引擎后，调用本方法。

removeComposeNodes: #

- (int)removeComposeNodes:(NSArray<NSString *> *)nodes;

调用本方法，可移除调用 setComposeNodes: 和 ppendComposeNodes: 设置的视频特效资源。

传入参数

返回值

• 0：调用成功；
• -1：调用失败。

注意

需要在调用 setEnable: 创建特效引擎后，调用本方法。

updateComposerNodeIntensity:nodeKey:intensity: #

- (int)updateComposerNodeIntensity:(NSString *)node nodeKey:(NSString *)key intensity:(float)intensity;

设置视频特效强度。

传入参数

返回值

• 0：调用成功；
• -1：调用失败。

注意

• 需要在调用 setComposeNodes: 设置视频特效组合或调用 appendComposeNodes: 叠加视频特效素材包后，调用本方法；
• 该方法仅适用于同时含有上述三个参数的特效资源，对于没有强度参数的特效（如贴纸），该方法无效。
  

setFilter: #

- (int)setFilter:(nullable NSString *)path;