NveAssetPackageManager Class Reference

The asset package manager manages the asset packages in the video scene. During the development of SDK, the asset package manager uniformly installs, upgrades and uninstalls various stunt asset packages needed, including captions, animated stickers, etc. When installing, upgrading and uninstalling, there will be corresponding error prompt types in case of errors, so as to quickly locate and solve the errors. More...

Public Member Functions
	constructor ()
	setInternalObject (obj)
	Set internal object. More...
	getInternalObject ()
	Get internal object. More...
	installAssetPackage (assetPackageFilePath, licenseFilePath, type)
	Install asset package. After calling this funtion, onFinishAssetPackageInstallation will be received with the result of installation. onFinishAssetPackageInstallation contains assetPackageId, assetPackageFilePath, assetPackageType and error parameters. assetPackageId is the asset package id of the finished installation, assetPackageFilePath is the asset package file path of the finished installation, assetPackageType is the asset package type of the finished installation, error is the error of the finished installation, see NveAssetPackageErrorEnum. More...
	uninstallAssetPackage (assetPackageId, type)
	Uninstall asset package. More...
	getAssetPackageStatus (assetPackageId, type)
	Get the status of the asset package. More...
	getAssetPackageContentType (assetPackageId, type)
	Get the content type of the asset package. More...

Detailed Description

The asset package manager manages the asset packages in the video scene. During the development of SDK, the asset package manager uniformly installs, upgrades and uninstalls various stunt asset packages needed, including captions, animated stickers, etc. When installing, upgrading and uninstalling, there will be corresponding error prompt types in case of errors, so as to quickly locate and solve the errors.

Member Function Documentation

constructor()

NveAssetPackageManager::constructor ( )

inline

@constructor

getAssetPackageContentType()

NveAssetPackageManager::getAssetPackageContentType (   assetPackageId,   type  )

inline

Get the content type of the asset package.

Parameters

{String}	assetPackageId Asset package id
{Number}	type Asset package type, see NveAssetPackageTypeEnum.

Returns

{String} The content type of the asset package.

getAssetPackageStatus()

NveAssetPackageManager::getAssetPackageStatus (   assetPackageId,   type  )

inline

Get the status of the asset package.

Parameters

{String}	assetPackageId Asset package id
{Number}	type Asset package type, see NveAssetPackageTypeEnum.

Returns

{Number} The status of the asset package, see NveAssetPackageStatusEnum.

getInternalObject()

NveAssetPackageManager::getInternalObject ( )

inline

Get internal object.

Returns

{Object}

installAssetPackage()

NveAssetPackageManager::installAssetPackage (   assetPackageFilePath,   licenseFilePath,   type  )

inline

Install asset package. After calling this funtion, onFinishAssetPackageInstallation will be received with the result of installation. onFinishAssetPackageInstallation contains assetPackageId, assetPackageFilePath, assetPackageType and error parameters. assetPackageId is the asset package id of the finished installation, assetPackageFilePath is the asset package file path of the finished installation, assetPackageType is the asset package type of the finished installation, error is the error of the finished installation, see NveAssetPackageErrorEnum.

Parameters

{String}	assetPackageFilePath File path of the asset package to be installed
{String}	licenseFilePath License file path of the asset package to be installed
{Number}	type The type of asset package to be installed, see NveAssetPackageTypeEnum.

setInternalObject()

NveAssetPackageManager::setInternalObject (   obj )

inline

Set internal object.

Parameters

{Object}

obj Internal object

uninstallAssetPackage()

NveAssetPackageManager::uninstallAssetPackage (   assetPackageId,   type  )

inline

Uninstall asset package.

Parameters

{String}	assetPackageId Id of asset package to be uninstalled
{Number}	type The type of asset package to be uninstalled, see NveAssetPackageTypeEnum.

Returns

{Number} The result of uninstallation, see NveAssetPackageTypeEnum.

---

The documentation for this class was generated from the following file:

• src/js/NvEffectSdk.js