LSMediaRecording Class Reference

Inherits from NSObject
Declared in LSMediaRecording.h

Overview

录制核心类

  onStatisticInfoGot

统计结果回调

@property (nonatomic, copy) void ( ^ ) ( LSMediaRecordStatistics *statistics ) onStatisticInfoGot

Discussion

统计结果回调

Declared In

LSMediaRecording.h

  onLiveStreamError

过程中发生错误的回调

@property (nonatomic, copy) void ( ^ ) ( NSError *error ) onLiveStreamError

Discussion

过程中发生错误的回调

Declared In

LSMediaRecording.h

+ cleanGPUCache

清除缓存，如果和转码sdk一同使用，请在最后释放的类中调用。

+ (void)cleanGPUCache

Discussion

清除缓存，如果和转码sdk一同使用，请在最后释放的类中调用。

Declared In

LSMediaRecording.h

– init

初始化mediacapture

- (instancetype)init

Return Value

LSMediaCapture

Discussion

初始化mediacapture

Declared In

LSMediaRecording.h

– initLiveStreamWithAppKey:error:

初始化 mediacapture

- (instancetype)initLiveStreamWithAppKey:(NSString *)appKey error:(NSError **)error

Parameters

appKey

appKey
error

错误原因

Return Value

实例

Declared In

LSMediaRecording.h

– initLiveStreamWithVideoParaCtx:appKey:error:

初始化mediacapture

- (instancetype)initLiveStreamWithVideoParaCtx:(LSRecordVideoParaCtx *)videoParaCtx appKey:(NSString *)appKey error:(NSError **)error

Parameters

videoParaCtx

录制视频参数
appKey

appKey
error

错误原因

Return Value

LSMediaCapture

Declared In

LSMediaRecording.h

– initLiveStreamWithLivestreamParaCtx:appKey:error:

初始化mediacapture

- (instancetype)initLiveStreamWithLivestreamParaCtx:(LSMediaRecordingParaCtx *)lsParaCtx appKey:(NSString *)appKey error:(NSError **)error

Parameters

lsParaCtx

录制参数
appKey

appKey
error

错误原因

Return Value

LSMediaCapture

Declared In

LSMediaRecording.h

– startVideoPreview:

打开视频预览

- (void)startVideoPreview:(UIView *)preview

Parameters

preview

预览窗口

Discussion

在ipad3上，前置摄像头的分辨率不支持960*540的高分辨率,不建议在ipad上使用前置摄像头进行高清分辨率采集

Declared In

LSMediaRecording.h

– pauseVideoPreview

暂停视频预览

- (void)pauseVideoPreview

Discussion

如果正在录制 ，则同时关闭视频预览以及视频录制

Declared In

LSMediaRecording.h

– resumeVideoPreview

恢复视频预览

- (void)resumeVideoPreview

Discussion

如果正在录制 ，则开始视频录制

Declared In

LSMediaRecording.h

– snapShotWithCompletionBlock:

获取视频截图

- (void)snapShotWithCompletionBlock:(void ( ^ ) ( UIImage *image ))completionBlock

Parameters

completionBlock

获取最新一幅视频图像的回调

Declared In

LSMediaRecording.h

– switchCamera

切换前后摄像头

- (LSRecordCameraPosition)switchCamera

Return Value

当前摄像头的位置，前或者后

Declared In

LSMediaRecording.h

– addWaterMark:rect:location:

添加静态视频水印

- (void)addWaterMark:(UIImage *)image rect:(CGRect)rect location:(LSRecordWaterMarkLocation)location

Parameters

image

静态图像
rect

具体位置和大小
location

位置

Declared In

LSMediaRecording.h

– closePreviewWaterMark:

关闭本地预览静态水印

- (void)closePreviewWaterMark:(BOOL)isClosed

Parameters

isClosed

是否关闭

Declared In

LSMediaRecording.h

– addDynamicWaterMarks:fpsCount:loop:rect:location:

@brief添加动态视频水印

- (void)addDynamicWaterMarks:(NSArray *)imageArray fpsCount:(unsigned int)count loop:(BOOL)looped rect:(CGRect)rect location:(LSRecordWaterMarkLocation)location

Parameters

imageArray

动态图像数组
count

播放速度的快慢:count代表count帧一张图
looped

是否循环，不循环就显示一次
rect

具体位置和大小（x，y根据location位置，计算具体的位置信息）
location

位置

Discussion

@brief添加动态视频水印

Declared In

LSMediaRecording.h

– closePreviewDynamicWaterMark:

关闭本地预览动态水印

- (void)closePreviewDynamicWaterMark:(BOOL)isClosed

Parameters

isClosed

是否关闭

Declared In

LSMediaRecording.h

– cleanWaterMark

清除水印

- (void)cleanWaterMark

Discussion

清除水印

Declared In

LSMediaRecording.h

– setVideoParameters:bitrate:fps:

录制的视频分辨率、码率、帧率设置， 开始录制之前可以设置

- (void)setVideoParameters:(LSRecordVideoStreamingQuality)videoResolution bitrate:(int)bitrate fps:(int)fps

Parameters

videoResolution

分辨率
bitrate

录制码率
fps

录制帧率

Declared In

LSMediaRecording.h

  videoQuality

视频分辨率选择，开始录制之前可以设置

@property (nonatomic, assign) LSRecordVideoStreamingQuality videoQuality

Declared In

LSMediaRecording.h

  videoScaleMode

视频比例选择，开始录制之前可以设置

@property (nonatomic, assign) LSRecordVideoRenderScaleMode videoScaleMode

Declared In

LSMediaRecording.h

  focusPoint

手动聚焦点，开始录制之前可以设置

@property (nonatomic, assign) CGPoint focusPoint

Declared In

