特效上下文特效上下文类可视作Effect SDK框架的入口，可以通过nveGetEffectContextInstance()获取全局唯一的实例对象。更多...

Public 成员函数
	constructor ()

	verifySdkLicenseFile (licenseFilePath)
	验证SDK许可文件更多...

async	verifySdkLicenseFileUrl (licenseFileUrl)
	验证SDK许可文件网络地址更多...

	setMaxQueuedRenderTask (maxQueuedRenderTask)
	设置渲染任务队列的最大值更多...

	getMaxQueuedRenderTask ()
	获取渲染任务队列的最大值更多...

	createVideoEffect (fxName, aspectRatio, workingInRealtimeMode=true)
	创建视频特效对象更多...

	createVideoTransition (fxName, aspectRatio)
	创建视频转场对象更多...

	createAnimatedSticker (inPoint, duration, isPanoramic, packageId, aspectRatio)
	创建动画贴纸对象更多...

	createCompoundCaption (inPoint, duration, packageId, aspectRatio)
	创建组合字幕对象更多...

	createCaption (text, inPoint, duration, isPanoramic, packageId, aspectRatio)
	创建字幕对象更多...

	createModularCaption (text, inPoint, duration, aspectRatio)
	创建模块字幕对象更多...

	renderEffects (effectInstanceArray, inputImageData, timestampMs, flags=0, hostBufferInfoExtArray=[], renderRect={})
	渲染特效数组更多...

	renderEffectsWithMultiInputs (effectInstanceArray, inputImageDataArray, timestampMs, flags=0, hostBufferInfoExtArray=[], renderRect={})
	渲染特效数组更多...

	renderEffect (effectInstance, inputImageData, timestampMs, flags=0, hostBufferInfoExtArray=[])
	渲染特效更多...

	renderEffectWithMultiInputs (effectInstance, inputImageDataArray, timestampMs, flags=0, hostBufferInfoExtArray=[])
	渲染特效更多...

	initHumanDetection (modelFilePath, licenseFilePath, features)
	初始化人体检测机制，只需要初始化一次更多...

	initHumanDetectionExt (modelFilePath, licenseFilePath, features)
	初始化人体检测扩展机制，必须先调用initHumanDetection 更多...

	setupHumanDetectionData (dataType, dataFilePath)
	初始化人体检测相关数据包更多...

	closeHumanDetection ()
	关闭人体检测更多...

	getAssetPackageManager ()
	获取资源包管理器更多...

	inferenceTest (imageFilePath, modelFilePath, forwardType, threadNum, loopCount, flags)

详细描述

特效上下文特效上下文类可视作Effect SDK框架的入口，可以通过nveGetEffectContextInstance()获取全局唯一的实例对象。

成员函数说明

◆ closeHumanDetection()

NveEffectContext::closeHumanDetection ( )

inline

关闭人体检测

返回: {}

◆ constructor()

NveEffectContext::constructor ( )

inline

@constructor

◆ createAnimatedSticker()

NveEffectContext::createAnimatedSticker	(	inPoint,
		duration,
		isPanoramic,
		packageId,
		aspectRatio
	)

inline

创建动画贴纸对象

参数

{Number}	inPoint 入点
{Number}	duration 持续时间
{Boolean}	isPanoramic 是否是全景
{String}	packageId 动画贴纸包id
{String}	aspectRatio 画幅比

返回: {NveEffectInstance} 特效对象

◆ createCaption()

NveEffectContext::createCaption	(	text,
		inPoint,
		duration,
		isPanoramic,
		packageId,
		aspectRatio
	)

inline

创建字幕对象

参数

{String}	text 字幕文本
{Number}	inPoint 入点
{Number}	duration 持续时间
{Boolean}	isPanoramic 是否是全景
{String}	packageId 字幕样式包id
{String}	aspectRatio 画幅比

返回: {NveEffectInstance} 特效对象

◆ createCompoundCaption()

NveEffectContext::createCompoundCaption	(	inPoint,
		duration,
		packageId,
		aspectRatio
	)

inline

创建组合字幕对象

参数

{Number}	inPoint 入点
{Number}	duration 持续时间
{String}	packageId 组合字幕包id
{String}	aspectRatio 画幅比

返回: {NveEffectInstance} 特效对象

◆ createModularCaption()

NveEffectContext::createModularCaption	(	text,
		inPoint,
		duration,
		aspectRatio
	)

inline

创建模块字幕对象

参数

{String}	text 字幕文本
{Number}	inPoint 入点
{Number}	duration 持续时间
{String}	aspectRatio 画幅比

返回: {NveEffectInstance} 特效对象

◆ createVideoEffect()

NveEffectContext::createVideoEffect	(	fxName,
		aspectRatio,
		workingInRealtimeMode = `true`
	)

inline

创建视频特效对象

参数

{String}	fxName 如果是内建特效，就是特效的名字，如果是资源包特效，就是资源包id。
{String}	aspectRatio 画幅比
{Boolean}	workingInRealtimeMode 是否工作在实时模式，默认值为true。

返回: {NveEffectInstance} 特效对象

◆ createVideoTransition()

NveEffectContext::createVideoTransition	(	fxName,
		aspectRatio
	)

inline

创建视频转场对象

参数

{String}	fxName 如果是内建转场，就是转场的名字，如果是资源包转场，就是资源包id。
{String}	aspectRatio 画幅比

返回: {NveEffectInstance} 特效对象

◆ getAssetPackageManager()

NveEffectContext::getAssetPackageManager ( )

inline

获取资源包管理器

返回: {NveAssetPackageManager} 资源包管理器对象

◆ getMaxQueuedRenderTask()

