流媒体上下文 更多...
#import <NvsStreamingContext.h>
类 NvsStreamingContext 继承关系图:
属性 | |
| id< NvsStreamingContextDelegate > | delegate |
| NvsAssetPackageManager * | assetPackageManager |
| 包管理器 更多... | |
| float | compileVideoBitrateMultiplier |
| 生成视频码率倍乘系数 更多... | |
| float | recordVideoBitrateMultiplier |
| 录制视频码率倍乘系数 更多... | |
| BOOL | defaultCaptionFade |
| 默认字幕是否为淡入淡出 更多... | |
| id< NvsImageGrabberDelegate > | imageGrabberDelegate |
| NSMutableDictionary * | compileConfigurations |
| 生成时间线配置，设置一次即一直生效。NSMutableDictionary中关键字的值请参见 生成时间线的配置 例如：NSMutableDictionary *config = [[NSMutableDictionary alloc] init]; [config setValue:[NSNumber numberWithInteger:15] forKey:NVS_COMPILE_GOP_SIZE]; // 设置为1即是生成全I帧视频 [config setValue:[NSNumber numberWithInteger:10000000] forKey:NVS_COMPILE_BITRATE]; // 10M bps [config setValue:[NSNumber numberWithInteger:256000] forKey:NVS_COMPILE_AUDIO_BITRATE]; // 设置音频码率为256Kbps [config setValue:[NSNumber numberWithBool:YES] forKey:NVS_COMPILE_LOSSLESS_AUDIO]; // 设置生成无损音频 [config setValue:[NSNumber numberWithBool:YES] forKey:NVS_COMPILE_OPTIMIZE_FOR_NETWORK_USE]; // 设置索引表前置 NvsRational videoFps = {12, 1}; [config setValue:[NSData dataWithBytes:&videoFps length:sizeof(NvsRational)] forKey:NVS_COMPILE_VIDEO_FPS]; // 设置帧速率FPS _streamingContext.compileConfigurations = config; 取消设置并恢复默认方式例如：[_streamingContext.compileConfigurations setValue:nil forKey:NVS_COMPILE_GOP_SIZE]; 更多... | |
详细描述
流媒体上下文
流媒体上下文类可视作整个SDK框架的入口。开发过程中，NvsStreamingContext类提供了静态sharedInstance()接口创建流上下文的唯一实例。 通过这个实例对象，我们可以开启采集设备录制视频，添加采集视频特效，设置拍摄时的各项参数，包括自动聚焦，自动曝光调节，开关换补光灯等。 同时，还能够创建时间线，并将时间线与实时预览窗口(Live Window)连接起来，实时预览播放已经拍摄完成的视频。整个视频制作完成后，要销毁流媒体上下文的对象实例。 带特效拍摄时，添加素材资源包(采集特效包，场景资源包等)，都得先安装，安装成功后获取packageId才能使用，而内建采集特效(builtin)只需获取特效名称即可使用。
sdk接口中凡是需要传入资源、授权等文件路径时一定是全路径。
- 警告
- NvsStreamingContext类中，所有public API除了getAVFileInfo，detectVideoFileKeyframeInterval，createVideoFrameRetriever可以跨线程使用，其他都在UI线程使用！！！
函数文档
◆ addCustomCaptureAnimatedSticker:duration:animatedStickerPackageId:customImagePath:
| - (NvsCaptureAnimatedSticker *) addCustomCaptureAnimatedSticker: | (int64_t) | inPoint | |
| duration: | (int64_t) | duration | |
| animatedStickerPackageId: | (NSString *) | animatedStickerPackageId | |
| customImagePath: | (NSString *) | customImagePath | |
在拍摄上添加自定义动画贴纸
- 参数
-
inPoint 自定义动画贴纸在时间线上的入点（单位微秒） duration 自定义动画贴纸的显示时长（单位微秒） animatedStickerPackageId 自定义动画贴纸包Id customImagePath 自定义动画贴纸图像路径（可以是jpg、png图像，或者美摄sdk内部支持的动态caf格式图像）
- 返回
- 返回拍摄自定义动画贴纸对象
以下情况会返回nil：
1.没有动画贴纸功能授权；
2.animatedStickerPackageId参数为空字符串或者nil；
3.该动画贴纸包没有安装成功；
4.如果inPoint小于0，或者duration不大于0。
注意：如果返回值非空，依旧看不到贴纸效果，需要检查customImagePath是否真实存在
- 自从
- 3.2.0
◆ appendBeautyCaptureVideoFx
| - (NvsCaptureVideoFx *) appendBeautyCaptureVideoFx |
◆ appendBuiltinCaptureAudioFx:
| - (NvsCaptureAudioFx *) appendBuiltinCaptureAudioFx: | (NSString *) | audioFxName |
追加一个内建音频特效
- 参数
-
audioFxName 音频特效名。获取音频特效名称，请参见getAllBuiltinCaptureAudioFxNames()或内建特效名称列表。
- 返回
- 返回追加的内建音频特效对象
- 参见
- insertBuiltinCaptureVideoFx
- 自从
- 2.21.0
◆ appendBuiltinCaptureVideoFx:
| - (NvsCaptureVideoFx *) appendBuiltinCaptureVideoFx: | (NSString *) | videoFxName |
追加一个内建视频特效
- 参数
-
videoFxName 视频特效名。获取视频特效名称，请参见getAllBuiltinCaptureVideoFxNames()或内建特效名称列表。
- 返回
- 返回追加的内建视频特效对象
◆ appendCaptureAnimatedSticker:duration:animatedStickerPackageId:
| - (NvsCaptureAnimatedSticker *) appendCaptureAnimatedSticker: | (int64_t) | offsetTime | |
| duration: | (int64_t) | duration | |
| animatedStickerPackageId: | (NSString *) | animatedStickerPackageId | |
追加一个动画贴纸
- 参数
-
offsetTime 动画贴纸的偏移时间。 duration 动画贴纸的持续时间。 animatedStickerPackageId 动画贴纸包Id。
- 返回
- 返回采集动画贴纸对象
以下情况会返回null：
1.没有动画贴纸功能授权；
2.animatedStickerPackageId参数为空字符串或者null；
3.该动画贴纸包没有安装成功；
- 参见
- insertCaptureAnimatedSticker
- 自从
- 2.21.0
◆ appendCaptureCaption:offsetTime:duration:captionStylePackageId:
| - (NvsCaptureCaption *) appendCaptureCaption: | (NSString *) | captionText | |
| offsetTime: | (int64_t) | offsetTime | |
| duration: | (int64_t) | duration | |
| captionStylePackageId: | (NSString *) | captionStylePackageId | |
追加一个字幕
- 参数
-
captionText 字幕的文字 offsetTime 字幕的偏移时间。 duration 字幕的持续时间。 captionStylePackageId 字幕样式包Id，不存在的话，可以传空字符串或者null
- 返回
- 返回采集字幕对象
以下情况会返回null：
1.没有复合字幕功能授权；
- 参见
- insertCaptureCompoundCaption
- 自从
- 2.21.0
◆ appendCaptureCompoundCaption:duration:compoundCaptionPackageId:
| - (NvsCaptureCompoundCaption *) appendCaptureCompoundCaption: | (int64_t) | offsetTime | |
| duration: | (int64_t) | duration | |
| compoundCaptionPackageId: | (NSString *) | compoundCaptionPackageId | |
追加一个复合字幕
- 参数
-
offsetTime 复合字幕的偏移时间。 duration 复合字幕的持续时间。 compoundCaptionPackageId 复合字幕包Id。
- 返回
- 返回采集复合字幕对象
以下情况会返回null：
1.没有复合字幕功能授权；
- 参见
- insertCaptureCompoundCaption
- 自从
- 2.21.0
◆ appendCaptureModularCaption:offsetTime:duration:
| - (NvsCaptureCaption *) appendCaptureModularCaption: | (NSString *) | captionText | |
| offsetTime: | (int64_t) | offsetTime | |
| duration: | (int64_t) | duration | |
追加一个模块字幕
- 参数
-
captionText 字幕的文字 offsetTime 字幕的偏移时间。 duration 字幕的持续时间。
- 返回
- 返回采集字幕对象
以下情况会返回null：
1.没有复合字幕功能授权；
- 参见
- insertCaptureCompoundCaption
- 自从
- 2.21.0
◆ appendCustomCaptureVideoFx:
| - (NvsCaptureVideoFx *) appendCustomCaptureVideoFx: | (id< NvsCustomVideoFxRenderer >) | customVideoFxRender |
追加自定义采集视频特效
- 参数
-
customVideoFxRender 用户实现的自定义视频特效渲染器接口
- 返回
- 返回追加的采集视频特效对象
- 警告
- 此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。
- 自从
- 1.7.0
◆ appendPackagedCaptureVideoFx:
| - (NvsCaptureVideoFx *) appendPackagedCaptureVideoFx: | (NSString *) | videoFxPackageId |
追加一个包裹视频特效
- 参数
-
videoFxPackageId 视频特效包裹ID
- 返回
- 返回追加的包裹视频特效对象
◆ applyCaptureScene:
| - (BOOL) applyCaptureScene: | (NSString *) | captureSceneId |
对采集设备应用拍摄场景资源包
- 参数
-
captureSceneId 拍摄场景资源包的ID
- 返回
- 返回BOOL值。值为YES则应用成功，NO则失败。
- 自从
- 1.2.0
◆ applyCaptureScene:captureSceneInfo:
| - (BOOL) applyCaptureScene: | (NSString *) | captureSceneId | |
| captureSceneInfo: | (NvsCaptureSceneInfo *) | info | |
对采集设备应用拍摄场景资源包
- 参数
-
captureSceneId 拍摄场景资源包的ID info 待替换的资源信息
- 返回
- 返回BOOL值。值为YES则应用成功，NO则失败。
- 自从
- 3.2.0
◆ calcDurationAfterCurvesVariableSpeed:
| - (long) calcDurationAfterCurvesVariableSpeed: | (NSString *) | curvesString |
- 自从
- 2.17.0
◆ cancelAutoFocus
| - (void) cancelAutoFocus |
取消正在进行中的自动聚焦
◆ captureDeviceCount
| - (unsigned int) captureDeviceCount |
采集设备的数量
- 返回
- 返回采集设备数
◆ clearCachedResources:
| - (void) clearCachedResources: | (BOOL) | asynchronous |
清除缓存资源
- 参数
-
asynchronous 是否异步
◆ clearCachedResources:flags:
| - (void) clearCachedResources: | (BOOL) | asynchronous | |
| flags: | (int) | flags | |
清除缓存资源
- 参数
-
asynchronous 是否异步 flags 清除缓存标志，如无特殊需求请填写0。请参见 NvsClearCacheFlag。
◆ closeHumanDetection
| + (void) closeHumanDetection |
关闭人体检测机制
- 自从
- 2.5.0
- 参见
- initHumanDetection
◆ compilePassthroughTimeline:outputFilePath:compileConfigurations:flags:
| - (BOOL) compilePassthroughTimeline: | (NvsTimeline *) | timeline | |
| outputFilePath: | (NSString *) | outputFilePath | |
| compileConfigurations: | (NSMutableDictionary *) | configurations | |
| flags: | (int) | flags | |
将时间线中视频轨道0上的视频片段直通生成一个视频，不处理滤镜、多轨和嵌套时间线，如果有图片则失败
- 参数
-
timeline 时间线对象 outputFilePath 生成输出的文件路径 configurations 时间线配置,只支持添加NVS_COMPILE_CREATION_TIME、NVS_COMPILE_OPTIMIZE_FOR_NETWORK_USE、NVS_COMPILE_METADATADESCRIPTION flags 生成文件输出的特殊标志，如果没有特殊需求，请填写0。
- 返回
- 返回布尔值。注意：时间线生成文件是异步操作。返回true，则启动生成成功；false，则启动生成失败
- 警告
- 此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。
- 自从
- 3.4.0
- 参见
- seekTimeline
- playbackTimeline
- compileTimeline
◆ compileTimeline:startTime:endTime:outputFilePath:videoResolutionGrade:videoBitrateGrade:compileConfigurations:flags:
| - (BOOL) compileTimeline: | (NvsTimeline *) | timeline | |
| startTime: | (int64_t) | startTime | |
| endTime: | (int64_t) | endTime | |
| outputFilePath: | (NSString *) | outputFilePath | |
| videoResolutionGrade: | (NvsCompileVideoResolutionGrade) | videoResolutionGrade | |
| videoBitrateGrade: | (NvsCompileVideoBitrateGrade) | videoBitrateGrade | |
| compileConfigurations: | (NSMutableDictionary *) | compileConfigurations | |
| flags: | (int) | flags | |
时间线生成视频文件
- 参数
-
timeline 时间线 startTime 开始时间(单位微秒)。startTime取值范围在[0,timeline.duration - 1],传入其他值无效。 endTime 结束时间(单位微秒)。endTime取值范围在(startTime,timeline.duration],同样传入其他值无效。 outputFilePath 生成视频输出的文件路径。注意: 目前只支持输出.mov格式的文件 videoResolutionGrade 生成视频输出的分辨率级别 videoBitrateGrade 生成视频输出的码率。视频输出码率级别分为低码率，中等码率，高等码率。视频生成具体码率值跟生成视频的分辨率有关，这里以1280 * 720p为例，计算出不同码率级别对应的近似值， NvsCompileBitrateGradeLow级别值为2.2Mbps，NvsCompileBitrateGradeMedium级别值为3.3Mbps，NvsCompileBitrateGradeHigh级别值为6Mbps。 compileConfigurations 时间线配置 NSMutableDictionary中关键字的值请参见 生成时间线的配置 flags 生成视频输出的特殊标志。请参见 NvsStreamingEngineCompileFlag
- 返回
- 返回BOOL值。注意：时间线生成视频文件是异步操作。返回值为YES则启动时间线生成文件成功，NO则时间线生成文件启动失败。
- 警告
- 此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。
- 自从
- 3.1.0
◆ compileTimeline:startTime:endTime:outputFilePath:videoResolutionGrade:videoBitrateGrade:flags:
| - (BOOL) compileTimeline: | (NvsTimeline *) | timeline | |
| startTime: | (int64_t) | startTime | |
| endTime: | (int64_t) | endTime | |
| outputFilePath: | (NSString *) | outputFilePath | |
| videoResolutionGrade: | (NvsCompileVideoResolutionGrade) | videoResolutionGrade | |
| videoBitrateGrade: | (NvsCompileVideoBitrateGrade) | videoBitrateGrade | |
| flags: | (int) | flags | |
时间线生成视频文件
- 参数
-
timeline 时间线 startTime 开始时间(单位微秒)。startTime取值范围在[0,timeline.duration - 1],传入其他值无效。 endTime 结束时间(单位微秒)。endTime取值范围在(startTime,timeline.duration],同样传入其他值无效。 outputFilePath 生成视频输出的文件路径。注意: 目前只支持输出.mov格式的文件 videoResolutionGrade 生成视频输出的分辨率级别 videoBitrateGrade 生成视频输出的码率。视频输出码率级别分为低码率，中等码率，高等码率。视频生成具体码率值跟生成视频的分辨率有关，这里以1280 * 720p为例，计算出不同码率级别对应的近似值， NvsCompileBitrateGradeLow级别值为2.2Mbps，NvsCompileBitrateGradeMedium级别值为3.3Mbps，NvsCompileBitrateGradeHigh级别值为6Mbps。 flags 生成视频输出的特殊标志。请参见 NvsStreamingEngineCompileFlag
- 返回
- 返回BOOL值。注意：时间线生成视频文件是异步操作。返回值为YES则启动时间线生成文件成功，NO则时间线生成文件启动失败。
- 警告
- 此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。
◆ connectCapturePreviewWithLiveWindow:
| - (BOOL) connectCapturePreviewWithLiveWindow: | (NvsLiveWindow *) | liveWindow |
◆ connectCapturePreviewWithVideoFrameReceiver:
| - (BOOL) connectCapturePreviewWithVideoFrameReceiver: | (NvsVideoFrameReceiver *) | receiver |
连接采集预览和视频帧接收器
- 参数
-
receiver 视频帧接收器
- 返回
- 返回BOOL值。返回YES则连接成功，NO则连接失败。
- 自从
- 1.7.1
◆ connectTimeline:withLiveWindow:
| - (BOOL) connectTimeline: | (NvsTimeline *) | timeline | |
| withLiveWindow: | (NvsLiveWindow *) | liveWindow | |
连接时间线和实时预览窗口
- 参数
-
timeline 时间线 liveWindow 实时预览窗口
- 返回
- 返回BOOL值。返回YES则连接成功，NO则连接失败。
◆ connectTimeline:withVideoFrameReceiver:
| - (BOOL) connectTimeline: | (NvsTimeline *) | timeline | |
| withVideoFrameReceiver: | (NvsVideoFrameReceiver *) | receiver | |
连接时间线和视频帧接收器
- 参数
-
timeline 时间线 receiver 视频帧接收器
- 返回
- 返回BOOL值。返回YES则连接成功，NO则连接失败。
◆ createAuxiliaryStreamingContext:
| - (NvsStreamingContext *) createAuxiliaryStreamingContext: | (int) | flags |
创建辅助流媒体上下文对象
- 参数
-
flags 流媒体上下文创建标志
- 返回
- 返回NvsVideoFrameRetriever对象，表示辅助流媒体上下文对象
- 自从
- 2.12.0
◆ createTimeline:templateFootages:
| - (NvsTimeline *) createTimeline: | (NSString *) | templateId | |
| templateFootages: | (NSArray< NvsTemplateFootageInfo * > *) | templateFootages | |
用模板资源创建时间线
- 参数
-
templateId 模板资源uuid templateFootages 模板资源里footage的对应信息
- 返回
- 返回创建的时间线对象
- 参见
- removeTimeline
◆ createTimeline:templateFootages:flags:
| - (NvsTimeline *) createTimeline: | (NSString *) | templateId | |
| templateFootages: | (NSArray< NvsTemplateFootageInfo * > *) | templateFootages | |
| flags: | (int) | flags | |
用模板资源创建时间线
- 参数
-
templateId 模板资源uuid templateFootages 模板资源里footage的对应信息 flags 创建时间线的特殊标志，如果没有特殊需求，请填写0。请参见NvsCreateTimelineTypeFlag
- 返回
- 返回创建的时间线对象
- 自从
- 2.21.0
- 参见
- removeTimeline
◆ createTimeline:templateFootages:flags:videoFps:audioEditRes:
| - (NvsTimeline *) createTimeline: | (NSString *) | templateId | |
| templateFootages: | (NSArray< NvsTemplateFootageInfo * > *) | templateFootages | |
| flags: | (int) | flags | |
| videoFps: | (NvsRational *) | videoFps | |
| audioEditRes: | (NvsAudioResolution *) | audioEditRes | |
用模板资源创建时间线
- 参数
-
templateId 模板资源uuid，必须先安装模板 templateFootages 模板资源里footage的对应信息 flags 创建时间线的特殊标志，如果没有特殊需求，请填写0。请参见创建时间线标志 videoFps 视频帧率，最大60fps audioEditRes 音频解析度(指定采样率、采样格式及声道数)。对于音频编辑解析度，传入的采样率值支持两种：44100与48000。支持单声道和立体声
- 返回
- 返回创建的时间线对象
- 自从
- 3.5.0
- 参见
- removeTimeline
◆ createTimeline:videoFps:audioEditRes:
| - (NvsTimeline *) createTimeline: | (NvsVideoResolution *) | videoEditRes | |
| videoFps: | (NvsRational *) | videoFps | |
| audioEditRes: | (NvsAudioResolution *) | audioEditRes | |
创建时间线
- 参数
-
videoEditRes 视频编辑解析度(指定视频宽高及像素比)。对于视频编辑解析度，在传入对应参数值时，目前要求传入的图像宽度值是4的倍数，高度值是2的倍数。注：如果创建NvsStreamingContext单例对象，支持4k视频编辑，则视频编辑解析度里的imageWidth * imageHeight不能高于3840*2160像素，否则视频编辑解析度里的imageWidth * imageHeight不能高于1920 * 1080像素。 videoFps 视频帧率，最高60fps audioEditRes 音频编辑解析度(指定采样率、采样格式及声道数)。对于音频编辑解析度，传入的采样率值支持两种：44100与48000，支持单声道和双声道
- 返回
- 返回创建的时间线对象，如果参数不满足上述条件，则返回null
◆ createTimeline:videoFps:audioEditRes:bitDepth:flags:
| - (NvsTimeline *) createTimeline: | (NvsVideoResolution *) | videoEditRes | |
| videoFps: | (NvsRational *) | videoFps | |
| audioEditRes: | (NvsAudioResolution *) | audioEditRes | |
| bitDepth: | (NvsVideoResolutionBitDepth) | depth | |
| flags: | (int) | flags | |
创建时间线
- 参数
-
videoEditRes 视频编辑解析度(指定视频宽高及像素比)。对于视频编辑解析度，在传入对应参数值时，目前要求传入的图像宽度值是4的倍数，高度值是2的倍数。注：如果创建NvsStreamingContext单例对象，支持4k视频编辑，则视频编辑解析度里的imageWidth * imageHeight不能高于3840*2160像素，否则视频编辑解析度里的imageWidth * imageHeight不能高于1920 * 1080像素。 videoFps 视频帧率，最高60fps audioEditRes 音频编辑解析度(指定采样率、采样格式及声道数)。对于音频编辑解析度，传入的采样率值支持两种：44100与48000，支持单声道和双声道 bitDepth 时间线视频的位深度，目前支持8bit， 16bit float，和auto flags 创建时间线的特殊标志，如果没有特殊需求，请填写0。请参见NvsCreateTimelineTypeFlag
- 返回
- 返回创建的时间线对象，如果参数不满足上述条件，则返回null
- 自从
- 2.24.0
◆ createTimeline:videoFps:audioEditRes:flags:
| - (NvsTimeline *) createTimeline: | (NvsVideoResolution *) | videoEditRes | |
| videoFps: | (NvsRational *) | videoFps | |
| audioEditRes: | (NvsAudioResolution *) | audioEditRes | |
| flags: | (int) | flags | |
创建时间线
- 参数
-
videoEditRes 视频编辑解析度(指定视频宽高及像素比)。对于视频编辑解析度，在传入对应参数值时，目前要求传入的图像宽度值是4的倍数，高度值是2的倍数。注：如果创建NvsStreamingContext单例对象，支持4k视频编辑，则视频编辑解析度里的imageWidth * imageHeight不能高于3840*2160像素，否则视频编辑解析度里的imageWidth * imageHeight不能高于1920 * 1080像素。 videoFps 视频帧率，最高60fps audioEditRes 音频编辑解析度(指定采样率、采样格式及声道数)。对于音频编辑解析度，传入的采样率值支持两种：44100与48000，支持单声道和双声道 flags 创建时间线的特殊标志，如果没有特殊需求，请填写0。请参见NvsCreateTimelineTypeFlag
- 返回
- 返回创建的时间线对象，如果参数不满足上述条件，则返回null
- 自从
- 2.21.0
◆ createVideoFrameRetriever:
| - (NvsVideoFrameRetriever *) createVideoFrameRetriever: | (NSString *) | videoFilePath |
创建视频帧提取对象
- 参数
-
videoFilePath 原始视频文件路径
- 返回
- 返回NvsVideoFrameRetriever对象，表示视频帧提取对象
- 自从
- 1.2.0
◆ destoryAuxiliaryStreamingContext:
| - (void) destoryAuxiliaryStreamingContext: | (NvsStreamingContext *) | auxContext |
◆ destroyInstance
| + (void) destroyInstance |
销毁流媒体上下文实例。
◆ detectEngineRenderFramePerSecond
| - (float) detectEngineRenderFramePerSecond |
从流媒体上下文中获取引擎当前的渲染速度，只在startCapturePreview和playbackTimeline之后有效。
- 自从
- 2.8.0
◆ detectVideoFileKeyframeInterval:
| - (int) detectVideoFileKeyframeInterval: | (NSString *) | videoFilePath |
探测视频文件的I帧间距
- 参数
-
videoFilePath 视频文件的路径
- 返回
- 返回探测到的I帧间距，返回0表示探测失败
- 自从
- 1.6.0
◆ exportProjectInfo:timeline:requestedAspectRatio:
| - (BOOL) exportProjectInfo: | (NSString *) | projectUuid | |
| timeline: | (NvsTimeline *) | timeline | |
| requestedAspectRatio: | (int) | requestedAspectRatio | |
输出项目包的信息
- 参数
-
projectUuid 项目资源包ID timeline 时间线对象 requestedAspectRatio 所需的项目画幅比例，一般和timeline的画幅比例一致.请参见资源包画幅比例
- 返回
- 返回是否成功
◆ exportTemplateInfo:timeline:requestedAspectRatio:
| - (BOOL) exportTemplateInfo: | (NSString *) | templateUuid | |
| timeline: | (NvsTimeline *) | timeline | |
| requestedAspectRatio: | (int) | requestedAspectRatio | |
输出模版包的信息
- 参数
-
templateUuid 模版资源包ID timeline 时间线对象 requestedAspectRatio 所需的模版画幅比例，一般和timeline的画幅比例一致.请参见模板资源包画幅比例
- 返回
- 返回是否成功
◆ functionalityAuthorised:
| + (BOOL) functionalityAuthorised: | (NSString *) | sdkFunctionName |
验证某项功能是否可用。
- 参数
-
sdkFunctionName sdk功能的名字
- 返回
- 返回BOOL值。YES表示授权验证成功，NO则验证失败。
◆ generateProjectPackage:innerAssetDir:projectOutputDir:
| - (BOOL) generateProjectPackage: | (NSString *) | projectUuid | |
| innerAssetDir: | (NSString *) | innerAssetDir | |
| projectOutputDir: | (NSString *) | projectOutputDir | |
生成项目包
- 参数
-
projectUuid 项目资源包ID innerAssetDir 项目内部资源文件夹路径 projectOutputDir 项目资源包的输出路径
- 返回
- 返回是否成功
◆ generateTemplatePackage:innerAssetDir:templateOutputDir:
| - (BOOL) generateTemplatePackage: | (NSString *) | templateUuid | |
| innerAssetDir: | (NSString *) | innerAssetDir | |
| templateOutputDir: | (NSString *) | templateOutputDir | |
生成模版包
- 参数
-
templateUuid 模版资源包ID innerAssetDir 模版内部资源文件夹路径 templateOutputDir 模版资源包的输出路径
- 返回
- 返回是否成功
◆ getAllBuiltinAudioFxNames
| - (NSArray *) getAllBuiltinAudioFxNames |
◆ getAllBuiltinCaptureVideoFxNames
| - (NSArray *) getAllBuiltinCaptureVideoFxNames |
◆ getAllBuiltinVideoFxNames
| - (NSArray *) getAllBuiltinVideoFxNames |
◆ getAllBuiltinVideoTransitionNames
| - (NSArray *) getAllBuiltinVideoTransitionNames |
获取全部内嵌视频转场名称
- 返回
- 返回包含所有内嵌的视频转场名称的数组对象
◆ getAudioFxDescription:
| - (NvsFxDescription *) getAudioFxDescription: | (NSString *) | fxName |
◆ getAVFileInfo:
| - (NvsAVFileInfo *) getAVFileInfo: | (NSString *) | avFilePath |
获取文件的音视频信息，如果文件格式不支持，则返回null
- 参数
-
avFilePath 文件路径
- 返回
- 返回音视频文件信息的对象
◆ getAVFileInfo:extraFlag:withError:
| - (NvsAVFileInfo *) getAVFileInfo: | (NSString *) | avFilePath | |
| extraFlag: | (int) | extraFlag | |
| withError: | (NSMutableString *) | errString | |
获取音视频文件的详细信息
- 参数
-
avFilePath 音视频文件的路径 extraFlag 获取音视频文件的详细信息的特殊标识。请参见获取音视频信息时的特殊标识 errString 如果当前函数返回为null， 当前参数有意义， 返回具体的错误信息。
- 返回
- 返回获取的音视频信息对象，如果音视频文件格式不支持则返回null
- 自从
- 2.20.0
◆ getAVFileInfoExtra:extraFlag:
| - (NvsAVFileInfo *) getAVFileInfoExtra: | (NSString *) | avFilePath | |
| extraFlag: | (int) | extraFlag | |
◆ getBeautyVideoFxName
| - (NSString *) getBeautyVideoFxName |
◆ getCaptureAnimatedStickerByIndex:
| - (NvsCaptureAnimatedSticker *) getCaptureAnimatedStickerByIndex: | (unsigned int) | captureStikcerIndex |
获得采集动画贴纸
- 参数
-
captureStikcerIndex 动画贴纸索引
- 返回
- 返回动画贴纸对象
- 参见
- removeCaptureAnimatedSticker
- 自从
- 2.21.0
◆ getCaptureAnimatedStickerCount
| - (unsigned int) getCaptureAnimatedStickerCount |
获得采集动画贴纸的数量
- 返回
- 返回动画贴纸数量
- 自从
- 2.21.0
◆ getCaptureAudioFxByIndex:
| - (NvsCaptureAudioFx *) getCaptureAudioFxByIndex: | (unsigned int) | captureAudioFxIndex |
获得采集音频特效
- 参数
-
captureAudioFxIndex 音频特效索引
- 返回
- 返回音频特效对象
- 参见
- removeCaptureAudioFx
- 自从
- 2.21.0
◆ getCaptureAudioFxCount
| - (unsigned int) getCaptureAudioFxCount |
获得采集音频特效的数量
- 返回
- 返回音频特效数量
- 自从
- 2.21.0
◆ getCaptureCaptionByIndex:
| - (NvsCaptureCaption *) getCaptureCaptionByIndex: | (unsigned int) | captureCaptionIndex |
获得采集字幕
- 参数
-
captureStikcerIndex 字幕索引
- 返回
- 返回字幕对象
- 自从
- 2.21.0
◆ getCaptureCaptionCount
| - (unsigned int) getCaptureCaptionCount |
获得采集字幕的数量
- 返回
- 返回字幕数量
- 自从
- 2.21.0
◆ getCaptureCompoundCaptionByIndex:
| - (NvsCaptureCompoundCaption *) getCaptureCompoundCaptionByIndex: | (unsigned int) | captureCaptionIndex |
获得采集复合字幕
- 参数
-
captureStikcerIndex 复合字幕索引
- 返回
- 返回复合字幕对象
- 自从
- 2.21.0
◆ getCaptureCompoundCaptionCount
| - (unsigned int) getCaptureCompoundCaptionCount |
获得采集复合字幕的数量
- 返回
- 返回复合字幕数量
- 自从
- 2.21.0
◆ getCaptureDeviceCapability:
| - (NvsCaptureDeviceCapability *) getCaptureDeviceCapability: | (unsigned int) | catpureDeviceIndex |
获取采集设备的能力描述对象
- 参数
-
catpureDeviceIndex 采集设备索引
- 返回
- 返回采集设备能力描述对象
◆ getCapturePreviewVideoSize:
| - (NvsSize) getCapturePreviewVideoSize: | (unsigned int) | catpureDeviceIndex |
获取采集预览视频分辨率
- 参数
-
catpureDeviceIndex 采集设备索引
- 返回
- 获取采集预览视频分辨率
- 自从
- 1.7.1
◆ getCaptureVideoFxByIndex:
| - (NvsCaptureVideoFx *) getCaptureVideoFxByIndex: | (unsigned int) | captureVideoFxIndex |
◆ getCaptureVideoFxCount
| - (unsigned int) getCaptureVideoFxCount |
获得采集视频特效的数量
- 返回
- 返回视频特效数量
◆ getColorGainForSDRToHDR
| - (float) getColorGainForSDRToHDR |
获取在SDR向HDR转换时候色彩增益
- 返回
- 返回色彩增益值 范围是【1.0，10.0】
- 自从
- 2.23.0
- 参见
- setColorGainForSDRToHDR
◆ getCurrentCaptureSceneId
| - (NSString *) getCurrentCaptureSceneId |
取得当前拍摄场景资源包的ID
- 返回
- 当前拍摄场景资源包的ID字符串，返回nil表示当前没有拍摄场景资源包
- 自从
- 1.2.0
◆ getCustomCompileVideoHeight
| - (unsigned int) getCustomCompileVideoHeight |
获取当前自定义的生成视频高度。
- 返回
- 返回当前自定义的生成视频高度
- 自从
- 1.6.1
◆ getDefaultThemeEndingLogoImageFilePath
| - (NSString *) getDefaultThemeEndingLogoImageFilePath |
◆ getDefaultVideoTransitionName
| - (NSString *) getDefaultVideoTransitionName |
◆ getEAGLSharegroup
| - (EAGLSharegroup *) getEAGLSharegroup |
从流媒体上下文中获取引擎所用的EAGLSharegroup对象
- 自从
- 1.5.0
◆ getEngineHDRCaps
| - (int) getEngineHDRCaps |
获取引擎的HDR能力
- 返回
- 返回int值。请参见HDR能力标志
◆ getExposureBias
| - (float) getExposureBias |
◆ getFlashMode
| - (NvsCameraFlashMode) getFlashMode |
获取当前闪光灯模式
- 返回
- 闪光灯模式值。请参见闪光灯模式。
- 参见
- toggleFlashMode
◆ getFontInfoByFilePath:
| - (NSArray*) getFontInfoByFilePath: | (NSString *) | fontFilePath |
获取字体文件中字体信息
- 参数
-
fontFilePath 字体文件路径
- 返回
- 返回文件中所有字体的信息
◆ getLogFileDirectory
| + (NSString *) getLogFileDirectory |
获取日志文件所在路径
- 自从
- 2.14.0
◆ getSdkVersion:minorVersion:revisionNumber:
| + (void) getSdkVersion: | (int *) | majorVersion | |
| minorVersion: | (int *) | minorVersion | |
| revisionNumber: | (int *) | revisionNumber | |
获取美摄SDK的版本信息
- 参数
-
majorVersion 主版本号 minorVersion 次版本号 revisionNumber 修订版本号
- 自从
- 1.4.1
◆ getStreamingEngineState
| - (NvsStreamingEngineState) getStreamingEngineState |
获取引擎状态
- 返回
- 返回引擎状态
◆ getTimelineCurrentPosition:
| - (int64_t) getTimelineCurrentPosition: | (NvsTimeline *) | timeline |
取得时间线当前时间位置，单位为微秒
- 参数
-
timeline 时间线
- 返回
- 返回时间线的当前位置值
◆ getVideoFxDescription:
| - (NvsFxDescription *) getVideoFxDescription: | (NSString *) | fxName |
◆ getVideoStabilization
| - (VideoStabilizationFlag) getVideoStabilization |
◆ getZoomFactor
| - (float) getZoomFactor |
◆ grabImageFromTimeline:timestamp:proxyScale:
| - (UIImage *) grabImageFromTimeline: | (NvsTimeline *) | timeline | |
| timestamp: | (int64_t) | timestamp | |
| proxyScale: | (const NvsRational *) | proxyScale | |
获取时间线某一时间戳的图像。详细情况参见视频帧图像提取专题
- 参数
-
timeline 欲获取图像的时间线对象 timestamp 欲获取图像的时间戳(单位是微秒)。timestamp取值范围在[0,timeline.duration - 1]。传入其他值无效，grabImageFromTimeline会返回nil。 proxyScale 代理缩放比例，填写nil表示使用默认比例1:1
- 返回
- 返回该时间戳图像的UIImage对象，如果获取图像失败返回nil
- 自从
- 1.1.2
◆ grabImageFromTimeline:timestamp:proxyScale:flags:
| - (UIImage *) grabImageFromTimeline: | (NvsTimeline *) | timeline | |
| timestamp: | (int64_t) | timestamp | |
| proxyScale: | (const NvsRational *) | proxyScale | |
| flags: | (int) | flags | |
获取时间线某一时间戳的图像。详细情况参见视频帧图像提取专题
- 参数
-
timeline 欲获取图像的时间线对象 timestamp 欲获取图像的时间戳(单位是微秒)。timestamp取值范围在[0,timeline.duration - 1]。传入其他值无效，grabImageFromTimeline会返回nil。 proxyScale 代理缩放比例，填写nil表示使用默认比例1:1 flags 引擎定位的特殊标志。请参见 NvsStreamingEngineSeekFlag
- 返回
- 返回该时间戳图像的UIImage对象，如果获取图像失败返回nil
- 自从
- 1.16.0
◆ grabImageFromTimelineAsync:timestamp:proxyScale:flags:
| - (BOOL) grabImageFromTimelineAsync: | (NvsTimeline *) | timeline | |
| timestamp: | (int64_t) | timestamp | |
| proxyScale: | (const NvsRational *) | proxyScale | |
| flags: | (int) | flags | |
获取时间线某一时间戳的图像。详细情况参见视频帧图像提取专题 这个函数是内部异步调用,需要保证在获取到图像之前不会调用SeekTimeline(),如果在调用这个函数之后调用SeekTimeline的函数有可能收不到图像的回调，可以在这个函数之后调用Stop保证Grab image能执行成功
- 参数
-
timeline 欲获取图像的时间线对象 timestamp 欲获取图像的时间戳（单位微秒）。timestamp取值范围在[0,timeline.duration - 1]。传入其他值无效，grabImageFromTimeline会返回null。 proxyScale 代理缩放比例 flags 引擎定位的特殊标志。具体参见引擎定位标识
- 返回
- 返回布尔值,
- 自从
- 2.15.0
◆ hasARModule
| + (int) hasARModule |
检测当前SDK是否含有AR模块
- 返回
- 返回值0表示不含有AR模块，大于0表示含有AR模块
- 自从
- 2.5.0
◆ initHumanDetection:licenseFilePath:features:
| + (BOOL) initHumanDetection: | (NSString *) | modelFilePath | |
| licenseFilePath: | (NSString *) | licenseFilePath | |
| features: | (int) | features | |
初始化人体检测机制, 只初始化一次
- 参数
-
modelFilePath 人脸模型文件路径 licenseFilePath 授权文件路径 features 人体检测特征标志字段。请参见人体检测特征标志
- 自从
- 2.5.0
◆ initHumanDetectionExt:licenseFilePath:features:
| + (BOOL) initHumanDetectionExt: | (NSString *) | modelFilePath | |
| licenseFilePath: | (NSString *) | licenseFilePath | |
| features: | (int) | features | |
初始化人体检测扩展机制，必须先调用initHumanDetection
- 参数
-
modelFilePath 人脸模型文件路径 licenseFilePath 授权文件路径 features 人体检测特征标志字段。请参见人体检测特征标志
- 自从
- 2.5.0
◆ insertBeautyCaptureVideoFx:
| - (NvsCaptureVideoFx *) insertBeautyCaptureVideoFx: | (unsigned int) | insertPosition |
◆ insertBuiltinCaptureAudioFx:withInsertPosition:
| - (NvsCaptureAudioFx *) insertBuiltinCaptureAudioFx: | (NSString *) | audioFxName | |
| withInsertPosition: | (unsigned int) | insertPosition | |
插入一个内建音频特效
- 参数
-
audioFxName 音频特效名。获取音频特效名称，请参见getAllBuiltinCaptureAudioFxNames()或内建特效名称列表。 insertPosition 插入位置，是指特效的渲染顺序
- 返回
- 返回插入的内建音频特效对象
- 参见
- appendBuiltinCaptureAudioFx
- 自从
- 2.21.0
◆ insertBuiltinCaptureVideoFx:withInsertPosition:
| - (NvsCaptureVideoFx *) insertBuiltinCaptureVideoFx: | (NSString *) | videoFxName | |
| withInsertPosition: | (unsigned int) | insertPosition | |
插入一个内建视频特效
- 参数
-
videoFxName 视频特效名。获取视频特效名称，请参见getAllBuiltinCaptureVideoFxNames()或内建特效名称列表。 insertPosition 插入位置，是指特效的渲染顺序
- 返回
- 返回插入的内建视频特效对象
◆ insertCaptureAnimatedSticker:duration:animatedStickerPackageId:insertPosition:
| - (NvsCaptureAnimatedSticker *) insertCaptureAnimatedSticker: | (int64_t) | offsetTime | |
| duration: | (int64_t) | duration | |
| animatedStickerPackageId: | (NSString *) | animatedStickerPackageId | |
| insertPosition: | (unsigned int) | insertPosition | |
追加一个动画贴纸
- 参数
-
offsetTime 动画贴纸的偏移时间。 duration 动画贴纸的持续时间。 animatedStickerPackageId 动画贴纸包Id。 insertPosition 插入位置.
- 返回
- 返回采集动画贴纸对象
以下情况会返回null：
1.没有动画贴纸功能授权；
2.animatedStickerPackageId参数为空字符串或者null；
3.该动画贴纸包没有安装成功；
- 参见
- appendCaptureAnimatedSticker
- 自从
- 2.21.0
◆ insertCaptureCaption:offsetTime:duration:captionStylePackageId:insertPosition:
| - (NvsCaptureCaption *) insertCaptureCaption: | (NSString *) | captionText | |
| offsetTime: | (int64_t) | offsetTime | |
| duration: | (int64_t) | duration | |
| captionStylePackageId: | (NSString *) | captionStylePackageId | |
| insertPosition: | (unsigned int) | insertPosition | |
插入一个字幕
- 参数
-
captionText 字幕的文字 offsetTime 字幕的偏移时间。 duration 字幕的持续时间。 captionStylePackageId 字幕样式包Id，不存在的话，可以传空字符串或者null insertPosition 插入位置.
- 返回
- 返回采集字幕对象
以下情况会返回null：
1.没有复合字幕功能授权；
- 参见
- appendCaptureCompoundCaption
- 自从
- 2.21.0
◆ insertCaptureCompoundCaption:duration:compoundCaptionPackageId:insertPosition:
| - (NvsCaptureCompoundCaption *) insertCaptureCompoundCaption: | (int64_t) | offsetTime | |
| duration: | (int64_t) | duration | |
| compoundCaptionPackageId: | (NSString *) | compoundCaptionPackageId | |
| insertPosition: | (unsigned int) | insertPosition | |
插入一个复合字幕
- 参数
-
offsetTime 复合字幕的偏移时间。 duration 复合字幕的持续时间。 compoundCaptionPackageId 复合字幕包Id。 insertPosition 插入位置.
- 返回
- 返回采集复合字幕对象
以下情况会返回null：
1.没有复合字幕功能授权；
- 参见
- appendCaptureCompoundCaption
- 自从
- 2.21.0
◆ insertCaptureModularCaption:offsetTime:duration:insertPosition:
| - (NvsCaptureCaption *) insertCaptureModularCaption: | (NSString *) | captionText | |
| offsetTime: | (int64_t) | offsetTime | |
| duration: | (int64_t) | duration | |
| insertPosition: | (unsigned int) | insertPosition | |
插入一个模块字幕
- 参数
-
captionText 字幕的文字 offsetTime 字幕的偏移时间。 duration 字幕的持续时间。 insertPosition 插入位置.
- 返回
- 返回采集字幕对象
以下情况会返回null：
1.没有复合字幕功能授权；
- 参见
- appendCaptureCompoundCaption
- 自从
- 2.21.0
◆ insertCustomCaptureAnimatedSticker:duration:animatedStickerPackageId:customImagePath:insertPosition:
| - (NvsCaptureAnimatedSticker *) insertCustomCaptureAnimatedSticker: | (int64_t) | offsetTime | |
| duration: | (int64_t) | duration | |
| animatedStickerPackageId: | (NSString *) | animatedStickerPackageId | |
| customImagePath: | (NSString *) | customImagePath | |
| insertPosition: | (unsigned int) | insertPosition | |
插入一个动画贴纸
- 参数
-
offsetTime 动画贴纸的偏移时间。 duration 动画贴纸的持续时间。 animatedStickerPackageId 动画贴纸包Id。 customImagePath 自定义动画贴纸图像路径（可以是jpg、png图像，或者美摄sdk内部支持的动态caf格式图像） insertPosition 插入位置.
- 返回
- 返回采集动画贴纸对象
以下情况会返回null：
1.没有动画贴纸功能授权；
2.animatedStickerPackageId参数为空字符串或者null；
3.该动画贴纸包没有安装成功；
- 参见
- appendCaptureAnimatedSticker
- 自从
- 3.2.0
◆ insertCustomCaptureVideoFx:withInsertPosition:
| - (NvsCaptureVideoFx *) insertCustomCaptureVideoFx: | (id< NvsCustomVideoFxRenderer >) | customVideoFxRender | |
| withInsertPosition: | (int) | insertPosition | |
插入自定义采集视频特效
- 参数
-
customVideoFxRender 用户实现的自定义视频特效渲染器接口 insertPosition 插入位置，是指特效的渲染顺序
- 返回
- 返回插入的采集视频特效对象
- 警告
- 此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。
- 自从
- 1.7.0
◆ insertPackagedCaptureVideoFx:withInsertPosition:
| - (NvsCaptureVideoFx *) insertPackagedCaptureVideoFx: | (NSString *) | videoFxPackageId | |
| withInsertPosition: | (unsigned int) | insertPosition | |
插入一个包裹视频特效
- 参数
-
videoFxPackageId 视频特效包裹ID insertPosition 插入位置，是指特效的渲染顺序
- 返回
- 返回插入的包裹视频特效对象
◆ isBlackFrame:
| - (BOOL) isBlackFrame: | (UIImage *) | image |
检测是否是纯黑色的图片。
- 参数
-
待检测的image
◆ isCaptureDeviceBackFacing:
| - (BOOL) isCaptureDeviceBackFacing: | (unsigned int) | catpureDeviceIndex |
是否为后置采集设备
- 参数
-
catpureDeviceIndex 采集设备索引
- 返回
- 返回BOOL值。返回YES则是后置采集设备，NO则不是。
◆ isCompilingPaused
| - (BOOL) isCompilingPaused |
◆ isFlashOn
| - (BOOL) isFlashOn |
◆ isPlaybackPaused
| - (BOOL) isPlaybackPaused |
◆ isRecordingPaused
| - (BOOL) isRecordingPaused |
◆ loadProject:resourceDir:
| - (NvsTimeline *) loadProject: | (NSString *) | projectId | |
| resourceDir: | (NSString *) | resourceDir | |
用项目资源创建时间线
- 参数
-
projectId 项目uuid resourceDir 项目资源文件夹路径
- 返回
- 返回创建的时间线对象
- 参见
- removeTimeline
◆ pauseCompiling
| - (BOOL) pauseCompiling |
◆ pausePlayback
| - (BOOL) pausePlayback |
◆ pauseRecording
| - (BOOL) pauseRecording |
暂停录制采集信号。暂停录制之后再继续录制会录制到同一个媒体文件中。注意：只有不使用系统内置recorder时才能暂停录制！
- 返回
- 返回布尔值。值为YES则暂停录制成功，NO则失败。
- 自从
- 1.17.0
◆ playbackTimeline:startTime:endTime:proxyScale:preload:flags:
| - (BOOL) playbackTimeline: | (NvsTimeline *) | timeline | |
| startTime: | (int64_t) | startTime | |
| endTime: | (int64_t) | endTime | |
| proxyScale: | (const NvsRational *) | proxyScale | |
| preload: | (BOOL) | preload | |
| flags: | (int) | flags | |
播放时间线
- 参数
-
timeline 时间线 startTime 开始时间(单位是微秒)。startTime取值范围在[0,timeline.duration - 1]。传入其他值无效，playbackTimeline会返回No导致无法开启播放。 endTime 结束时间(单位是微秒)。如果endTime值传入是负值，则默认播放到视频末尾。 proxyScale 代理缩放比例 preload 是否预先加载 flags 预览的特殊标志，如无特殊需求，请填写0。请参见 NvsStreamingEnginePlaybackFlag
- 返回
- 返回BOOL值。注意：播放时间线是异步操作。返回YES则可以开启播放时间线，NO则无法开启播放。
- 警告
- 此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。
◆ playbackTimeline:startTime:endTime:videoSizeMode:preload:flags:
| - (BOOL) playbackTimeline: | (NvsTimeline *) | timeline | |
| startTime: | (int64_t) | startTime | |
| endTime: | (int64_t) | endTime | |
| videoSizeMode: | (NvsVideoPreviewSizeMode) | videoSizeMode | |
| preload: | (BOOL) | preload | |
| flags: | (int) | flags | |
播放时间线
- 参数
-
timeline 时间线 startTime 开始时间(单位是微秒)。startTime取值范围在[0,timeline.duration - 1]。传入其他值无效，playbackTimeline会返回No导致无法开启播放。 endTime 结束时间(单位是微秒)。如果endTime值传入是负值，则默认播放到视频末尾。 videoSizeMode 图像预览模式 preload 是否预先加载 flags 预览的特殊标志，如无特殊需求，请填写0。请参见 NvsStreamingEnginePlaybackFlag
- 返回
- 返回BOOL值。注意：播放时间线是异步操作。返回YES则可以开启播放时间线，NO则无法开启播放。
- 警告
- 此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。
◆ preloadEffectResources
| - (BOOL) preloadEffectResources |
预加载特技资源
- 自从
- 2.18.1
◆ registerFontByFilePath:
| - (NSString*) registerFontByFilePath: | (NSString *) | fontFilePath |
获取字体文件的fontFamily
- 参数
-
fontFilePath 字体文件路径
- 返回
- 返回字体的fontFamily
◆ removeAllCaptureAnimatedSticker
| - (void) removeAllCaptureAnimatedSticker |
◆ removeAllCaptureAudioFx
| - (void) removeAllCaptureAudioFx |
◆ removeAllCaptureCaption
| - (void) removeAllCaptureCaption |
移除所有采集字幕
- 自从
- 2.21.0
◆ removeAllCaptureCompoundCaption
| - (void) removeAllCaptureCompoundCaption |
移除所有采集复合字幕
- 自从
- 2.21.0
◆ removeAllCaptureVideoFx
| - (void) removeAllCaptureVideoFx |
移除所有采集视频特效
◆ removeCaptureAnimatedSticker:
| - (BOOL) removeCaptureAnimatedSticker: | (unsigned int) | captureAnimagedStickerIndex |
对移除特定索引值的采集动画贴纸
- 参数
-
captureVideoFxIndex 动画贴纸索引
- 返回
- 返回boolean值。返回YES则移除成功，NO则失败
- 参见
- appendCaptureAnimatedSticker
- 自从
- 2.21.0
◆ removeCaptureAudioFx:
| - (BOOL) removeCaptureAudioFx: | (unsigned int) | captureAudioFxIndex |
对移除特定索引值的采集音频特效
- 参数
-
captureVideoFxIndex 音频特效索引
- 返回
- 返回boolean值。返回YES则移除成功，NO则失败
- 参见
- appendBuiltinCaptureAudioFx
- 自从
- 2.21.0
◆ removeCaptureCaption:
| - (BOOL) removeCaptureCaption: | (unsigned int) | captureCaptionIndex |
对移除特定索引值的采集字幕
- 参数
-
captureCompoundCaptionIndex 字幕贴纸索引
- 返回
- 返回boolean值。返回YES则移除成功，NO则失败
- 自从
- 2.21.0
◆ removeCaptureCompoundCaption:
| - (BOOL) removeCaptureCompoundCaption: | (unsigned int) | captureCompoundCaptionIndex |
对移除特定索引值的采集复合字幕
- 参数
-
captureCompoundCaptionIndex 复合字幕索引
- 返回
- 返回boolean值。返回YES则移除成功，NO则失败
- 自从
- 2.21.0
◆ removeCaptureVideoFx:
| - (BOOL) removeCaptureVideoFx: | (unsigned int) | captureVideoFxIndex |
对移除特定索引值的采集视频特效
- 参数
-
captureVideoFxIndex 视频特效索引
- 返回
- 返回BOOL值。返回YES则移除成功，NO则失败
◆ removeCurrentCaptureScene
| - (void) removeCurrentCaptureScene |
◆ removeTimeline:
| - (BOOL) removeTimeline: | (NvsTimeline *) | timeline |
◆ removeUserWatermarkForCapture
| - (void) removeUserWatermarkForCapture |
移除为视频采集添加的用户水印。
- 自从
- 2.0.1
◆ resumeCompiling
| - (BOOL) resumeCompiling |
◆ resumePlayback
| - (BOOL) resumePlayback |
◆ resumeRecording
| - (BOOL) resumeRecording |
◆ sampleColorFromCapturedVideoFrame:
| - (NvsColor) sampleColorFromCapturedVideoFrame: | (CGRect) | sampleRect |
对采集设备的视频帧内容进行采样
- 参数
-
sampleRect 采样的矩形区域，坐标为实时预览窗口的自身坐标系
- 返回
- 返回值为采样的颜色值，该颜色值是采样的矩形区域内所有像素颜色的平均值
- 自从
- 1.2.0
◆ seekTimeline:timestamp:proxyScale:flags:
| - (BOOL) seekTimeline: | (NvsTimeline *) | timeline | |
| timestamp: | (int64_t) | timestamp | |
| proxyScale: | (const NvsRational *) | proxyScale | |
| flags: | (int) | flags | |
定位某一时间戳的图像
- 参数
-
timeline 时间线 timestamp 时间戳(单位是微秒)。timestamp取值范围在[0,timeline.duration - 1]。传入其他值无效，seekTimeline会返回No,导致无法开启定位。 proxyScale 代理缩放比例 flags 引擎定位的特殊标志。请参见 NvsStreamingEngineSeekFlag
- 返回
- 返回BOOL值。注意：定位某时间戳图像是异步操作。返回值为YES则成功开启定位，NO则无法开启定位。
- 警告
- 此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。
◆ seekTimeline:timestamp:videoSizeMode:flags:
| - (BOOL) seekTimeline: | (NvsTimeline *) | timeline | |
| timestamp: | (int64_t) | timestamp | |
| videoSizeMode: | (NvsVideoPreviewSizeMode) | videoSizeMode | |
| flags: | (int) | flags | |
定位某一时间戳的图像
- 参数
-
timeline 时间线 timestamp 时间戳(单位是微秒)。timestamp取值范围在[0,timeline.duration - 1]。传入其他值无效，seekTimeline会返回No,导致无法开启定位。 videoSizeMode 图像预览模式 flags 引擎定位的特殊标志。请参见 NvsStreamingEngineSeekFlag
- 返回
- 返回BOOL值。注意：定位某时间戳图像是异步操作。返回值为YES则成功开启定位，NO则无法开启定位。
- 警告
- 此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题。
◆ sendBufferToCapturePreview:
| - (BOOL) sendBufferToCapturePreview: | (const NvsVideoFrameInfo *) | data |
输入buffer给采集设备预览
- 参数
-
data 输入buffer的数据和相应信息。仅支持NV12格式的数据
- 返回
- 返回BOOL值。
- 参见
- startBufferCapturePreview
◆ setAudioOutputDeviceVolume:
| - (void) setAudioOutputDeviceVolume: | (float) | volume |
设置音频输出设备音量
- 参数
-
volume 新的音量 取值范围[0,1]
- 自从
- 2.14.0
◆ setAudioSampleInfoForCallback:
| - (void) setAudioSampleInfoForCallback: | (NvsCapturedAudioSampleInfo *) | info |
设置需要回调的采集音频信息
- 参数
-
info 采集音频信息
◆ setAudioVUMeterEnabled:
| - (void) setAudioVUMeterEnabled: | (BOOL) | enable |
设置是否输出音频输出的DB值
- 参数
-
enable 是否输出
- 自从
- 2.20.0
◆ setCaptureFps:
| - (void) setCaptureFps: | (int) | fps |
设置采集帧率。
- 参数
-
fps 每秒钟的帧数量
◆ setColorGainForSDRToHDR:
| - (void) setColorGainForSDRToHDR: | (float) | gain |
◆ setCustomCompileVideoHeight:
| - (void) setCustomCompileVideoHeight: | (unsigned int) | videoHeight |
设置自定义的生成视频高度。
在生成时视频时，设置生成视频的分辨率高度级别为NvsCompileVideoResolutionGradeCustom 就可以使用自定义的生成视频高度。但是请注意，为了保证视频生成成功，美摄SDK会对高度进行适当的对齐， 因此最终生成的视频高度不一定就是这里设置的高度！
- 参数
-
videoHeight 自定义的生成视频高度
- 自从
- 1.6.1
- 参见
- compileTimeline
◆ setDebugLevel:
| + (void) setDebugLevel: | (NvsDebugLevel) | debugLevel |
设置Debug的级别
- 参数
-
debugLevel 的级别
- 自从
- 3.6.0
◆ setDefaultAudioTransitionName:
| - (void) setDefaultAudioTransitionName: | (NSString *) | name |
◆ setDefaultImageClipDuration:
| - (void) setDefaultImageClipDuration: | (int64_t) | defaultImageClipDuration |
设置缺省图像片段持续时长
- 参数
-
defaultImageClipDuration 图像片段持续时长
- 自从
- 3.4.0
◆ setDefaultThemeEndingLogoImageFilePath:
| - (BOOL) setDefaultThemeEndingLogoImageFilePath: | (NSString *) | logoImageFilePath |
设置默认主题logo图片路径
- 参数
-
logoImageFilePath logo图片文件路径
- 返回
- 返回BOOL值。YES 设置成功；NO 设置失败
◆ setEnableAudioSampleNotify:
| - (void) setEnableAudioSampleNotify: | (BOOL) | enable |
设置是否输出音频sample
- 参数
-
enable 是否输出
- 自从
- 3.2.0
◆ setExposureBias:
| - (void) setExposureBias: | (float) | exposureBias |
◆ setFxPluginBundlePathList:
| + (void) setFxPluginBundlePathList: | (NSArray *) | list |
设置特效插件路径。
- 参数
-
特效插件路径数组
◆ setImageReaderCount:
| - (void) setImageReaderCount: | ("Use +setMaxImageReaderCount:") | ||
| (macos(10.3, 10.11)) | |||
| (ios(7.0, 8.0)) | API_DEPRECATED | ||
设置image reader 最大个数。
- 参数
-
image reader 最大个数
◆ setMaxAudioReaderCount:
| + (void) setMaxAudioReaderCount: | (int) | count |
设置 audio reader 最大个数。
- 参数
-
audio reader 最大个数
◆ setMaxCafCacheMemorySize:
| + (void) setMaxCafCacheMemorySize: | (int) | maxMemorySize |
设置caf的最大缓存。
- 参数
-
maxMemorySize 最大缓存
◆ setMaxCompileCaptionCachedContextCount:
| + (void) setMaxCompileCaptionCachedContextCount: | (int) | count |
设置导出时缓存的caption context 最大个数。
- 参数
-
缓存的caption context 最大个数
◆ setMaxEditCaptionCachedContextCount:
| + (void) setMaxEditCaptionCachedContextCount: | (int) | count |
设置编辑时缓存的caption context 最大个数。
- 参数
-
缓存的caption context 最大个数
◆ setMaxIconReaderCount:
| + (void) setMaxIconReaderCount: | (int) | count |
设置 icon reader 最大个数。
- 参数
-
icon reader 最大个数
◆ setMaxImageReaderCount:
| + (void) setMaxImageReaderCount: | (int) | count |
设置max image reader 最大个数。
- 参数
-
max image reader 最大个数
◆ setMaxReaderCount:
| + (void) setMaxReaderCount: | (int) | count |
设置 file reader 最大个数。
- 参数
-
file reader 最大个数
◆ setSaveDebugMessagesToFile:
| + (void) setSaveDebugMessagesToFile: | (BOOL) | saveDebugMessagesToFile |
设置是否将SDK的调试信息写入到文件中
- 参数
-
saveDebugMessagesToFile 是否将SDK的调试信息写入到文件中
- 自从
- 1.17.0
◆ setSpecialCameraDeviceType:
| + (void) setSpecialCameraDeviceType: | (NSString *) | specialCameraType |
设置特殊的Camera 的设备类型。
- 参数
-
specialCameraType 特殊设备类型
◆ setStreamingPoolSizeInByte:
| + (void) setStreamingPoolSizeInByte: | (int) | maxMemorySize |
设置max image reader 最大个数。
- 参数
-
max image reader 最大个数
◆ setTemplate:customResourceDir:
| - (void) setTemplate: | (NSString *) | templateUuid | |
| customResourceDir: | (NSString *) | customResourceDir | |
设置模版自定义资源所在文件夹
- 参数
-
templateUuid 模版资源包ID customResourceDir 模版资源文件夹路径
◆ setThemeEndingEnabled:
| - (BOOL) setThemeEndingEnabled: | (BOOL) | enable |
◆ setupHumanDetectionData:dataFilePath:
| + (BOOL) setupHumanDetectionData: | (int) | dataType | |
| dataFilePath: | (NSString *) | dataFilePath | |
◆ setUserWatermarkForCapture:displayWidth:displayHeight:opacity:position:marginX:marginY:
| - (void) setUserWatermarkForCapture: | (NSString *) | watermarkFilePath | |
| displayWidth: | (int) | displayWidth | |
| displayHeight: | (int) | displayHeight | |
| opacity: | (float) | opacity | |
| position: | (NvsTimelineWatermarkPosition) | position | |
| marginX: | (int) | marginX | |
| marginY: | (int) | marginY | |
为视频采集添加用户水印
- 参数
-
watermarkFilePath 水印文件的路径，须为PNG或JPG文件 displayWidth 水印在视频预览画面中显示的宽度，为0则使用图片文件的宽度 displayHeight 水印在视频预览画面中显示的高度，为0则使用图片文件的高度 opacity 水印的不透明度, 取值范围 0~1 position 水印的位置，请参见 NvsTimelineWatermarkPosition marginX 水印在X方向的边距 marginY 水印在Y方向的边距
- 自从
- 2.0.1
◆ setVideoStabilization:
| - (void) setVideoStabilization: | (VideoStabilizationFlag) | flags |
◆ setZoomFactor:
| - (void) setZoomFactor: | (float) | zoomFactor |
◆ sharedInstance
| + (NvsStreamingContext *) sharedInstance |
◆ sharedInstanceWithFlags:
| + (NvsStreamingContext *) sharedInstanceWithFlags: | (NvsStreamingContextFlag) | flags |
◆ startAutoExposure:
| - (void) startAutoExposure: | (CGPoint) | pointOfInterest |
启动自动曝光调节
- 参数
-
pointOfInterest 曝光调节点
◆ startAutoFocus:
| - (void) startAutoFocus: | (CGPoint) | focusPointOfInterest |
◆ startBufferCapturePreview:height:fps:rotation:flipHorizontally:
| - (BOOL) startBufferCapturePreview: | (unsigned int) | width | |
| height: | (unsigned int) | height | |
| fps: | (const NvsRational *) | fps | |
| rotation: | (int) | rotation | |
| flipHorizontally: | (BOOL) | flipHorizontally | |
启动输入buffer模式的采集设备预览
- 参数
-
width 输入buffer的宽 height 输入buffer的高 fps 输入buffer的帧率 rotation 输入buffer的图像旋转角度。请参见 输入buffer的图像旋转角度 flipHorizontally 是否需要水平翻转
- 返回
- 返回BOOL值。返回YES则启动预览成功，NO则启动预览失败。
- 参见
- sendBufferToCapturePreview
◆ startCapturePreview:videoResGrade:flags:aspectRatio:
| - (BOOL) startCapturePreview: | (unsigned int) | captureDeviceIndex | |
| videoResGrade: | (NvsVideoCaptureResolutionGrade) | videoResGrade | |
| flags: | (int) | flags | |
| aspectRatio: | (const NvsRational *) | aspectRatio | |
启动采集设备预览
- 参数
-
captureDeviceIndex 采集设备索引 videoResGrade 视频采集分辨率级别。视频分辨率等级是指录制时所拍摄视频短边（即可能是宽度或者是高度）的分辨率值，根据视频横纵比aspectRatio(值为nil则由系统采集设备来决定横纵比)计算得到另一边（即可能是宽度或者是高度）的值。 其包括三种级别，分别是LOW，MEDIUM，HIGH，前置摄像头依次对应480p，540p，720p，后置摄像头依次对应540p，720p，1080p。如果有用户想自定义录制视频的等级， 例如540 * 960,则需要拍摄等横纵比的视频，通过创建宽高依次是540和960的时间线，编辑然后生成。生成时，生成分辨率高度等级里面没有960p的等级，因此需要在生成前调用 setCustomCompileVideoHeight()接口来自定义高度，然后调用生成接口compileTimeline()，生成高度级别设置为NvsCompileVideoResolutionGradeCustom即可。实例代码如下： NvsVideoResolution videoEditRes; videoEditRes.imageWidth = 540; videoEditRes.imageHeight = 960; videoEditRes.imagePAR = (NvsRational){1, 1}; NvsRational videoFps = {25, 1}; NvsAudioResolution audioEditRes; audioEditRes.sampleRate = 48000; audioEditRes.channelCount = 2; audioEditRes.sampleFormat = NvsAudSmpFmt_S16; self.timeline = [_context createTimeline:&videoEditRes videoFps:&videoFps audioEditRes:&audioEditRes]; [_context setCustomCompileVideoHeight:960]; [self.context compileTimeline:self.timeline startTime:0 endTime:self.timeline.duration outputFilePath:videoPath videoResolutionGrade:NvsCompileVideoResolutionGradeCustom videoBitrateGrade:NvsCompileBitrateGradeMedium flags:0];flags 标志字段，如无特殊需求请填写0。请参见 NvsStreamingEngineCaptureFlag。每个Flag应用场景如下：
NvsStreamingEngineCaptureFlag_GrabCapturedVideoFrame用于视频抠像；
NvsStreamingEngineCaptureFlag_StrictPreviewVideoSize与NvsStreamingEngineCaptureFlag_CaptureBuddyHostVideoFrame结合用于人脸检测；
NvsStreamingEngineCaptureFlag_DontCaptureAudio用于视频直播，不采集音频流，一般不常用。aspectRatio 预览视频横纵比，传入nil则由系统采集设备来决定横纵比
- 返回
- 返回BOOL值。返回YES则启动预览成功，NO则启动预览失败。
◆ startContinuousFocus
| - (void) startContinuousFocus |
启动连续聚焦
◆ startRecording:
| - (BOOL) startRecording: | (NSString *) | outputFilePath |
◆ startRecording:withFlags:
| - (BOOL) startRecording: | (NSString *) | outputFilePath | |
| withFlags: | (int) | flags | |
启动录制采集设备信号。请参见视频录制方式
- 参数
-
outputFilePath 录制文件的路径。注意: 我们建议输出.mov格式的文件 flags 标志字段，如无特殊需求请填写0。请参见 NvsStreamingEngineRecordingFlag
- 返回
- 返回BOOL值。返回YES则启动录制成功，NO则启动失败。
- 自从
- 1.5.1
◆ startRecording:withFlags:withRecordConfigurations:
| - (BOOL) startRecording: | (NSString *) | outputFilePath | |
| withFlags: | (int) | flags | |
| withRecordConfigurations: | (NSMutableDictionary *) | withRecordConfigurations | |
启动录制采集设备信号。请参见视频录制方式
- 参数
-
outputFilePath 录制文件的路径。注意: 我们建议输出.mov格式的文件 flags 标志字段，如无特殊需求请填写0。请参见 NvsStreamingEngineRecordingFlag withRecordConfigurations 录制视频配置。NSMutableDictionary中关键字的值请参见 录制视频配置
例如：NSMutableDictionary *config = [[NSMutableDictionary alloc] init]; [config setValue:[NSNumber numberWithInteger:15] forKey:NVS_RECORD_GOP_SIZE]; // 设置为1即是生成全I帧视频 [config setValue:[NSNumber numberWithInteger:10000000] forKey:NVS_RECORD_BITRATE]; // 10M bps
- 返回
- 返回BOOL值。返回YES则启动录制成功，NO则启动失败。
- 自从
- 1.16.0
◆ startRecordingWithFx:
| - (BOOL) startRecordingWithFx: | (NSString *) | outputFilePath |
启动采集设备的录制，录制的内容包含所有的特效处理效果。
注意：如果特效处理过于复杂可能会导致录制的视频丢帧，所以使用这个方法一定要慎重，要确保特效的处理对于当前 手机是完全可以实时处理的。请参见视频录制方式
- 参数
-
outputFilePath 录制文件的路径。我们建议输出.mov格式的文件
- 返回
- 返回BOOL值。返回YES则启动录制成功，NO则启动失败。
◆ startRecordingWithFx:withFlags:
| - (BOOL) startRecordingWithFx: | (NSString *) | outputFilePath | |
| withFlags: | (int) | flags | |
启动采集设备的录制，录制的内容包含所有的特效处理效果。
注意：如果特效处理过于复杂可能会导致录制的视频丢帧，所以使用这个方法一定要慎重，要确保特效的处理对于当前 手机是完全可以实时处理的。请参见视频录制方式
- 参数
-
outputFilePath 录制文件的路径。我们建议输出.mov格式的文件 flags 标志字段，如无特殊需求请填写0。请参见 NvsStreamingEngineRecordingFlag
- 返回
- 返回BOOL值。返回YES则启动录制成功，NO则启动失败。
- 自从
- 1.5.1
◆ startRecordingWithFx:withFlags:withRecordConfigurations:
| - (BOOL) startRecordingWithFx: | (NSString *) | outputFilePath | |
| withFlags: | (int) | flags | |
| withRecordConfigurations: | (NSMutableDictionary *) | withRecordConfigurations | |
启动录制采集设备信号。请参见视频录制方式
- 参数
-
outputFilePath 录制文件的路径。注意: 我们建议输出.mov格式的文件 flags 标志字段，如无特殊需求请填写0。请参见 NvsStreamingEngineRecordingFlag withRecordConfigurations 录制视频配置。NSMutableDictionary中关键字的值请参见 录制视频配置 例如：NSMutableDictionary *config = [[NSMutableDictionary alloc] init]; [config setValue:[NSNumber numberWithInteger:15] forKey:NVS_RECORD_GOP_SIZE]; // 设置为1即是生成全I帧视频 [config setValue:[NSNumber numberWithInteger:10000000] forKey:NVS_RECORD_BITRATE]; // 10M bps
- 返回
- 返回BOOL值。返回YES则启动录制成功，NO则启动失败。
- 自从
- 1.16.0
◆ stop
| - (void) stop |
停止引擎
◆ stop:
| - (void) stop: | (int) | flags |
◆ stopRecording
| - (void) stopRecording |
结束录制采集设备信号
◆ takePicture:
| - (BOOL) takePicture: | (int) | flags |
以最接近预览比例的摄像头的最大分辨率拍摄一张照片
- 参数
-
flags 拍照的标志，目前没有使用， 值为0
◆ toggleFlash:
| - (void) toggleFlash: | (BOOL) | on |
◆ toggleFlashMode:
| - (void) toggleFlashMode: | (NvsCameraFlashMode) | mode |
◆ verifySdkLicenseFile:
| + (BOOL) verifySdkLicenseFile: | (NSString *) | sdkLicenseFilePath |
验证SDK授权文件。注意：授权文件接口必须在NvsStreamingContext初始化之前调用。
- 参数
-
sdkLicenseFilePath SDK授权文件路径
- 返回
- 返回BOOL值。YES表示授权验证成功，NO则验证失败。若验证失败，则后续的视频预览和生成视频会出现水印。
属性说明
◆ assetPackageManager
|
readatomicassign |
包管理器
◆ compileConfigurations
|
readwritenonatomicassign |
生成时间线配置，设置一次即一直生效。NSMutableDictionary中关键字的值请参见 生成时间线的配置 例如：NSMutableDictionary *config = [[NSMutableDictionary alloc] init]; [config setValue:[NSNumber numberWithInteger:15] forKey:NVS_COMPILE_GOP_SIZE]; // 设置为1即是生成全I帧视频 [config setValue:[NSNumber numberWithInteger:10000000] forKey:NVS_COMPILE_BITRATE]; // 10M bps [config setValue:[NSNumber numberWithInteger:256000] forKey:NVS_COMPILE_AUDIO_BITRATE]; // 设置音频码率为256Kbps [config setValue:[NSNumber numberWithBool:YES] forKey:NVS_COMPILE_LOSSLESS_AUDIO]; // 设置生成无损音频 [config setValue:[NSNumber numberWithBool:YES] forKey:NVS_COMPILE_OPTIMIZE_FOR_NETWORK_USE]; // 设置索引表前置 NvsRational videoFps = {12, 1}; [config setValue:[NSData dataWithBytes:&videoFps length:sizeof(NvsRational)] forKey:NVS_COMPILE_VIDEO_FPS]; // 设置帧速率FPS _streamingContext.compileConfigurations = config; 取消设置并恢复默认方式例如：[_streamingContext.compileConfigurations setValue:nil forKey:NVS_COMPILE_GOP_SIZE];
- 自从
- 1.8.0
◆ compileVideoBitrateMultiplier
|
readwritenonatomicassign |
生成视频码率倍乘系数
- 自从
- 1.5.0
◆ defaultCaptionFade
|
readwritenonatomicassign |
默认字幕是否为淡入淡出
- 自从
- 1.8.0
◆ delegate
|
readwritenonatomicweak |
◆ imageGrabberDelegate
|
readwritenonatomicweak |
◆ recordVideoBitrateMultiplier
|
readwritenonatomicassign |
录制视频码率倍乘系数
- 自从
- 1.5.0
该类的文档由以下文件生成:
- include/sdkcore/ios/NvsStreamingContext.h
