资源包管理器，管理视频场景中的资源包。在SDK开发过中，资源包管理器统一对需要的各种特技资源包，包括字幕、动画贴纸等进行相应的安装，升级，卸载等操作。在安装，升级，卸载时，出现差错都会有相应的错误提示类型，以便快速定位和解决错误。更多...

Public 成员函数
	constructor ()

	setInternalObject (obj)
	设置内置对象更多...

	getInternalObject ()
	获取内置对象更多...

	installAssetPackage (assetPackageFilePath, licenseFilePath, type)
	安装资源包调用此函数后，会接收到回调函数onFinishAssetPackageInstallation返回安装结果。 onFinishAssetPackageInstallation返回参数包括assetPackageId、assetPackageFilePath、assetPackageType和error。 assetPackageId是当前安装完成的资源包id， assetPackageFilePath是当前安装完成的资源包文件路径， assetPackageType是当前安装完成的资源包类型， error是当前安装完成的错误码，参看NvsAssetPackageErrorEnum。更多...

	upgradeAssetPackage (assetPackageFilePath, licenseFilePath, type)
	升级资源包调用此函数后，会接收到回调函数onFinishAssetPackageUpgrading返回升级结果。 onFinishAssetPackageUpgrading返回参数包括assetPackageId、assetPackageFilePath、assetPackageType和error。 assetPackageId是当前升级完成的资源包id， assetPackageFilePath是当前升级完成的资源包文件路径， assetPackageType是当前升级完成的资源包类型， error是当前升级完成的错误码，参看NvsAssetPackageErrorEnum。更多...

	uninstallAssetPackage (assetPackageId, type)
	卸载资源包更多...

	getAssetPackageStatus (assetPackageId, type)
	获取资源包状态更多...

	getAssetPackageVersion (assetPackageId, type)
	获取资源包版本号更多...

	getAssetPackageContentType (assetPackageId, type)
	获取资源包内容类型更多...

	isParticleFX (uuidString)
	是否是粒子特效更多...

	getVideoFxAssetPackageDescription (uuidString)
	获取视频特效资源包描述更多...

	getTemplateFootages (uuidString)
	获取模板素材更多...

	getTemplateCaptions (uuidString)
	获取模板字幕更多...

	getTemplateCompoundCaptions (uuidString)
	获取模板组合字幕更多...

	getTemplatePackageDirPath (uuidString)
	获取模板包路径更多...

	getTemplateCurrentAspectRatio (uuidString)
	获取模板当前纵横比更多...

	getTemplateDefaultAspectRatio (uuidString)
	获取模板缺省纵横比更多...

	writeTemplateXml (timeline, aspectRatio, uuidString)
	写XML模板更多...

	generateTemplatePackage (innerAssetDir, uuidString, outputPath)
	生成模板包更多...

	writeProjectXml (timeline, aspectRatio, uuidString)
	编写项目xml 更多...

	generateProjectPackage (innerAssetDir, uuidString, outputPath)
	生成项目资产包。更多...

	setTemplateCustomResourceDir (uuidString, dir)
	设置模板/项目自定义资源文件夹更多...

	getAssetPackageRootDir ()
	获取资源包根路径更多...

	changeTemplateAspectRatio (uuidString, aspectRatio)
	改变模板纵横比更多...

	getAssetPackageMinSdkVersion (assetPackageId, type)
	获取特效包最小支持的Sdk版本号更多...

	getExpValueList (assetPackageId, type)
	获取特效包可以调整的参数列表更多...

	getTranslationMap (assetPackageId, type)
	获取特效包参数翻译表更多...

详细描述

资源包管理器，管理视频场景中的资源包。在SDK开发过中，资源包管理器统一对需要的各种特技资源包，包括字幕、动画贴纸等进行相应的安装，升级，卸载等操作。在安装，升级，卸载时，出现差错都会有相应的错误提示类型，以便快速定位和解决错误。

成员函数说明

◆ changeTemplateAspectRatio()

NvsAssetPackageManager::changeTemplateAspectRatio	(	uuidString,
		aspectRatio
	)

inline

改变模板纵横比

参数

{String}	uuidString 字符串唯一标识
{Number}	aspectRatio 纵横比

返回: {Boolean} 返回成功或失败

◆ constructor()

NvsAssetPackageManager::constructor ( )

inline

@constructor

◆ generateProjectPackage()

NvsAssetPackageManager::generateProjectPackage	(	innerAssetDir,
		uuidString,
		outputPath
	)

inline

生成项目资产包。

参数

{String}	innerAssetDir 模板内部资产路径
{String}	uuidString 项目资源包ID
{String}	outputPath 项目资源包的输出路径

