美摄Web端SDK  3.12.1
类 | 函数 | 变量
NvStreamingSdk.js 文件参考

SDK WEB应用文档 更多...

类

class  NvsEventEmitter
 事件发射器 更多...
 
class  NvsSdkVersion
 SDK版本号 更多...
 
class  NvsRational
 比例值 更多...
 
class  NvsVideoResolution
 视频分辨率 更多...
 
class  NvsAudioResolution
 音频解析度 更多...
 
class  NvsLiveWindow
 视频预览窗口 更多...
 
class  NvsVectorFloat
 浮点类型数组 更多...
 
class  NvsVectorVal
 对象类型数组 更多...
 
class  NvsAIToningInfo
 AI调色信息 更多...
 
class  NvsStreamingContext
 流媒体上下文：流媒体上下文类可视作整个SDK框架的入口。开发过程中，NvsStreamingContext提供了静态sharedInstance接口创建流媒体上下文的唯一实例。 通过这个实例对象，我们可以开启采集设备录制视频，添加采集视频特效，设置拍摄时的各项参数，包括自动聚焦，自动曝光调节， 开关换补光灯等。同时还能够创建时间线，并将时间线与实时预览窗口连接起来，实时预览播放已经拍摄完成的视频。整个视频制作完成后，要销毁流媒体上下文的对象实例。 带特效拍摄时，添加素材资源包(采集特效包，场景资源包等)，都得先安装，安装成功后获取packageId才能使用，而内建采集特效(builtin)只需获取特效名称即可使用。sdk接口中凡是需要传入资源、授权等文件路径时一定是全路径。 更多...
 
class  NvsProjObj
 工程对象 更多...
 
class  NvsCaptionBoundingVerticesInfo
 字幕的原始包围矩形的顶点位置信息类 更多...
 
class  NvsClipBoundingVerticesInfo
 视频片段的原始包围矩形的顶点位置信息类 更多...
 
class  NvsTimeline
 时间线类：编辑场景的时间轴实体，时间线由轨道组成，可视作一系列音视频轨道的集合。在时间线上可添加或者移除多条视频轨道和音轨轨道，多条轨道之间是相互叠加合成的关系。 当编辑视频时，根据需要还会添加上时间线字幕，主题以及相应的动画贴纸，以制作出美观的视频。另外，添加素材资源包(主题包，动画贴纸包，字幕样式包，时间线特效包等)， 都得先安装，安装成功后获取packageId才能使用，而内建时间线特效(builtin)只需获取特效名称即可使用。 更多...
 
class  NvsTrack
 轨道类：轨道，容纳片段的结构。轨道可视作片段的集合,分为音频轨道(Audio Track)和视频轨道(Video Track)。创建时间线实例后，可添加或移除多条轨道。在每一条轨道上，可以添加多个要编辑的视音频片段，并对片段进行音量设置，也可以进行移除和位置移动。 更多...
 
class  NvsVideoTrack
 视频轨道类：视频片段的集合。视频轨道是容纳视频片段的实体，可以添加、插入、删移多个视频片段。视频轨道随着片段的增加不断延展，而片段与片段之间可进行视频转场设置。 添加包裹转场时，都得先安装，安装成功后获取packageId才能使用，而内建转场(builtin)只需获取转场名称即可使用。 注：视频片段的索引都是从0开始。 更多...
 
class  NvsAudioTrack
 音频轨道，音频片段的集合。音频轨道是容纳音频片段的实体。每条音频轨道可以添加或者移除多个音频片段。一个音频片段播放到另一个音频片段时，需要进行音频转场设置，以便过渡衔接。注：对于音频轨道的一系列接口及所其属参数含义,请参照视频轨道NvsVideoTrack的对应接口来对照理解。 更多...
 
class  NvsClip
 片段，音视频文件的具体描述。片段是容纳音视频内容的实体，是对视频、音频文件的描述，分为音频片段(Audio Clip)和视频片段(Video Clip)。它定义了不同类型片段所拥有的共同属性和行为， 即派生的音频片段和和视频片段可根据需要修改各自的裁剪出入点，左右声道，播放速度等。在SDK框架中，在轨道(Track)上可添加相应的音频片段和视频片段。 更多...
 
class  NvsVideoClip
 视频片段，对视频文件的描述。视频片段源可以是视频或者图片。每个视频片段可以修改其裁剪入点、裁剪出点以及播放速度，也可以设置摇摄和扫描。编辑视频时，可以按特效类型的不同（内建特效，包裹式特效，美颜特效）添加或者插入多个视频特效。 添加资源包特效时，都得先安装，安装成功后获取packageId才能使用，而内建特效(builtin)只需获取特效名称即可使用。 更多...
 