LSMediaRecording.h

  flash

闪光灯。YES:开 NO:关

@property (nonatomic, assign) BOOL flash

Declared In

LSMediaRecording.h

  maxZoomScale

摄像头最大变焦倍数，只读。

@property (nonatomic, assign, readonly) CGFloat maxZoomScale

Declared In

LSMediaRecording.h

  zoomScale

摄像头变焦倍数。[1 ～ maxZoomScale]，default:1

@property (nonatomic, assign) CGFloat zoomScale

Declared In

LSMediaRecording.h

  exposureValue

摄像头曝光补偿属性：在摄像头曝光补偿最大最小范围内改变曝光度。value : [-1 ~ 1], defaule: 0

@property (nonatomic, assign) float exposureValue

Declared In

LSMediaRecording.h

  filterType

滤镜类型设置。

@property (nonatomic, assign) LSRecordGPUImageFilterType filterType

Discussion

value : 取值参见LSRecordGPUImageFilterType。default:LS_RECORD_GPUIMAGE_NORMAL

Declared In

LSMediaRecording.h

  smoothFilterIntensity

设置磨皮滤镜的强度。仅支持NMCGPUImageZiran，NMCGPUImageMeiyan1，NMCGPUImageMeiyan2

@property (nonatomic, assign) float smoothFilterIntensity

Discussion

取值 value : [0 ~ 1], default: 0

Declared In

LSMediaRecording.h

  whiteningFilterIntensity

设置美白滤镜强度,只支持NMCGPUImageZiran NMCGPUImageMeiyan1 NMCGPUImageMeiyan2

@property (nonatomic, assign) float whiteningFilterIntensity

Discussion

取值 value : [0 ~ 1], default 0

Declared In

LSMediaRecording.h

  recordRotation

录制的旋转角度，顺时针方向。

@property (nonatomic, assign) LSRecordRotation recordRotation

Declared In

LSMediaRecording.h

  recordFileSavedRootPath

分镜保存的根路径(默认路径 Documents/videos)

@property (nonatomic, copy) NSString *recordFileSavedRootPath

Declared In

LSMediaRecording.h

  recordFilePath

分镜保存的mp4地址，只读

@property (nonatomic, copy, readonly) NSString *recordFilePath

Declared In

LSMediaRecording.h

– startLiveStream

开始录制

- (NSError *)startLiveStream

Return Value

具体错误，无错误返回nil

Discussion

收到LS_Recording_Started消息后，录制才真正开始。

Declared In

LSMediaRecording.h

– stopLiveStream

结束录制

- (NSError *)stopLiveStream

Return Value

具体错误，无错误返回nil

Discussion

收到LS_Recording_Finished消息后，录制才真正结束，才可以关闭。

Declared In

LSMediaRecording.h

– startPlayMusic:withEnableSignleFileLooped:

开始播放混音文件

- (BOOL)startPlayMusic:(NSString *)musicURL withEnableSignleFileLooped:(BOOL)enableLoop

Parameters

musicURL

音频文件地址/文件名
enableLoop

当前音频文件是否单曲循环

Return Value

YES:成功 NO:失败

Declared In

LSMediaRecording.h

– stopPlayMusic

结束播放混音文件，释放播放文件

- (BOOL)stopPlayMusic

Declared In

LSMediaRecording.h

– resumePlayMusic

继续播放混音文件

- (BOOL)resumePlayMusic

Declared In

LSMediaRecording.h

– pausePlayMusic

暂停播放混音文件

- (BOOL)pausePlayMusic

Declared In

LSMediaRecording.h

– seekMusicToFrameIndex:

seek伴音文件

- (void)seekMusicToFrameIndex:(SInt64)frameIndex

Parameters

frameIndex

目标帧序号

Declared In

LSMediaRecording.h

  curMusicFrameIndex

当前播放伴音的帧序号

@property (nonatomic, readonly) SInt64 curMusicFrameIndex

Declared In

LSMediaRecording.h

  musicVolume

伴音音量

@property (nonatomic, assign) CGFloat musicVolume

Declared In

LSMediaRecording.h

  microphoneVolume

麦克风采集音量

@property (nonatomic, assign) CGFloat microphoneVolume

Declared In

LSMediaRecording.h

+ setLogLevel:

设置日志级别

+ (void)setLogLevel:(LSMediaRecordLogLevel)logLevel

Parameters

logLevel

信息的级别

Declared In

LSMediaRecording.h

+ SDKVersion

获取当前sdk的版本号

+ (NSString *)SDKVersion

Return Value

版本号

Declared In

LSMediaRecording.h

  customFilter

添加自定义滤镜。default:nil

@property (nonatomic, strong) GPUImageFilter *customFilter

Declared In

LSMediaRecording.h

  isBeautyFilterOn

美颜开关。指在定义滤镜上是否再叠加sdk提供的自然滤镜。default:NO

@property (nonatomic, assign) BOOL isBeautyFilterOn

Discussion

1）YES:自定义滤镜（如果有）＋ 自然滤镜(LS_RECORD_GPUIMAGE_ZIRAN)。2）NO: 自定义滤镜（如果有）＋ 普通滤镜(LS_RECORD_GPUIMAGE_NORMAL)。

Declared In

LSMediaRecording.h

– externalInputVideoFrame:

用户可以通过这个接口，将处理完的数据送回来，由视频云sdk录制出去

- (void)externalInputVideoFrame:(CMSampleBufferRef)sampleBuffer

Parameters

sampleBuffer

采集到的数据结构体

Declared In

LSMediaRecording.h

  externalVideoFrameCallback

获取最新一帧视频截图后的回调

@property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef pixelBuf ) externalVideoFrameCallback

Discussion

pixelBuf 采集到的数据结构体

Declared In

LSMediaRecording.h