返回: {Boolean} 返回成功或失败

◆ generateTemplatePackage()

NvsAssetPackageManager::generateTemplatePackage	(	innerAssetDir,
		uuidString,
		outputPath
	)

inline

生成模板包

参数

{String}	innerAssetDir 内置资源路径
{String}	uuidString 字符串唯一标识
{String}	outputPath 输出路径

返回: {Boolean} 生成模板资产包。

◆ getAssetPackageContentType()

NvsAssetPackageManager::getAssetPackageContentType	(	assetPackageId,
		type
	)

inline

获取资源包内容类型

参数

{String}	assetPackageId 资源包id
{Number}	type 资源类型，参看NvsAssetPackageTypeEnum

返回: {String} 资源包内容类型。

◆ getAssetPackageMinSdkVersion()

NvsAssetPackageManager::getAssetPackageMinSdkVersion	(	assetPackageId,
		type
	)

inline

获取特效包最小支持的Sdk版本号

参数

{String}	assetPackageId 资源包ID
{Number}	type 资源包类型

返回: {String} 最小Sdk版本号

◆ getAssetPackageRootDir()

NvsAssetPackageManager::getAssetPackageRootDir ( )

inline

获取资源包根路径

返回: {String}

◆ getAssetPackageStatus()

NvsAssetPackageManager::getAssetPackageStatus	(	assetPackageId,
		type
	)

inline

获取资源包状态

参数

{String}	assetPackageId 资源包id
{Number}	type 资源类型，参看NvsAssetPackageTypeEnum

返回: {Number} 资源包状态，参看NvsAssetPackageStatusEnum。

◆ getAssetPackageVersion()

NvsAssetPackageManager::getAssetPackageVersion	(	assetPackageId,
		type
	)

inline

获取资源包版本号

参数

{String}	assetPackageId 资源包id
{Number}	type 资源类型，参看NvsAssetPackageTypeEnum

返回: {Number} 资源包版本号。

◆ getExpValueList()

NvsAssetPackageManager::getExpValueList	(	assetPackageId,
		type
	)

inline

获取特效包可以调整的参数列表

参数

{String}	assetPackageId 资源包ID
{Number}	type 资源包类型

返回: {NvsVectorVal<NvsParamInfoObject>} 可以调整的参数列表

◆ getInternalObject()

NvsAssetPackageManager::getInternalObject ( )

inline

获取内置对象

返回: {Object}

◆ getTemplateCaptions()

NvsAssetPackageManager::getTemplateCaptions ( uuidString )

inline

获取模板字幕

参数

{String} uuidString 字符串唯一标识

返回: {NvsVectorVal<NvsTemplateCaptionDesc>} 返回一个 ArrayList 对象，即字幕描述列表。

◆ getTemplateCompoundCaptions()

NvsAssetPackageManager::getTemplateCompoundCaptions ( uuidString )

inline

获取模板组合字幕

返回: {String} uuidString 特效uuid; {NvsVectorVal<NvsTemplateCompoundCaptionItemDesc>} 返回一个 ArrayList 对象，它是一个复合字幕描述列表。

◆ getTemplateCurrentAspectRatio()

NvsAssetPackageManager::getTemplateCurrentAspectRatio ( uuidString )

inline

获取模板当前纵横比

参数

{String} uuidString 字符串唯一标识

返回: {Number} 返回模板使用的纵横比。

◆ getTemplateDefaultAspectRatio()

NvsAssetPackageManager::getTemplateDefaultAspectRatio ( uuidString )

inline

获取模板缺省纵横比

参数

{String} uuidString 字符串唯一标识

返回: {Number} 返回模板使用的纵横比。

◆ getTemplateFootages()

NvsAssetPackageManager::getTemplateFootages ( uuidString )

inline

获取模板素材

参数

{String} uuidString 字符串唯一标识

返回: {NvsVectorVal<NvsTemplateFootageDesc>} 返回一个 ArrayList 对象，它是一个素材描述列表。

◆ getTemplatePackageDirPath()

NvsAssetPackageManager::getTemplatePackageDirPath ( uuidString )

inline

获取模板包路径

参数

{String} uuidString 特效uuid

返回: {String} 模板资产包路径

◆ getTranslationMap()

NvsAssetPackageManager::getTranslationMap	(	assetPackageId,
		type
	)

inline

获取特效包参数翻译表

参数

{String}	assetPackageId 资源包ID
{Number}	type 资源包类型

返回: {NvsVectorVal<NvsTranslationInfo>} 参数翻译表

◆ getVideoFxAssetPackageDescription()

NvsAssetPackageManager::getVideoFxAssetPackageDescription ( uuidString )