class  NvsAudioClip
 音频片段，对音频文件的描述。音频片段既可以修改其裁剪入点和出点，播放速度等，还可以添加、插入、移除以及获取多个音频特效。 更多...
 
class  NvsPanAndScan
 遥感扫描类 更多...
 
class  NvsVolume
 音量类，设置音量的左右声道 更多...
 
class  NvsColor
 自定义颜色类 SDK中，NvsColor类属性r,g,b,a取值范围是[0,1]，而非[0,255]。 更多...
 
class  NvsPointF
 二维坐标点结构。 参数类型为双精度浮点数。 更多...
 
class  NvsRectF
 矩形类 更多...
 
class  NvsWatermarkInfo
 水印信息类 更多...
 
class  NvsAssetPackageManager
 资源包管理器，管理视频场景中的资源包。 在SDK开发过中，资源包管理器统一对需要的各种特技资源包，包括字幕、动画贴纸等进行相应的安装，升级，卸载等操作。 在安装，升级，卸载时，出现差错都会有相应的错误提示类型，以便快速定位和解决错误。 更多...
 
class  NvsRegionInfo
 区域信息类 更多...
 
class  NvsKeyframeParamInfo
 关键帧参数类 更多...
 
class  NvsFx
 特效类。特效类是视频特效(Video Fx)，音频特效(Audio Fx)，音频转场(Audio Transition)，视频转场(Video Transition)等不同类型特效的基类。 在SDK框架中，特效是很关键的一部分，派生自NvsFx的每种不同类型的特效，或通过片段实例，或时间线实例，或轨道实例来添加，移除和获取。 同时，特效类中提供了不同的API接口来设置和获取特效参数类型。\ 更多...
 
class  NvsTimelineVideoFx
 时间线视频特效 时间线视频特效是作用于时间线实例上的视频特效。 时间线视频特效分为內建特效、包裹特效和自定义特效三种类型。 內建特效是集成在sdk内部的，不需要授权即可直接使用。包裹特效是将特效资源整合成了特效包，每个特效包都有其一一对应的授权文件，并且要先安装再使用，具体情况请参见素材包安装 自定义特效是用户通过编写代码实现的特效 时间线视频特效包含特效入点和出点，通过入点和出点我们可以指定特效作用于时间线的位置和长度，入点要小于出点，单位为微秒。 时间线视频特效允许叠加，渲染顺序通过预设Z值控制。 更多...
 
class  NvsCaptionSpan
 字幕layout属性类 更多...
 
class  NvsCaption
 时间线字幕是叠加在视频上的自定义文本。编辑视频时，您可以添加和删除时间线字幕并调整字幕位置。添加字幕后，还可以设置样式，包括字体大小、颜色、阴影、描边等。 更多...
 
class  NvsTimelineCaption
 时间线字幕是视频上叠加的自定义文字。编辑视频时，可以添加和移除时间线字幕，并对字幕位置进行调整处理。添加完字幕，还可以进行样式设置，包括字体大小，颜色，阴影，描边等。 更多...
 
class  NvsMotionParameters
 运动参数 更多...
 
class  NvsCompoundCaption
 时间线复合字幕。时间线复合字幕是视频上叠加的组合型文字，每个复合字幕包含若干个子字幕。编辑视频时，可以添加和移除时间线复合字幕，并对字幕位置进行调整处理，还可以对字体，颜色属性进行修改。 更多...
 
class  NvsTimelineCompoundCaption
 时间线复合字幕。 更多...
 
class  NvsAnimatedSticker
 动画贴纸类。动画贴纸是视频编辑时使用的一种美化特效，可以产生动画效果。 用户可以在时间线上添加和移除动画贴纸，也可以通过各种API调整贴纸的各种属性，如位置、大小、显示时间等等。 更多...
 
class  NvsTimelineAnimatedSticker
 时间线动画贴纸类。 更多...
 
class  NvsVideoTransition
 视频转场，片段间切换的特效。轨道上有多个片段，转场是从一个视频片段播放到另一个视频片段的衔接过渡效果，而在有间隙的片段之间不能添加视频转场。目前支持多种视频转场， 包括Fade(淡入淡出)、Turning(翻转)、Swap(层叠)、Stretch In(伸展进入)、Page Curl(卷页)、Lens Flare(镜头眩光)、Star(星形)、Dip To Black(闪黑)、Dip To White(闪白)、 Push To Right(右推拉)、Push To Top(上推拉)、Upper Left Into(斜推)。每种视频转场都可通过视频轨道(NvsVideoTrack)来设置和获取。默认转场是Fade(淡入淡出)。 更多...
 
class  NvsAudioTransition
 音频转场,音频片段间切换的特效。一般通过音频轨道(Audio Track)来设置和获取音频转场。目前默认音频转场是淡入淡出转场(fade)。 更多...
 
