NveARSceneRenderer类 参考

ARScene内建特效的快捷渲染类 通过内部下载初始化人脸模型，内部下载管理安装美妆、美型等资源包的方式，简化美颜美型美妆以及整妆包的使用逻辑， 同时内部还提供启动摄像头媒体流采集，外部输入媒体流，输出媒体流的多种形式，IndexedDB缓存机制， 只需要初始化配置好相应的参数，然后设置特效包地址等参数即可快速得到美颜美型美妆等渲染结果。 更多...

Public 成员函数
async	init (config)
	初始化ARScene内建特效的渲染类 更多...
	ensureIndexedDBObject (db, name)
	ensureIndexedDBObjects (db)
	prepareIndexedDB (name, version)
	findFromIndexedDB (name, key, version)
	clearCacheOnIndexedDB ()
	清除IndexedDB的缓存数据 更多...
	release ()
	释放ARScene内建特效的渲染类，如果启动了摄像头媒体流采集，会同时停止摄像头媒体流采集。
async	fetchAndWrite (url, filePath, lic=false)
	calculatePositionByVertices (position, vertices)
	applyEffect (assetUuid, effect, assetType)
	preloadEffect (effect)
	预加载特效包资源 更多...
	installAndApplyEffect (effect)
	installPackageInZip (zipEntry, zipPackageDir, fileName, files)
async	applyEffectsInZip (effect)
	setParams (params)
	clearEffectInstanceArray ()
	clearEffectInstanceArrayInZip ()
	clearEffects ()
async	resetEffects ()
async	applyEffects ()
	enableBeauty (enable)
	是否开启美颜 更多...
async	setEffectList (effectList)
	设置特效列表 更多...
	getEffectList ()
	获取已经设置的特效列表 更多...
async	appendEffectList (effectList)
	追加特效列表 更多...
	render (inputImageData, timestampMs, renderRect={})
	渲染特效 更多...
	createDummyVideoElement (mediaStream)
async	renderEffectAndCreateOutputStream (inputImageData, renderRect)
	pushMediaStream (mediaStream)
	推入媒体流 更多...
async	startupCamera (constraints)
	启动摄像头 更多...
	stopCamera ()
	停止摄像头
	getOutputStream ()
	获取输出媒体流 更多...
async	createExternalEffectInstance (effect)
	创建外部特效实例, 包括字幕、贴纸、组合字幕、转场和滤镜 更多...
	setExternalEffectInstanceList (effectInstanceList)
	设置外部特效实例列表 更多...
	getExternalEffectInstanceList ()
	获取外部特效实例列表 更多...
	appendExternalEffectInstance (effectInstance)
	追加外部特效实例 更多...

详细描述

ARScene内建特效的快捷渲染类 通过内部下载初始化人脸模型，内部下载管理安装美妆、美型等资源包的方式，简化美颜美型美妆以及整妆包的使用逻辑， 同时内部还提供启动摄像头媒体流采集，外部输入媒体流，输出媒体流的多种形式，IndexedDB缓存机制， 只需要初始化配置好相应的参数，然后设置特效包地址等参数即可快速得到美颜美型美妆等渲染结果。

成员函数说明

appendEffectList()

async NveARSceneRenderer::appendEffectList (   effectList )

inline

追加特效列表

参数

{}	effectList 特效列表

返回

{Promise}

appendExternalEffectInstance()

NveARSceneRenderer::appendExternalEffectInstance (   effectInstance )

inline

追加外部特效实例

参数

{}	effectInstance 外部特效实例

clearCacheOnIndexedDB()

NveARSceneRenderer::clearCacheOnIndexedDB ( )

inline

清除IndexedDB的缓存数据

返回

{Promise}

createExternalEffectInstance()

async NveARSceneRenderer::createExternalEffectInstance (   effect )

inline

创建外部特效实例, 包括字幕、贴纸、组合字幕、转场和滤镜

参数

{}	effect 外部特效对象

返回

{Promise} resolve状态下, 返回结果携带创建的特效实例, 例如: NveCaption、NveAnimatedSticker、NveCompoundCaption、NveVideoTransition和NveEffectInstance。

enableBeauty()

NveARSceneRenderer::enableBeauty (   enable )

inline

是否开启美颜

参数

{}	enable 是否开启

getEffectList()

NveARSceneRenderer::getEffectList ( )

inline

获取已经设置的特效列表

返回

{} 已经设置的特效列表

getExternalEffectInstanceList()

NveARSceneRenderer::getExternalEffectInstanceList ( )

inline

获取外部特效实例列表

返回

{NveEffectInstance[]} 外部特效实例列表

getOutputStream()

NveARSceneRenderer::getOutputStream ( )

inline

获取输出媒体流

返回

{MediaStream} MediaStream对象

init()

async NveARSceneRenderer::init (   config )

inline

初始化ARScene内建特效的渲染类

参数

{}

config 配置参数。 faceModelUrl:人脸模型地址, eyecontourModelUrl:眼球模型地址, avatarModelUrl:表情模型地址, segmentationModelUrl:分割模型地址, makeupDataUrl:美妆数据包地址, fakefaceDataUrl:假脸数据包地址, faceCommonDataUrl:人脸通用数据包地址, advancedBeautyDataUrl:高级美颜数据包地址, ratio:特效的画幅比,NveRational对象, detectionMode:人脸检测模式,NveHumanDetectionFeatureEnum类型, beautyIntensity:美颜强度, beautyLutUrl:美颜lut文件地址, beautyLutIntensity:美颜lut强度, outputStreamFps:输出媒体流的帧速率, cacheOnIndexedDB:是否缓存资源包等数据到IndexedDB, workingInRealtimeMode:是否使用实时模式渲染, jszip:JSZip对象,用于解压整妆包, printTimeCostAndFps:是否控制台打印每帧图像渲染耗时和实时帧率, mirror:是否开启镜像,

返回

{Promise}

preloadEffect()

NveARSceneRenderer::preloadEffect (   effect )

inline

预加载特效包资源

参数

{}	effect 特效包对象

pushMediaStream()

NveARSceneRenderer::pushMediaStream (   mediaStream )

inline

推入媒体流

参数

{}	mediaStream 媒体流

render()

NveARSceneRenderer::render (   inputImageData,   timestampMs,   renderRect = {}  )

inline

渲染特效

参数

{ImageData|VideoFrame}	inputImageData 输入图像数据
{Number}	timestampMs 当前渲染的时间戳，以毫秒为单位

返回

{Promise} 返回Promise，reject时，携带Error字符串信息， resolve时，则携带{imageBitmap:imageData, spentTime:spentTime}结构的渲染结果， imageBitmap是输出的图像数据，类型为ImageBitmap，spentTime是渲染耗时，以毫秒为单位。

setEffectList()

async NveARSceneRenderer::setEffectList (   effectList )

inline

设置特效列表

参数

{}	effectList 特效列表

返回

{Promise}

setExternalEffectInstanceList()

NveARSceneRenderer::setExternalEffectInstanceList (   effectInstanceList )

inline

设置外部特效实例列表

参数

{}	effectInstanceList 外部特效实例列表

startupCamera()

async NveARSceneRenderer::startupCamera (   constraints )

inline

启动摄像头

参数

{}	constraints 约束

返回

{Promise}

---

该类的文档由以下文件生成:

• src/js/NvEffectSdk.js