inline

获取视频特效资源包描述

参数

{String} uuidString 资源包id

返回: {String} 描述字符串

◆ installAssetPackage()

NvsAssetPackageManager::installAssetPackage	(	assetPackageFilePath,
		licenseFilePath,
		type
	)

inline

安装资源包调用此函数后，会接收到回调函数onFinishAssetPackageInstallation返回安装结果。 onFinishAssetPackageInstallation返回参数包括assetPackageId、assetPackageFilePath、assetPackageType和error。 assetPackageId是当前安装完成的资源包id， assetPackageFilePath是当前安装完成的资源包文件路径， assetPackageType是当前安装完成的资源包类型， error是当前安装完成的错误码，参看NvsAssetPackageErrorEnum。

参数

{String}	assetPackageFilePath 资源包文件路径
{String}	licenseFilePath 授权文件路径
{Number}	type 资源类型，参看NvsAssetPackageTypeEnum

◆ isParticleFX()

NvsAssetPackageManager::isParticleFX ( uuidString )

inline

是否是粒子特效

参数

{String} uuidString 粒子特效uuid

返回: {Boolean} 返回一个布尔对象，表示它是否是粒子特效。

◆ setInternalObject()

NvsAssetPackageManager::setInternalObject ( obj )

inline

设置内置对象

参数

{Object} obj 内置对象

◆ setTemplateCustomResourceDir()

NvsAssetPackageManager::setTemplateCustomResourceDir	(	uuidString,
		dir
	)

inline

设置模板/项目自定义资源文件夹

参数

{String}	uuidString 模板内部资产路径
{String}	dir 项目资源包ID

返回: {Boolean} 返回成功或失败

◆ uninstallAssetPackage()

NvsAssetPackageManager::uninstallAssetPackage	(	assetPackageId,
		type
	)

inline

卸载资源包

参数

{String}	assetPackageId 资源包id
{Number}	type 资源类型，参看NvsAssetPackageTypeEnum

返回: {Number} 返回卸载资源包结果，参看NvsAssetPackageErrorEnum。

◆ upgradeAssetPackage()

NvsAssetPackageManager::upgradeAssetPackage	(	assetPackageFilePath,
		licenseFilePath,
		type
	)

inline

升级资源包调用此函数后，会接收到回调函数onFinishAssetPackageUpgrading返回升级结果。 onFinishAssetPackageUpgrading返回参数包括assetPackageId、assetPackageFilePath、assetPackageType和error。 assetPackageId是当前升级完成的资源包id， assetPackageFilePath是当前升级完成的资源包文件路径， assetPackageType是当前升级完成的资源包类型， error是当前升级完成的错误码，参看NvsAssetPackageErrorEnum。

参数

{String}	assetPackageFilePath 资源包文件路径
{String}	licenseFilePath 授权文件路径
{Number}	type 资源类型，参看NvsAssetPackageTypeEnum

◆ writeProjectXml()

NvsAssetPackageManager::writeProjectXml	(	timeline,
		aspectRatio,
		uuidString
	)

inline

编写项目xml

参数

{NvsTimeline}	timeline 时间线
{Number}	aspectRatio 纵横比
{String}	uuidString 特效uuid

返回: {Boolean}

◆ writeTemplateXml()

NvsAssetPackageManager::writeTemplateXml	(	timeline,
		aspectRatio,
		uuidString
	)

inline

写XML模板

参数

{NvsTimeline}	timeline
{Number}	aspectRatio 纵横比
{String}	uuidString 特效uuid

返回: {Boolean}

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

src/js/NvStreamingSdk.js

Public 成员函数

详细描述

成员函数说明

◆ changeTemplateAspectRatio()

◆ constructor()

◆ generateProjectPackage()

◆ generateTemplatePackage()

◆ getAssetPackageContentType()

◆ getAssetPackageMinSdkVersion()

◆ getAssetPackageRootDir()

◆ getAssetPackageStatus()

◆ getAssetPackageVersion()

◆ getExpValueList()

◆ getInternalObject()

◆ getTemplateCaptions()

◆ getTemplateCompoundCaptions()

◆ getTemplateCurrentAspectRatio()

◆ getTemplateDefaultAspectRatio()

◆ getTemplateFootages()

◆ getTemplatePackageDirPath()

◆ getTranslationMap()

◆ getVideoFxAssetPackageDescription()

◆ installAssetPackage()

◆ isParticleFX()

◆ setInternalObject()

◆ setTemplateCustomResourceDir()

◆ uninstallAssetPackage()

◆ upgradeAssetPackage()

◆ writeProjectXml()

◆ writeTemplateXml()