class  NvsVideoFx
 视频特效。视频特效是显示在视频片段上的特效，能够改变视频图像整体或者局部的颜色、亮度、透明度等，使视频显示出特殊的效果。在视频片段(Video Clip)上，可以添加、移除、获取多个视频特效。 更多...
 
class  NvsAudioFx
 音频特效。音频特效是叠加显示在音频片段上的特效，可以改变音频片段的声调和速率。获取音频片段(Audio Clip)对象实例后，根据需要来添加或者移除多个音频特效。 更多...
 
class  NvsParamInfoObject
 参数信息对象类 更多...
 
class  NvsTranslationInfo
 翻译信息类 更多...
 
class  NvsFxDescription
 特效参数描述类。在视频拍摄和编辑时会设置各种不同参数类型的特效，特效参数描述类就是专门用来获取各种特效参数值的，以便查看和了解。 更多...
 
class  NvsCurveInfo
 曲线信息类 更多...
 
class  NvsEmitterCurveInfo
 粒子发射器曲线信息类 更多...
 
class  NvsParticleSystemContext
 粒子特效上下文 粒子系统的由若干粒子发生器和子粒子发生器构成。粒子发生器会随着时间推移不断发射出粒子，而子粒子发生器则会在粒子发生器发射出的粒子上面发射出粒子。 更多...
 
class  NvsARSceneManipulate
 ARScene 操作。 更多...
 
class  NvsParticleEmitterDesc
 粒子发生器描述文件类。包含该粒子发生器放置的位置以及其子粒子发生器名称列表 更多...
 
class  NvsAssetPackageParticleDescParser
 粒子特效包解析类 更多...
 
class  NvsVideoCodecInfo
 视频编码信息 更多...
 
class  NvsVideoStreamInfo
 视频流信息 更多...
 
class  NvsAudioStreamInfo
 音频流信息 更多...
 
class  NvsAVFileInfo
 音视频文件信息。显示音视频文件的信息，包括音视频文件的时长，数据速率，像素横纵比，音视频流数目等。 更多...
 
class  NvsPlaybackRateControlRegion
 播放速率控制区域 更多...
 
class  NvsXmlStreamWriter
 XML流书写类 更多...
 
class  NvsXmlStreamReader
 读XML流 更多...
 
class  NvsAudioFileWriter
 音频文件写入器 更多...
 
class  NvsTemplateFootageCorrespondingClipInfo
 模板资源包里footage对应的片段信息 更多...
 
class  NvsTemplateFootageDesc
 模板资源包里footage信息(TEIMPLATE_FOOTAGE_TYPE) 更多...
 
class  NvsTemplateCaptionDesc
 模板资源包里footage对应的字幕信息 更多...
 
class  NvsTemplateCompoundCaptionItemDesc
 模板资源包里footage对应的组合字幕信息 更多...
 
class  NvsTemplateCompoundCaptionDesc
 模板资源包里footage包含的全部组合字幕信息 更多...
 
class  NvsTrackVideoFx
 视频特效轨道 更多...
 
class  NvsTrackCaption
 字幕轨道 更多...
 
class  NvsTrackCompoundCaption
 跟踪复合字幕。 更多...
 
class  NvsTrackAnimatedSticker
 轨道动画贴纸类。 更多...
 
class  NvsClipCaption
 片段字幕 更多...
 
class  NvsClipCompoundCaption
 片段组合字幕 更多...
 
class  NvsClipAnimatedSticker
 片段动画贴纸 更多...
 

函数

function nvsResumeAudioContext ()
 恢复音频上下文 更多...
 
function nvsResumeAudioContextWithPromise ()
 使用 Promise 恢复 AudioContext 更多...
 
function nvsGetStreamingContextInstance ()
 获取流媒体上下文实例 更多...
 
function nvsSetModule (module)
 
function nvsSetFS (fs)
 
function nvsInitClasses ()
 

变量

var Module = typeof Module !== 'undefined' ? Module : {}
 
var FS = typeof FS !== 'undefined' ? FS : {}
 
const NvsStreamingSdkFuncVideoFx = 'videoFx'
 视频特效常量
 
const NvsStreamingSdkFuncAnimatedSticker = 'animatedSticker'
 动画贴纸
 
const NvsStreamingSdkFuncMusic = 'music'
 音乐
 
const NvsStreamingSdkFuncCaption = 'caption'
 字幕
 
const NvsStreamingSdkFuncVideoFxExtension = 'videoFxExtension'
 视频特效扩展
 
const NvsStreamingSdkFuncVideoTransition = 'videoTransition'
 视频转场
 
const NvsStreamingSdkFuncTheme = 'theme'
 主题
 