NveEffectContext::getMaxQueuedRenderTask ( )

inline

获取渲染任务队列的最大值

返回: {Number} 最大值

◆ initHumanDetection()

NveEffectContext::initHumanDetection	(	modelFilePath,
		licenseFilePath,
		features
	)

inline

初始化人体检测机制，只需要初始化一次

参数

{String}	modelFilePath 模型文件路径
{String}	licenseFilePath 授权文件路径
{Number}	features 人体检测特征标志字段，参看NveHumanDetectionFeatureEnum

返回: {Boolean} YES表示成功，NO表示失败

参见: NveEffectContext#initHumanDetectionExt NveEffectContext#closeHumanDetection

◆ initHumanDetectionExt()

NveEffectContext::initHumanDetectionExt	(	modelFilePath,
		licenseFilePath,
		features
	)

inline

初始化人体检测扩展机制，必须先调用initHumanDetection

参数

{String}	modelFilePath 模型文件路径
{String}	licenseFilePath 授权文件路径
{Number}	features 人体检测特征标志字段，参看NveHumanDetectionFeatureEnum

返回: {Boolean} YES表示成功，NO表示失败

参见: NveEffectContext#initHumanDetection NveEffectContext#closeHumanDetection

◆ renderEffect()

NveEffectContext::renderEffect	(	effectInstance,
		inputImageData,
		timestampMs,
		flags = `0`,
		hostBufferInfoExtArray = `[]`
	)

inline

渲染特效

参数

{NveEffectInstance}	effectInstance 特效实例
{ImageData\|VideoFrame}	inputImageData 输入图像数据
{Number}	timestampMs 当前渲染的时间戳，以毫秒为单位
{Number}	flags 标识

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

◆ renderEffects()

NveEffectContext::renderEffects	(	effectInstanceArray,
		inputImageData,
		timestampMs,
		flags = `0`,
		hostBufferInfoExtArray = `[]`,
		renderRect = `{}`
	)

inline

渲染特效数组

参数

{NveEffectInstance[]}	effectInstanceArray 特效实例数组
{ImageData\|VideoFrame}	inputImageData 输入图像数据
{Number}	timestampMs 当前渲染的时间戳，以毫秒为单位
{Number}	flags 标识

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

◆ renderEffectsWithMultiInputs()

NveEffectContext::renderEffectsWithMultiInputs	(	effectInstanceArray,
		inputImageDataArray,
		timestampMs,
		flags = `0`,
		hostBufferInfoExtArray = `[]`,
		renderRect = `{}`
	)

inline

渲染特效数组

参数

{NveEffectInstance[]}	effectInstanceArray 特效实例数组
{ImageData[]\|VideoFrame[]}	inputImageDataArray 输入图像数据数组
{Number}	timestampMs 当前渲染的时间戳，以毫秒为单位
{Number}	flags 标识

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

◆ renderEffectWithMultiInputs()

NveEffectContext::renderEffectWithMultiInputs	(	effectInstance,
		inputImageDataArray,
		timestampMs,
		flags = `0`,
		hostBufferInfoExtArray = `[]`
	)

inline

渲染特效

参数

{NveEffectInstance}	effectInstance 特效实例
{ImageData[]\|VideoFrame[]}	inputImageDataArray 输入图像数据数组
{Number}	timestampMs 当前渲染的时间戳，以毫秒为单位
{Number}	flags 标识

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

◆ setMaxQueuedRenderTask()

NveEffectContext::setMaxQueuedRenderTask ( maxQueuedRenderTask )

inline

设置渲染任务队列的最大值

参数

{Number} maxQueuedRenderTask 最大值因为特效渲染任务会调度到内部线程异步执行，如果排队的渲染任务数量太多，会占用过多的内存，此方法可以设置渲染任务队列的最大值，限制队列的数量，当队列的数量达到最大值时，除非DontDropFrame标识被设置了，否则新的渲染任务会被丢弃。

◆ setupHumanDetectionData()

NveEffectContext::setupHumanDetectionData	(	dataType,
		dataFilePath
	)

inline

初始化人体检测相关数据包

参数

{Number}	dataType 人体检测数据包类型，参看NveHumanDetectionDataTypeEnum
{String}	dataFilePath 数据文件路径

返回: {Boolean} YES表示成功，NO表示失败

◆ verifySdkLicenseFile()

NveEffectContext::verifySdkLicenseFile ( licenseFilePath )

inline

验证SDK许可文件

参数

{String} licenseFilePath 授权文件路径

返回: {Boolean} true表示授权验证成功，false表示失败。如果验证失败, 无法正常使用。

◆ verifySdkLicenseFileUrl()

async NveEffectContext::verifySdkLicenseFileUrl ( licenseFileUrl )

inline

验证SDK许可文件网络地址

参数

{String} licenseFileUrl 授权文件网络地址

返回: {Boolean} true表示授权验证成功，false表示失败。如果验证失败, 无法正常使用。

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

src/js/NvEffectSdk.js

Public 成员函数

详细描述

成员函数说明

◆ closeHumanDetection()

◆ constructor()

◆ createAnimatedSticker()

◆ createCaption()

◆ createCompoundCaption()

◆ createModularCaption()

◆ createVideoEffect()

◆ createVideoTransition()

◆ getAssetPackageManager()

◆ getMaxQueuedRenderTask()

◆ initHumanDetection()

◆ initHumanDetectionExt()

◆ renderEffect()

◆ renderEffects()

◆ renderEffectsWithMultiInputs()

◆ renderEffectWithMultiInputs()

◆ setMaxQueuedRenderTask()

◆ setupHumanDetectionData()

◆ verifySdkLicenseFile()

◆ verifySdkLicenseFileUrl()