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

Effect SDK WEB应用文档 更多...

class  NveVectorVal
 对象类型数组 更多...
 
class  NveVolume
 音量类,设置音量的左右声道 更多...
 
class  NveMotionParameters
 运动参数 更多...
 
class  NveCaptionSpan
 字幕layout属性类 更多...
 
class  NvePointF
 二维坐标点结构。 参数类型为双精度浮点数。 更多...
 
class  NveRectF
 矩形类 更多...
 
class  NveRational
 比例值 更多...
 
class  NveColor
 自定义颜色类 SDK中,NveColor类属性r,g,b,a取值范围是[0,1],而非[0,255]。 更多...
 
class  NveRenderTask
 渲染任务 更多...
 
class  NveEffectInstance
 特效实例 更多...
 
class  NveCaption
 字幕是叠加在视频上的自定义文本。您可以添加并调整字幕位置。添加字幕后,还可以设置样式,包括字体大小、颜色、阴影、描边等。 更多...
 
class  NveAnimatedSticker
 动画贴纸类。动画贴纸是视频编辑时使用的一种美化特效,可以产生动画效果。用户可以添加和修改动画贴纸,通过各种API调整贴纸的各种属性,如位置、大小、显示时间等等。 更多...
 
class  NveCompoundCaption
 复合字幕。复合字幕是视频上叠加的组合型文字,每个复合字幕包含若干个子字幕。编辑视频时,可以添加并对字幕位置进行调整处理,还可以对字体,颜色属性进行修改。 更多...
 
class  NveVideoTransition
 视频转场,片段间切换的特效。轨道上有多个片段,转场是从一个视频片段播放到另一个视频片段的衔接过渡效果,而在有间隙的片段之间不能添加视频转场。目前支持多种视频转场, 包括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(斜推)。每种视频转场都可通过视频轨道来设置和获取。默认转场是Fade(淡入淡出)。 更多...
 
class  NveEffectContext
 特效上下文 特效上下文类可视作Effect SDK框架的入口,可以通过nveGetEffectContextInstance()获取全局唯一的实例对象。 更多...
 
class  NveAssetPackageManager
 资源包管理器,管理视频场景中的资源包。 在SDK开发过中,资源包管理器统一对需要的各种特技资源包,包括字幕、动画贴纸等进行相应的安装,升级,卸载等操作。 在安装,升级,卸载时,出现差错都会有相应的错误提示类型,以便快速定位和解决错误。 更多...
 
class  NveARSceneManipulate
 ARScene 操作。 更多...
 
class  NveARSceneRenderer
 ARScene内建特效的快捷渲染类 通过内部下载初始化人脸模型,内部下载管理安装美妆、美型等资源包的方式,简化美颜美型美妆以及整妆包的使用逻辑, 同时内部还提供启动摄像头媒体流采集,外部输入媒体流,输出媒体流的多种形式,IndexedDB缓存机制, 只需要初始化配置好相应的参数,然后设置特效包地址等参数即可快速得到美颜美型美妆等渲染结果。 更多...
 

函数

function nveGetEffectContextInstance ()
 获取特效上下文实例 更多...
 
function nveSetModule (module)
 
function nveInitClasses ()
 
function nveSetFS (fs)
 

变量

var Module = typeof Module !== 'undefined' ? Module : {}
 
var FS = typeof FS !== 'undefined' ? FS : {}
 
const NveCaptionTextAlignmentEnum
 字幕文本排列枚举 更多...
 
const NveCaptionTextBoundingTypeEnum
 字幕文本边界类型枚举 更多...
 
const NveCaptionLetterSpacingTypeEnum
 字幕字间距类型枚举 更多...
 
const NveRenderFlagEnum
 渲染标识枚举 更多...
 
const NveAssetPackageTypeEnum
 资源包类型枚举 更多...
 
const NveAssetPackageStatusEnum
 资源包状态枚举 更多...
 
const NveHumanDetectionFeatureEnum
 人体检测功能枚举 更多...
 
const NveHumanDetectionDataTypeEnum
 人脸检测数据类型 更多...
 
const NveAssetPackageErrorEnum
 资源包错误枚举 更多...
 

详细描述

Effect SDK WEB应用文档

版本
3.12.1

函数说明

◆ nveGetEffectContextInstance()

function nveGetEffectContextInstance ( )

获取特效上下文实例

返回
{NveEffectContext} 特效上下文实例

变量说明

◆ NveAssetPackageErrorEnum

const NveAssetPackageErrorEnum
初始值:
= 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 资源错误

◆ NveAssetPackageStatusEnum

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

资源包状态枚举

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

◆ NveAssetPackageTypeEnum

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

资源包类型枚举

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

◆ NveCaptionLetterSpacingTypeEnum

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

字幕字间距类型枚举

注解
Percentage 百分比
Absolute 绝对值

◆ NveCaptionTextAlignmentEnum

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

字幕文本排列枚举

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

◆ NveCaptionTextBoundingTypeEnum

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

字幕文本边界类型枚举

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

◆ NveHumanDetectionDataTypeEnum

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

人脸检测数据类型

注解
FakeFace 假脸数据包类型
Makeup 美妆数据包类型
SkinColor 美肤数据包类型
PE106 106点位姿态估计数据包类型
PE240 240点位姿态估计数据包类型
CustomAvatar 捏脸数据包类型
Makeup2 美妆2数据包类型

◆ NveHumanDetectionFeatureEnum

const NveHumanDetectionFeatureEnum
初始值:
= 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 脸型属性

◆ NveRenderFlagEnum

const NveRenderFlagEnum
初始值:
= Object.freeze({
"DontDropFrame" : 1,
"OutputImageBitmap" : 2})

渲染标识枚举

注解
DontDropFrame 不丢帧模式
OutputImageBitmap 输出ImageBitmap数据