const NvsStreamingSdkFuncParticleVideoFx = 'particleVideoFx'
 粒子视频特效
 
const NvsStreamingSdkFuncTemplate = 'template'
 模板
 
const NvsStreamingSdkFuncUseTemplate = 'useTemplate'
 使用模板
 
const NvsStreamingSdkFuncVideoTransitionExtension = 'videoTransitionExtension'
 视频转场扩展
 
const NvsStreamingSdkFuncChangeSpeed = 'changeSpeed'
 改变速度
 
const NvsStreamingSdkFuncClipSplit = 'clipSplit'
 片段分割
 
const NvsStreamingSdkFuncVideoColorAdjust = 'videoColorAdjust'
 视频颜色调整
 
const NvsStreamingSdkFuncCaptionStyleSetting = 'captionStyleSetting'
 字幕风格设置
 
const nvsEventEmitter = new NvsEventEmitter()
 事件发射器对象
 
const streamingEngineStateStopped = 'streamingEngineStateStopped'
 流媒体引擎状态停止
 
const seekingTimelinePositionArrived = 'seekingTimelinePositionArrived'
 时间线位置
 
const NvsLiveWindowFillModeEnum
 浏览窗口填充模式枚举 更多...
 
const NvsVideoPreviewSizeModeEnum
 视频预览大小模式枚举 更多...
 
const NvsSeekFlagEnum
 定位标识枚举 更多...
 
const NvsPlaybackFlagEnum
 播放标识枚举 更多...
 
const NvsStreamingEngineStateEnum
 流媒体引擎状态枚举 更多...
 
const NvsAssetPackageTypeEnum
 资源包类型枚举 更多...
 
const NvsAssetPackageStatusEnum
 资源包状态枚举 更多...
 
const NvsTrackTypeEnum
 轨道类型枚举 更多...
 
const NvsClipTypeEnum
 片段类型枚举 更多...
 
const NvsVideoClipTypeEnum
 视频片段类型枚举 更多...
 
const NvsVideoClipMotionModeEnum
 视频片段运动模式枚举 更多...
 
const NvsVideoClipExtraRotationEnum
 视频片段扩展旋转枚举 更多...
 
const NvsVideoClipBackgroundModeEnum
 视频片段背景模式枚举 更多...
 
const NvsVideoFxTypeEnum
 视频特效类型枚举 更多...
 
const NvsVideoTransitionTypeEnum
 视频转场类型枚举 更多...
 
const NvsCaptionTextAlignmentEnum
 字幕文本排列枚举 更多...
 
const NvsCaptionTextBoundingTypeEnum
 字幕文本边界类型枚举 更多...
 
const NvsCaptionLetterSpacingTypeEnum
 字幕字间距类型枚举 更多...
 
const NvsHumanDetectionFeatureEnum
 人体检测功能枚举 更多...
 
const NvsKeyFrameFindModeEnum
 关键帧查找模式枚举 更多...
 
const NvsClipWrapModeEnum
 片段循环模式枚举 更多...
 
const NvsTimelineAspectRatioEnum
 时间线横纵比枚举 更多...
 
const NvsHumanDetectionDataTypeEnum
 人脸检测数据类型 更多...
 
const NvsCreateTimelineFlagEnum
 时间线创建标识枚举 更多...
 
const NvsBlendingMode
 混合模式 更多...
 
const NvsParticleTypeEnum
 粒子类型 更多...
 
const NvsEmitterPlaceEnum
 粒子发射位置 更多...
 
const NvsFootageTypeEnum
 模板槽类型 更多...
 
const TEMPLATE_KEY_REPLACE_ID = 'MSTemplate-ReplaceId'
 
const TEMPLATE_KEY_FOOTAGE_ID = 'MSTemplate-FootageId'
 
const TEMPLATE_KEY_FOOTAGE_TAGS = 'MSTemplate-FootageTags'
 
const NvsRawFilterProcessesMode
 Raw滤镜的处理模式 更多...
 
const NvsAssetPackageErrorEnum
 资源包错误枚举 更多...
 

详细描述

SDK WEB应用文档

版本
3.12.1
版权所有
北京美摄网络科技有限公司

函数说明

◆ nvsGetStreamingContextInstance()

function nvsGetStreamingContextInstance ( )

获取流媒体上下文实例

返回
{NvsStreamingContext} 流媒体引擎对象

◆ nvsResumeAudioContext()

function nvsResumeAudioContext ( )

恢复音频上下文

返回
{Void}

◆ nvsResumeAudioContextWithPromise()

function nvsResumeAudioContextWithPromise ( )

使用 Promise 恢复 AudioContext

返回
{Promise}

变量说明

◆ NvsAssetPackageErrorEnum

const NvsAssetPackageErrorEnum
初始值:
= Object.freeze({
"NoError" : 0,
"NameError" : 1,
"AlreadyInstalledError" : 2,
"WorkingInProgress" : 3,
"NotInstalledError" : 4,
"ImproperStatusError" : 5,
"DecompressionError" : 6,
"InvalidPackageError" : 7,
"AssetTypeError" : 8,
"PermissionError" : 9,
"MetaContentError" : 10,
"SdkVersionError" : 11,
"UpgradeVersionError" : 12,
"IOError" : 13,
"ResourceError" : 14})

资源包错误枚举

注解
NoError 没有错误
NameError 名称错误
AlreadyInstalledError 已安装
WorkingInProgress 安装中
NotInstalledError 没有安装
ImproperStatusError 非正常状态错误
DecompressionError 解压错误
InvalidPackageError 无效的包错误
AssetTypeError 包类型错误
PermissionError 权限错误
MetaContentError 内部数据错误
SdkVersionError Sdk版本号错误
UpgradeVersionError 升级版本号错误
IOError 读写文件错误
ResourceError 资源错误

◆ NvsAssetPackageStatusEnum

const NvsAssetPackageStatusEnum
初始值:
= Object.freeze({
NotInstalled: 0,
Installing: 1,
Ready: 2,
Upgrading: 3,
})

资源包状态枚举

注解
NotInstalled 未安装
Installing 安装中
Ready 就绪
Upgrading 升级中

◆ NvsAssetPackageTypeEnum

const NvsAssetPackageTypeEnum
初始值:
= Object.freeze({
VideoFx: 0,
VideoTransition: 1,
CaptionStyle: 2,
AnimatedSticker: 3,
ARScene: 6,
CompoundCaption: 7,
CaptionContext: 8,
CaptionRenderer: 9,
CaptionAnimation: 10,
CaptionInAnimation: 11,
CaptionOutAnimation: 12,
Template: 13,
AvatarModel: 14,
AvatarMaterial: 15,
AnimatedStickerAnimation: 16,
AnimatedStickerInAnimation: 17,
AnimatedStickerOutAnimation: 18,
Makeup: 19,
FaceMesh: 20,
Warp: 21,
Project: 22
})

资源包类型枚举

注解
VideoFx 视频特效类型
VideoTransition 视频转场类型
CaptionStyle 字幕样式类型
AnimatedSticker 动画贴纸类型
ARScene AR场景类型
CompoundCaption 复合字幕类型
CaptionContext 模块化字幕上下文类型
CaptionRenderer 模块化字幕渲染器类型
CaptionAnimation 模块化字幕动画类型
CaptionInAnimation 模块化字幕入动画类型
CaptionOutAnimation 模块化字幕出动画类型
Template 模板类型
AvatarModel 头像模型类型
AvatarMaterial 头像材质类型
AnimatedStickerAnimation 动态贴纸动画类型
AnimatedStickerInAnimation 动态贴纸入动画类型
AnimatedStickerOutAnimation 动态贴纸出动画类型
Makeup 美妆包类型
FaceMesh 新版美型包类型
Warp 旧版美型包类型
Project 项目类型

◆ NvsBlendingMode

const NvsBlendingMode
初始值:
= Object.freeze({
BLENDING_MODE_NORMAL: 0,
BLENDING_MODE_MULTIPLY: 1,
BLENDING_MODE_SUBTRACT: 2,
BLENDING_MODE_SCREEN: 3,
BLENDING_MODE_ADD: 4,
BLENDING_MODE_EXCLUSION: 5,
BLENDING_MODE_DARKEN: 6,
BLENDING_MODE_BURN: 7,
BLENDING_MODE_LINEARBURN: 8,
BLENDING_MODE_LIGHTEN: 9,
BLENDING_MODE_DODGE: 10,
BLENDING_MODE_OVERLAY: 11,
BLENDING_MODE_SOFTLIGHT: 12,
BLENDING_MODE_HARDLIGHT: 13,
BLENDING_MODE_VIVIDLIGHT: 14,
BLENDING_MODE_PINLIGHT: 15,
BLENDING_MODE_LINEARLIGHT: 16,
BLENDING_MODE_HARDMIX: 17,
BLENDING_MODE_DIFFERENCE: 18,
})

混合模式

注解
BLENDING_MODE_NORMAL 一般默认
BLENDING_MODE_MULTIPLY 正片叠底模式
BLENDING_MODE_SUBTRACT 减去模式
BLENDING_MODE_SCREEN 滤色模式
BLENDING_MODE_ADD 添加类型
BLENDING_MODE_EXCLUSION 排除模式
BLENDING_MODE_DARKEN 变暗模式
BLENDING_MODE_BURN 颜色加深模式
BLENDING_MODE_LINEARBURN 线性加深模式
BLENDING_MODE_LIGHTEN 变亮模式
BLENDING_MODE_DODGE 颜色减淡模式
BLENDING_MODE_OVERLAY 叠加模式
BLENDING_MODE_SOFTLIGHT 柔光模式
BLENDING_MODE_HARDLIGHT 强光模式
BLENDING_MODE_VIVIDLIGHT 亮光模式
BLENDING_MODE_PINLIGHT 点光模式
BLENDING_MODE_LINEARLIGHT 线性光模式
BLENDING_MODE_HARDMIX 实色混合模式
BLENDING_MODE_DIFFERENCE 差值模式

◆ NvsCaptionLetterSpacingTypeEnum

const NvsCaptionLetterSpacingTypeEnum
初始值:
= Object.freeze({
Percentage: 0,
Absolute: 1,
})

字幕字间距类型枚举

注解
Percentage 百分比
Absolute 绝对值

◆ NvsCaptionTextAlignmentEnum

const NvsCaptionTextAlignmentEnum
初始值:
= Object.freeze({
Left: 0,
Center: 1,
Right: 2,
Top: 3,
Bottom: 4,
VCenter: 5,
})

字幕文本排列枚举

注解
Left 左对齐
Center 水平中心对齐
Right 右对齐
Top 顶部对齐
Bottom 底部对齐
VCenter 垂直中心对齐

◆ NvsCaptionTextBoundingTypeEnum

const NvsCaptionTextBoundingTypeEnum
初始值:
= Object.freeze({
Text: 0,
TextFrame: 1,
Frame: 2,
TextOriginFrame: 3,
})

字幕文本边界类型枚举

注解
Text 实际的文本边界
TextFrame 文本框边界
Frame 包括装饰在内的整个边界
TextOriginFrame 原始文本框边界

◆ NvsClipTypeEnum

const NvsClipTypeEnum
初始值:
= Object.freeze({
Video: 0,
Audio: 1,
})

片段类型枚举

注解
Video 视频
Audio 音频

◆ NvsClipWrapModeEnum

const NvsClipWrapModeEnum
初始值:
= Object.freeze({
RepeatLastFrame: 0,
RepeatFirstFrame: 1,
Repeat: 2,
})

片段循环模式枚举

注解
RepeatLastFrame 重复最后一帧
RepeatFirstFrame 重复第一帧
Repeat 重复

◆ NvsCreateTimelineFlagEnum

const NvsCreateTimelineFlagEnum
初始值:
= Object.freeze({
LongestDurationConsiderAllTracks: 1,
SyncAudioVideoTrasitionInVideoTrack: 2,
UseMipmap: 4,
VariantImageSize: 8,
DontAddDefaultVideoTransition: 16,
ForceAudioSampleFormatUsed: 32,
Template: 64,
Orphan: 128,
ForceTimelineSizeUsed: 256,
RecordingUserOperation: 512
})

时间线创建标识枚举

注解
LongestDurationConsiderAllTracks 由所有音视频轨的最大时长决定时间线长度
SyncAudioVideoTrasitionInVideoTrack 同步处理在视频轨道上的视频和音频转场
UseMipmap 使用mipmap抗锯齿
VariantImageSize 加载图片时自动适配timeline分辨率
DontAddDefaultVideoTransition 不添加默认视频转场
ForceAudioSampleFormatUsed 强制使用音频制式信息中的音频格式
Template 模板时间线
Orphan 孤儿时间线，销毁父亲时间线的同时销毁该时间线
ForceTimelineSizeUsed 小图模式下强制使用timeline分辨率
RecordingUserOperation 记录用户操作

◆ NvsEmitterPlaceEnum

const NvsEmitterPlaceEnum
初始值:
= Object.freeze({
EMITTER_PLACE_LEFT: 0,
EMITTER_PLACE_RIGHT: 1,
EMITTER_PLACE_TOP: 2,
EMITTER_PLACE_BOTTOM: 3,
EMITTER_PLACE_CENTER: 4,
})

粒子发射位置

注解
EMITTER_PLACE_LEFT 左
EMITTER_PLACE_RIGHT 右
EMITTER_PLACE_TOP 顶部
EMITTER_PLACE_BOTTOM 底部
EMITTER_PLACE_CENTER 中间

◆ NvsFootageTypeEnum

const NvsFootageTypeEnum
初始值:
= Object.freeze({
VideoImage: 0,
Video: 1,
Image: 2,
Audio: 3,
})

模板槽类型

注解
VideoImage 视频或图像
Video 视频
Image 图像
Audio 音频

◆ NvsHumanDetectionDataTypeEnum

const NvsHumanDetectionDataTypeEnum
初始值:
= Object.freeze({
FakeFace: 0,
Makeup: 1,
SkinColor: 2,
PE106: 3,
PE240: 4,
CustomAvatar: 5,
Makeup2: 6,
FaceCommon: 7,
AdvancedBeauty: 8,
})

人脸检测数据类型

注解
FakeFace 假脸数据包类型
Makeup 美妆数据包类型
SkinColor 美肤数据包类型
PE106 106点位姿态估计数据包类型
PE240 240点位姿态估计数据包类型
CustomAvatar 捏脸数据包类型
Makeup2 美妆2数据包类型
FaceCommon 人脸通用数据包类型
AdvancedBeauty 高级美颜数据包类型

◆ NvsHumanDetectionFeatureEnum

const NvsHumanDetectionFeatureEnum
初始值:
= Object.freeze({
FaceLandmark: 0x00000001,
FaceAction: 0x00000002,
AvatarExpression: 0x00000004,
VideoMode: 0x00000008,
ImageMode: 0x00000010,
SemiImageMode: 0x00008000,
MultiThread: 0x00000020,
SingleThread: 0x00000040,
Extra: 0x00000080,
SegmentationBackground: 0x00000100,
HandLandmark: 0x00000200,
HandAction: 0x00000400,
HandBone: 0x00000800,
EyeballLandmark: 0x00001000,
MultiDetect: 0x00002000,
SegmentationSky: 0x00004000,
SegmentationHalfBody: 0x00010000,
FaceAttr: 0x00020000,
FaceAttrShape: 0x00040000
})

人体检测功能枚举

注解
0x00000001 人脸点位
0x00000002 人脸表情
0x00000004 人脸Avatar表情
0x00000008 视频检测模式
0x00000010 图像检测模式
0x00008000 半图像检测模式
0x00000020 多线程检测
0x00000040 单线程检测
0x00000080 其他人脸特征
0x00000100 背景分割
0x00000200 手部点位
0x00000400 手部动作
0x00000800 手部骨骼点位
0x00001000 眼球点位
0x00002000 多重检测,例如多重ROI检测
0x00004000 天空分割
0x00010000 半身分割
0x00020000 人脸基础属性
0x00040000 脸型属性

◆ NvsKeyFrameFindModeEnum

const NvsKeyFrameFindModeEnum
初始值:
= Object.freeze({
Before: 1,
After: 2,
})

关键帧查找模式枚举

注解
Before 之前
After 之后

◆ NvsLiveWindowFillModeEnum

const NvsLiveWindowFillModeEnum
初始值:
= Object.freeze({
PreserveAspectCrop: 0,
PreserveAspectFit: 1,
Stretch: 2,
})

浏览窗口填充模式枚举

注解
0 图像按比例均匀填充，必要时进行裁剪(默认模式)
1 图像均匀地缩放来适合窗口，没有裁剪
2 图像被缩放来适合窗口

◆ NvsParticleTypeEnum

const NvsParticleTypeEnum
初始值:
= Object.freeze({
PARTICLE_TYPE_NORMAL: 0,
PARTICLE_TYPE_TOUCH: 1,
PARTICLE_TYPE_GESTURE: 2,
PARTICLE_TYPE_EYE: 3,
PARTICLE_TYPE_MOUTH: 4,
})

粒子类型

注解
PARTICLE_TYPE_NORMAL 没有交互的基本粒子类型
PARTICLE_TYPE_TOUCH 触摸屏幕进行交互的粒子类型
PARTICLE_TYPE_GESTURE 手势进行交互的粒子类型
PARTICLE_TYPE_EYE 眼睛进行交互的类型
PARTICLE_TYPE_MOUTH 嘴巴进行交互的粒子类型

◆ NvsPlaybackFlagEnum

const NvsPlaybackFlagEnum
初始值:
= Object.freeze({
IgnoreTiming: 1,
LowPipelineSize: 8,
DisableFixedPrerollTime: 16,
BuddyHostVideoFrame: 32,
BuddyHostOriginVideoFrame: 2048,
UseMipmap: 8192,
DisableVideo: 1 << 15
})

播放标识枚举

注解
IgnoreTiming 忽略时序
LowPipelineSize 降低引擎在播放时内部的流水线尺寸
DisableFixedPrerollTime 降低引擎在播放时首帧的播出延迟
BuddyHostVideoFrame 伴侣视频帧，一般用于人脸检测
BuddyHostOriginVideoFrame 解码后伴侣视频帧，一般用于人脸检测
UseMipmap 使用mipmap
DisableVideo 禁用视频

◆ NvsRawFilterProcessesMode

const NvsRawFilterProcessesMode
初始值:
= Object.freeze({
None: 0,
VarSize: 1,
VarSizeWithFillModeUsed: 2,
})

Raw滤镜的处理模式

注解
None 默认模式，所有的Raw滤镜的输入输出尺寸一致，最后按照设置的填充模式适配到时间线的尺寸上
VarSize 所有的Raw滤镜的输出尺寸按照滤镜实际输出大小，最后使用fill填充模式适配到时间线的尺寸上
VarSizeWithFillModeUsed 所有的Raw滤镜的输出尺寸按照滤镜实际输出大小，最后按照设置的填充模式适配到时间线的尺寸上

◆ NvsSeekFlagEnum

const NvsSeekFlagEnum
初始值:
= Object.freeze({
ShowCaptionPoster: 2,
ShowAnimatedStickerPoster: 4,
BuddyHostVideoFrame: 16,
WebReaderPrefetchForSeek: 32,
BuddyHostOriginVideoFrame: 256,
UseMipmap: 512
})

定位标识枚举

注解
ShowCaptionPoster 显示动画贴纸海报
ShowAnimatedStickerPoster 显示标题海报
BuddyHostVideoFrame 伴侣视频帧，一般用于人脸检测
WebReaderPrefetchForSeek WebReader预载
BuddyHostOriginVideoFrame 解码后伴侣视频帧，一般用于人脸检测
UseMipmap 使用mipmap

◆ NvsStreamingEngineStateEnum

const NvsStreamingEngineStateEnum
初始值:
= Object.freeze({
StreamingEngineStateStopped: 0,
StreamingEngineStatePlayback: 3,
StreamingEngineStateSeeking: 4
})

流媒体引擎状态枚举

注解
StreamingEngineStateStopped 流媒体引擎停止状态
StreamingEngineStatePlayback 流媒体引擎播放状态
StreamingEngineStateSeeking 流媒体引擎定位状态

◆ NvsTimelineAspectRatioEnum

const NvsTimelineAspectRatioEnum
初始值:
= Object.freeze({
'16v9': 1,
'1v1': 2,
'9v16': 4,
'4v3': 8,
'3v4': 16,
'18v9': 32,
'9v18': 64,
'21v9': 512,
'9v21': 1024,
})

时间线横纵比枚举

注解
16v9 16:9
1v1 1:1
9v16 9:16
4v3 4:3
3v4 3:4
18v9 18:9
9v18 9:18
21v9 21:9
9v21 9:21

◆ NvsTrackTypeEnum

const NvsTrackTypeEnum
初始值:
= Object.freeze({
Video: 0,
Audio: 1,
})

轨道类型枚举

注解
Video 视频
Audio 音频

◆ NvsVideoClipBackgroundModeEnum

const NvsVideoClipBackgroundModeEnum
初始值:
= Object.freeze({
ColorSolid: 0,
Blur: 1,
})

视频片段背景模式枚举

注解
ColorSolid 纯色
Blur 模糊

◆ NvsVideoClipExtraRotationEnum

const NvsVideoClipExtraRotationEnum
初始值:
= Object.freeze({
Rotation0: 0,
Rotation90: 1,
Rotation180: 2,
Rotation270: 3,
})

视频片段扩展旋转枚举

注解
Rotation0 旋转 0°
Rotation90 旋转 90°
Rotation180 旋转 180°
Rotation270 旋转 270°

◆ NvsVideoClipMotionModeEnum

const NvsVideoClipMotionModeEnum
初始值:
= Object.freeze({
LetterBoxZoomIn: 0,
LetterBoxZoomOut: 1,
Image_ROI: 2,
})

视频片段运动模式枚举

注解
LetterBoxZoomIn 信箱放大
LetterBoxZoomOut 信箱缩小
Image_ROI 图像片段的ROI(Region Of Interesting)

◆ NvsVideoClipTypeEnum

const NvsVideoClipTypeEnum
初始值:
= Object.freeze({
AV: 0,
Image: 1,
})

视频片段类型枚举

注解
AV 视频
Image 图片

◆ NvsVideoFxTypeEnum

const NvsVideoFxTypeEnum
初始值:
= Object.freeze({
Builtin: 0,
Package: 1,
Custom: 2,
})

视频特效类型枚举

注解
Builtin 内建类型
Package 特效包类型
Custom 自定义类型

◆ NvsVideoPreviewSizeModeEnum

const NvsVideoPreviewSizeModeEnum
初始值:
= Object.freeze({
FullSize: 0,
LiveWindowSize: 1,
})

视频预览大小模式枚举

注解
FullSize 最大
LiveWindowSize 实时窗口大小

◆ NvsVideoTransitionTypeEnum

const NvsVideoTransitionTypeEnum
初始值:
= Object.freeze({
Builtin: 0,
Package: 1,
})

视频转场类型枚举

注解
Builtin 内建类型
Package 特效包类型
制作者 doxygen 1.9.1