Resource package manager, managing resource bundles in video scenarios. More...

Classes
class	ARSceneBeautyPreset
	ARScene resource package beauty parameters resolved after the object. The value range of all float types is: [0, 1]. More...

class	ARSceneCameraPreset
	ARScene resource package camera parameters resolved after the object. More...

class	ARSceneShapeBeautificationPreset
	ARScene resource package Shape Beauty parameters resolved after the object. The value range of all float types is: [-1, 1]. More...

interface	AssetPackageManagerCallback
	Resource package management callback interface. More...

interface	GenerateTemplateCallback
	Template resource package generation callback interface. More...

class	NvsTemplateCaptionDesc
	The caption information corresponding to footage of template asset. More...

class	NvsTemplateCompoundCaptionDesc
	The All compound caption informations corresponding to footage of template asset. More...

class	NvsTemplateCompoundCaptionItemDesc
	The compound caption information corresponding to footage of template asset. More...

class	NvsTemplateFootageCorrespondingClipInfo
	The clip information corresponding to footage of template asset. More...

class	NvsTemplateFootageDesc
	The footage information of template asset(TEIMPLATE_FOOTAGE_TYPE) More...

Public Member Functions
	NvsAssetPackageManager (boolean isEffectSdk)
	NvsAssetPackageManager construction method. General condition dont need use this method to initialization this object. More...

void	setCallbackInterface (AssetPackageManagerCallback callback)
	Sets the package manager callback interface. More...

void	setGenerateTemplateCallbackInterface (GenerateTemplateCallback callback)
	Sets the generate template callback interface. More...

String	getAssetPackageIdFromAssetPackageFilePath (String assetPackageFilePath)
	Gets the ID of the resource package from the file path of the resource package. More...

int	getAssetPackageVersionFromAssetPackageFilePath (String assetPackageFilePath)
	Gets the version of the resource package from the file path of the resource package. More...

String	getAssetPackageContentType (String assetPackageId, int assetType)
	Get the content type from the resource package. More...

int	installAssetPackage (String assetPackageFilePath, String licenseFilePath, int type, boolean synchronous, StringBuilder assetPackageId)
	Installs resource package. More...

int	upgradeAssetPackage (String assetPackageFilePath, String licenseFilePath, int type, boolean synchronous, StringBuilder assetPackageId)
	Upgrades resource package. More...

int	uninstallAssetPackage (String assetPackageId, int type)
	Uninstalls resource package. More...

int	getAssetPackageStatus (String assetPackageId, int type)
	Gets the status of the resource package from the file path of the resource package. More...

int	getAssetPackageVersion (String assetPackageId, int type)
	Gets the version of the resource bundle. More...

int	getAssetPackageSupportedAspectRatio (String assetPackageId, int type)
	Gets the supported aspect ratio of the resource package. More...

List< String >	getAssetPackageListOfType (int type)
	Gets a list of resource packages of a certain type. More...

boolean	isCustomAnimatedSticker (String uuidString)
	Determines if it is a custom sticker. More...

boolean	isParticleFX (String uuidString)
	Determines whether it is a particle effect. More...

boolean	isThemeContainMusic (String uuidString)
	Check whether a theme package contain music. More...

String	getVideoFxAssetPackageDescription (String uuidString)
	Gets the resource description of the VideoFx type. More...

boolean	changeTemplateAspectRatio (String uuidString, int aspectRatio)
	Change aspect ratio of template. More...

List< NvsTemplateFootageDesc >	getTemplateFootages (String uuidString)
	Gets the footage description list of the Template asset. More...

List< NvsTemplateCaptionDesc >	getTemplateCaptions (String uuidString)
	Gets the caption description list of the Template asset. More...

int	getTemplateCurrentAspectRatio (String uuidString)
	Gets the aspect ratio which is template using. More...

int	getTemplateDefaultAspectRatio (String uuidString)
	Gets the default aspect ratio of template. More...

List< NvsTemplateCompoundCaptionDesc >	getTemplateCompoundCaptions (String uuidString)
	Gets the compound caption description list of the Template asset. More...

String	getARSceneAssetPackagePrompt (String uuidString)
	Get the prompt message of the ARScene asset package. More...

boolean	isARSceneAssetPackageContainMakeup (String uuidString)
	Is arScene assetPackage conflit with makeup. More...

boolean	isARSceneAssetPackageContainFaceMesh (String uuidString)
	Is arScene assetPackage conflit with face mesh. More...

boolean	isARSceneAssetPackageContainWarp (String uuidString)
	Is arScene assetPackage conflit with warp. More...

ARSceneBeautyPreset	getARSceneAssetPackageBeautyPreset (String uuidString)
	Get Beauty effect preset in a ARScene asset package. More...

ARSceneShapeBeautificationPreset	getARSceneAssetPackageShapeBeautificationPreset (String uuidString)
	Get Beauty effect preset in a ARScene asset package. More...

ARSceneCameraPreset	getARSceneAssetPackageCameraPreset (String uuidString)
	Get camera preset in a ARScene asset package. More...

List< NvsExpressionParam >	getExpValueList (String uuidString, int type)
	Get expression list of asset package, need to install this package before use this method. More...

Hashtable	getTranslationMap (String uuidString, int type)
	Get tanslation map of asset package, need to install this package before use this method. More...

boolean	hasAudioInAssetPackage (String uuidString, int type)

boolean	hasDetectionInAssetPackage (String uuidString, int type)
	Is ARScene package need detection. More...

Static Public Attributes
resource package type

static final int	ASSET_PACKAGE_TYPE_VIDEOFX = 0
	Video effect type. More...

static final int	ASSET_PACKAGE_TYPE_VIDEOTRANSITION = 1
	Video transition type. More...

static final int	ASSET_PACKAGE_TYPE_CAPTIONSTYLE = 2
	Caption style type. More...

static final int	ASSET_PACKAGE_TYPE_ANIMATEDSTICKER = 3
	Animated sticker type. More...

static final int	ASSET_PACKAGE_TYPE_THEME = 4
	Theme type. More...

static final int	ASSET_PACKAGE_TYPE_CAPTURESCENE = 5
	Capture scene type. More...

static final int	ASSET_PACKAGE_TYPE_ARSCENE = 6
	AR scene type. More...

static final int	ASSET_PACKAGE_TYPE_COMPOUND_CAPTION = 7
	Compound caption type. More...

static final int	ASSET_PACKAGE_TYPE_CAPTION_CONTEXT = 8
	Modular caption context type. More...

static final int	ASSET_PACKAGE_TYPE_CAPTION_RENDERER = 9
	Modular caption renderer type. More...

static final int	ASSET_PACKAGE_TYPE_CAPTION_ANIMATION = 10
	Modular caption animation type. More...

static final int	ASSET_PACKAGE_TYPE_CAPTION_IN_ANIMATION = 11
	Modular caption in-animation type. More...

static final int	ASSET_PACKAGE_TYPE_CAPTION_OUT_ANIMATION = 12
	Modular caption out-animation type. More...

static final int	ASSET_PACKAGE_TYPE_TEMPLATE = 13
	Template type. More...

static final int	ASSET_PACKAGE_TYPE_AVATAR_MODEL = 14
	Custom avatar model type. More...

static final int	ASSET_PACKAGE_TYPE_AVATAR_MATERIAL = 15
	Custom avatar material type. More...

static final int	ASSET_PACKAGE_TYPE_ANIMATEDSTICKER_ANIMATION = 16
	Sticker period animation type. More...

static final int	ASSET_PACKAGE_TYPE_ANIMATEDSTICKER_IN_ANIMATION = 17
	Sticker in animation type. More...

static final int	ASSET_PACKAGE_TYPE_ANIMATEDSTICKER_OUT_ANIMATION = 18
	Sticker out animation type. More...

static final int	ASSET_PACKAGE_TYPE_MAKEUP = 19
	Makeup type. More...

static final int	ASSET_PACKAGE_TYPE_FACE_MESH = 20
	Face mesh type. More...

static final int	ASSET_PACKAGE_TYPE_WARP = 21
	Warp type. More...

static final int	ASSET_PACKAGE_TYPE_PROJECT = 22

resource package state

static final int	ASSET_PACKAGE_STATUS_NOTINSTALLED = 0
	Uninstalled state. More...

static final int	ASSET_PACKAGE_STATUS_INSTALLING = 1
	Installing status. More...

static final int	ASSET_PACKAGE_STATUS_READY = 2
	Preparation status. More...

static final int	ASSET_PACKAGE_STATUS_UPGRADING = 3
	Upgrading status. More...

Resource package management error type

static final int	ASSET_PACKAGE_MANAGER_ERROR_NO_ERROR = 0
	Installed successfully. More...

static final int	ASSET_PACKAGE_MANAGER_ERROR_NAME = 1
	Wrong name. More...

static final int	ASSET_PACKAGE_MANAGER_ERROR_ALREADY_INSTALLED = 2
	Already installed. More...

static final int	ASSET_PACKAGE_MANAGER_ERROR_WORKING_INPROGRESS = 3
	Installation or upgrade in progress. More...

static final int	ASSET_PACKAGE_MANAGER_ERROR_NOT_INSTALLED = 4
	Not installed yet. More...

static final int	ASSET_PACKAGE_MANAGER_ERROR_IMPROPER_STATUS = 5
	Incorrect status. More...

static final int	ASSET_PACKAGE_MANAGER_ERROR_DECOMPRESSION = 6
	Decompression error. More...

static final int	ASSET_PACKAGE_MANAGER_ERROR_INVALID_PACKAGE = 7
	Invalid package. More...

static final int	ASSET_PACKAGE_MANAGER_ERROR_ASSET_TYPE = 8
	Resource type error. More...

static final int	ASSET_PACKAGE_MANAGER_ERROR_PERMISSION = 9
	License error. More...

static final int	ASSET_PACKAGE_MANAGER_ERROR_META_CONTENT = 10
	Meta content error. More...

static final int	ASSET_PACKAGE_MANAGER_ERROR_SDK_VERSION = 11
	SDK version error. More...

static final int	ASSET_PACKAGE_MANAGER_ERROR_UPGRADE_VERSION = 12
	Upgrade version error. More...

static final int	ASSET_PACKAGE_MANAGER_ERROR_IO = 13
	Input and output error. More...

static final int	ASSET_PACKAGE_MANAGER_ERROR_RESOURCE = 14
	Resource error. More...

Aspect ratio supported by the resource package

static final int	ASSET_PACKAGE_ASPECT_RATIO_16v9 = 1

static final int	ASSET_PACKAGE_ASPECT_RATIO_1v1 = 2

static final int	ASSET_PACKAGE_ASPECT_RATIO_9v16 = 4

static final int	ASSET_PACKAGE_ASPECT_RATIO_4v3 = 8

static final int	ASSET_PACKAGE_ASPECT_RATIO_3v4 = 16

static final int	ASSET_PACKAGE_ASPECT_RATIO_18v9 = 32

static final int	ASSET_PACKAGE_ASPECT_RATIO_9v18 = 64

Footage type of template asset

static final int	TEIMPLATE_FOOTAGE_TYPE_VIDEO_IMAGE = 0

static final int	TEIMPLATE_FOOTAGE_TYPE_VIDEO = 1

static final int	TEIMPLATE_FOOTAGE_TYPE_IMAGE = 2

static final int	TEIMPLATE_FOOTAGE_TYPE_AUDIO = 3

static final int	TEIMPLATE_FOOTAGE_TYPE_FREEZE_FRAME = 4

Detailed Description

Resource package manager, managing resource bundles in video scenarios.

In the development of the SDK, the resource package manager unifies the various special resource packages including subtitles, themes, animation stickers, etc. for installation, upgrade, and uninstallation. When installing, upgrading, and uninstalling, there will be a corresponding error type for errors to be quickly located and resolved.

Warning: In the NvsAssetPackageManager class, all public APIs are used in the UI thread! ! !

Constructor & Destructor Documentation

◆ NvsAssetPackageManager()

com.meicam.sdk.NvsAssetPackageManager.NvsAssetPackageManager ( boolean isEffectSdk )

inline

NvsAssetPackageManager construction method. General condition dont need use this method to initialization this object.

Because when the context(Like NvStreamingContext or NvsEffectSdkContext) initialization, this object will be initialization at the same time.

you can use getAssetPackageManager() method from Context object to get NvsAssetPackageManager object.

Parameters

Is	use EffectSdk.when you use NvsEffectSdkContext.

Member Function Documentation

◆ changeTemplateAspectRatio()

boolean com.meicam.sdk.NvsAssetPackageManager.changeTemplateAspectRatio	(	String	uuidString,
		int	aspectRatio
	)

inline

Change aspect ratio of template.

Parameters

uuidString special effect uuid

Returns: Returns suc or not

Since: 2.18.1

◆ getARSceneAssetPackageBeautyPreset()

ARSceneBeautyPreset com.meicam.sdk.NvsAssetPackageManager.getARSceneAssetPackageBeautyPreset ( String uuidString )

inline

Get Beauty effect preset in a ARScene asset package.

Parameters

uuidString asset package uuid

Returns: Returns a ARSceneBeautyPreset object which contain preset, returns null if preset is not available

Since: 2.9.0

◆ getARSceneAssetPackageCameraPreset()

ARSceneCameraPreset com.meicam.sdk.NvsAssetPackageManager.getARSceneAssetPackageCameraPreset ( String uuidString )

inline

Get camera preset in a ARScene asset package.

Parameters

uuidString asset package uuid

Returns: Returns a ARSceneCameraPreset object which contain preset, returns null if preset is not available

Since: 3.7.2

◆ getARSceneAssetPackagePrompt()

String com.meicam.sdk.NvsAssetPackageManager.getARSceneAssetPackagePrompt ( String uuidString )

inline

Get the prompt message of the ARScene asset package.

Parameters

uuidString asset package uuid

Returns: Returns a String object which represent the prompt message.

Since: 2.9.0

◆ getARSceneAssetPackageShapeBeautificationPreset()

ARSceneShapeBeautificationPreset com.meicam.sdk.NvsAssetPackageManager.getARSceneAssetPackageShapeBeautificationPreset ( String uuidString )

inline

Get Beauty effect preset in a ARScene asset package.

Parameters

uuidString asset package uuid

Returns: Returns a ARSceneShapeBeautificationPreset object which contain preset, returns null if preset is not available

Since: 2.9.0

◆ getAssetPackageContentType()

String com.meicam.sdk.NvsAssetPackageManager.getAssetPackageContentType	(	String	assetPackageId,
		int	assetType
	)

inline

Get the content type from the resource package.

Parameters

assetPackageId	Package id.
assetType	Package type.

Returns: Content type.

Since: 3.5.2

◆ getAssetPackageIdFromAssetPackageFilePath()

String com.meicam.sdk.NvsAssetPackageManager.getAssetPackageIdFromAssetPackageFilePath ( String assetPackageFilePath )

inline

Gets the ID of the resource package from the file path of the resource package.

Parameters

assetPackageFilePath Resource file path

Returns: Returns a string representing the resource package ID

Warning: By the character in the path, so do not change the file name!

◆ getAssetPackageListOfType()

List<String> com.meicam.sdk.NvsAssetPackageManager.getAssetPackageListOfType ( int type )

inline

Gets a list of resource packages of a certain type.

Parameters

type	Resource package type. Note: The parameter to be entered is a value of static int type, and is prefixed with ASSET_PACKAGE_TYPE. Please refer to resource package type.

Returns: Returns a list of resource packages under a certain type. Each element in the list is a resource package ID.

◆ getAssetPackageStatus()

int com.meicam.sdk.NvsAssetPackageManager.getAssetPackageStatus	(	String	assetPackageId,
		int	type
	)

inline

Gets the status of the resource package from the file path of the resource package.

Parameters

assetPackageId	Resource package ID to be checked.
type	The type of the resource package to be queried. Note: The parameter to be entered is a value of static int type and is prefixed with ASSET_PACKAGE_TYPE. Please refer to resource package type.

Returns: Returns the current state value of the resource package.

Note: The return value is a static int value prefixed with ASSET_PACKAGE_STATUS. 0, namely ASSET_PACKAGE_STATUS_NOTINSTALLED, indicates that the package has not been installed. Please refer to resource package status.

◆ getAssetPackageSupportedAspectRatio()

int com.meicam.sdk.NvsAssetPackageManager.getAssetPackageSupportedAspectRatio	(	String	assetPackageId,
		int	type
	)

inline

Gets the supported aspect ratio of the resource package.

Parameters

assetPackageId	Resource package ID
type	Resource package type. Note: The parameter to be entered is a value of static int type, and is prefixed with ASSET_PACKAGE_TYPE. Please refer to resource package type.

Returns: Returns the supported aspect ratio of the resource package. This value is the result of bitwise OR of several aspect ratios. Please refer to Aspect Ratio Supported Aspect Ratio.

◆ getAssetPackageVersion()

int com.meicam.sdk.NvsAssetPackageManager.getAssetPackageVersion	(	String	assetPackageId,
		int	type
	)

inline

Gets the version of the resource bundle.

Parameters

assetPackageId	Resource package ID
type	Resource package type. Note: The parameter to be entered is a value of static int type, and is prefixed with ASSET_PACKAGE_TYPE. Please refer to resource package type.

Returns: Returns the obtained resource bundle version.

Need install this package before use this method.Please check this package status by getAssetPackageStatus()

◆ getAssetPackageVersionFromAssetPackageFilePath()

int com.meicam.sdk.NvsAssetPackageManager.getAssetPackageVersionFromAssetPackageFilePath ( String assetPackageFilePath )

inline

Gets the version of the resource package from the file path of the resource package.

Parameters

assetPackageFilePath Resource file path

Returns: Returns the resource bundle version. Return 1 if the resource bundle does not contain a version number.

Warning: By the character in the path, so do not change the file name!

◆ getExpValueList()

List<NvsExpressionParam> com.meicam.sdk.NvsAssetPackageManager.getExpValueList	(	String	uuidString,
		int	type
	)

inline

Get expression list of asset package, need to install this package before use this method.

Parameters

uuidString	Asset package id
type	Asset package type. Please refer to resource package type

Returns: Expression list of asset package

◆ getTemplateCaptions()

List<NvsTemplateCaptionDesc> com.meicam.sdk.NvsAssetPackageManager.getTemplateCaptions ( String uuidString )

inline

Gets the caption description list of the Template asset.

Parameters

uuidString special effect uuid

Returns: Returns a ArrayList object, which is a caption description list.

Since: 2.18.1

◆ getTemplateCompoundCaptions()

List<NvsTemplateCompoundCaptionDesc> com.meicam.sdk.NvsAssetPackageManager.getTemplateCompoundCaptions ( String uuidString )

inline

Gets the compound caption description list of the Template asset.

Parameters

uuidString special effect uuid

Returns: Returns a ArrayList object, which is a compound caption description list.

Since: 2.18.1

◆ getTemplateCurrentAspectRatio()

int com.meicam.sdk.NvsAssetPackageManager.getTemplateCurrentAspectRatio ( String uuidString )

inline

Gets the aspect ratio which is template using.

Parameters

uuidString special effect uuid

Returns: Returns aspect ratio which is template using

Since: 2.18.1

◆ getTemplateDefaultAspectRatio()

int com.meicam.sdk.NvsAssetPackageManager.getTemplateDefaultAspectRatio ( String uuidString )

inline

Gets the default aspect ratio of template.

Parameters

uuidString special effect uuid

Returns: Returns aspect ratio which is template using

Since: 2.18.1

◆ getTemplateFootages()

List<NvsTemplateFootageDesc> com.meicam.sdk.NvsAssetPackageManager.getTemplateFootages ( String uuidString )

inline

Gets the footage description list of the Template asset.

Parameters

uuidString special effect uuid

Returns: Returns a ArrayList object, which is a footage description list.

Since: 2.18.1

◆ getTranslationMap()

Hashtable com.meicam.sdk.NvsAssetPackageManager.getTranslationMap	(	String	uuidString,
		int	type
	)

inline

Get tanslation map of asset package, need to install this package before use this method.

Parameters

uuidString	Asset package id
type	Asset package type. Please refer to resource package type

Returns: Tanslation map of asset package

◆ getVideoFxAssetPackageDescription()

String com.meicam.sdk.NvsAssetPackageManager.getVideoFxAssetPackageDescription ( String uuidString )

inline

Gets the resource description of the VideoFx type.

Parameters

uuidString special effect uuid

Returns: Returns a String object, which is a resource description.

Since: 1.14.0

◆ hasAudioInAssetPackage()

boolean com.meicam.sdk.NvsAssetPackageManager.hasAudioInAssetPackage	(	String	uuidString,
		int	type
	)

inline

Returns

◆ hasDetectionInAssetPackage()

boolean com.meicam.sdk.NvsAssetPackageManager.hasDetectionInAssetPackage	(	String	uuidString,
		int	type
	)

inline

Is ARScene package need detection.

Returns: Is need detection

◆ installAssetPackage()

int com.meicam.sdk.NvsAssetPackageManager.installAssetPackage	(	String	assetPackageFilePath,
		String	licenseFilePath,
		int	type,
		boolean	synchronous,
		StringBuilder	assetPackageId
	)

inline

Installs resource package.

Parameters

assetPackageFilePath	File path of the resource package to be installed.
licenseFilePath	Authorization file path of the resource package to be installed.
type	The type of resource package to be installed. Note: The parameter to be entered is the value of the static int attribute prefixed with ASSET_PACKAGE_TYPE. Please refer to resource package type
synchronous	Whether to install synchronously. A value of true means the installation process will block the current thread until it succeeds or fails, false means that the result of the installation process is asynchronously notified by the delegate (It can also be notified by the current thread). Notice: if type is template, this param will be ignored and will install asynchronously
assetPackageId	Output parameter, which returns the resource package ID.

Returns: Returns an integer value indicating the type of resource package error.

Note: Note: The return value is of the static int type, and is prefixed with ASSET_PACKAGE_MANAGER_ERROR. "ASSET_PACKAGE_MANAGER_ERROR_NO_ERROR" indicates a successful installation (this may only be returned if the installation is synchronized), while any other value suggests an error. Please refer to Resource Package Management Error Type.

See also: upgradeAssetPackage uninstallAssetPackage

◆ isARSceneAssetPackageContainFaceMesh()

boolean com.meicam.sdk.NvsAssetPackageManager.isARSceneAssetPackageContainFaceMesh ( String uuidString )

inline

Is arScene assetPackage conflit with face mesh.

Parameters

uuidString asset package uuid

Returns: Returns is conflit

Since: 3.4.0

◆ isARSceneAssetPackageContainMakeup()

boolean com.meicam.sdk.NvsAssetPackageManager.isARSceneAssetPackageContainMakeup ( String uuidString )

inline

Is arScene assetPackage conflit with makeup.

Parameters

uuidString asset package uuid

Returns: Returns is conflit

Since: 3.1.1

◆ isARSceneAssetPackageContainWarp()

boolean com.meicam.sdk.NvsAssetPackageManager.isARSceneAssetPackageContainWarp ( String uuidString )

inline

Is arScene assetPackage conflit with warp.

Parameters

uuidString asset package uuid

Returns: Returns is conflit

Since: 3.4.0

◆ isCustomAnimatedSticker()

boolean com.meicam.sdk.NvsAssetPackageManager.isCustomAnimatedSticker ( String uuidString )

inline

Determines if it is a custom sticker.

Parameters

uuidString sticker uuid

Returns: Returns a boolean object indicating whether it is a custom sticker.

Since: 1.11.0

◆ isParticleFX()

boolean com.meicam.sdk.NvsAssetPackageManager.isParticleFX ( String uuidString )

inline

Determines whether it is a particle effect.

Parameters

uuidString particle effect uuid

Returns: Returns a boolean object indicating whether it is a particle effect.

Since: 1.14.0

◆ isThemeContainMusic()

boolean com.meicam.sdk.NvsAssetPackageManager.isThemeContainMusic ( String uuidString )

inline

Check whether a theme package contain music.

Parameters

uuidString theme package uuid

Returns: Returns boolean value indicating whether it contains music.

Since: 2.6.0

◆ setCallbackInterface()

void com.meicam.sdk.NvsAssetPackageManager.setCallbackInterface ( AssetPackageManagerCallback callback )

inline

Sets the package manager callback interface.

Parameters

callback Package manager callback interface

◆ setGenerateTemplateCallbackInterface()

void com.meicam.sdk.NvsAssetPackageManager.setGenerateTemplateCallbackInterface ( GenerateTemplateCallback callback )

inline

Sets the generate template callback interface.

Parameters

callback generate template callback interface

Since: 2.19.1

◆ uninstallAssetPackage()

int com.meicam.sdk.NvsAssetPackageManager.uninstallAssetPackage	(	String	assetPackageId,
		int	type
	)

inline

Uninstalls resource package.

Parameters

assetPackageId	ID of the resource package to be uninstalled
type	The type of resource package to be uninstalled. Note: The parameter to be entered is a value of static int type and is prefixed with ASSET_PACKAGE_TYPE. Please refer to resource package type

Returns: Returns an integer value indicating the type of resource package error.

Note: The return value is a value of static int type and is prefixed with ASSET_PACKAGE_MANAGER_ERROR. If ASSET_PACKAGE_MANAGER_ERROR_NO_ERROR is returned, the uninstallation is successful, otherwise the uninstallation fails. Please refer to Resource Package Management Error Type.

See also: installAssetPackage upgradeAssetPackage

◆ upgradeAssetPackage()

int com.meicam.sdk.NvsAssetPackageManager.upgradeAssetPackage	(	String	assetPackageFilePath,
		String	licenseFilePath,
		int	type,
		boolean	synchronous,
		StringBuilder	assetPackageId
	)

inline

Upgrades resource package.

Parameters

assetPackageFilePath	File path of the resource package to be upgraded
licenseFilePath	Authorization file path of the resource bundle to be upgraded
type	The type of resource bundle to be upgraded. Note: The parameter to be entered is a value of static int attribute prefixed with ASSET_PACKAGE_TYPE. Please refer to Resource Type.
synchronous	Whether to upgrade synchronously. If the value is true, the upgrade process will block the current thread until it succeeds or fails. If it is false, the result of the upgrade process is asynchronously notified by the delegate (It can also be notified by the current thread). Notice: if type is template, this param will be ignored and will be upgraded asynchronously
assetPackageId	Output parameter, which returns the resource package ID

Returns: Returns an integer value indicating the type of resource package error.

Note: The return value is of static int type and is prefixed with ASSET_PACKAGE_MANAGER_ERROR. "ASSET_PACKAGE_MANAGER_ERROR_NO_ERROR:" indicates a successful upgrade (This may only be returned if the upgrade is synchronized), while any other value suggests a upgrade error. Please refer to Resource Package Management Error Type.

See also: installAssetPackage uninstallAssetPackage

Member Data Documentation

◆ ASSET_PACKAGE_ASPECT_RATIO_16v9

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_ASPECT_RATIO_16v9 = 1

static

◆ ASSET_PACKAGE_ASPECT_RATIO_18v9

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_ASPECT_RATIO_18v9 = 32

static

◆ ASSET_PACKAGE_ASPECT_RATIO_1v1

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_ASPECT_RATIO_1v1 = 2

static

◆ ASSET_PACKAGE_ASPECT_RATIO_3v4

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_ASPECT_RATIO_3v4 = 16

static

◆ ASSET_PACKAGE_ASPECT_RATIO_4v3

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_ASPECT_RATIO_4v3 = 8

static

◆ ASSET_PACKAGE_ASPECT_RATIO_9v16

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_ASPECT_RATIO_9v16 = 4

static

◆ ASSET_PACKAGE_ASPECT_RATIO_9v18

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_ASPECT_RATIO_9v18 = 64

static

◆ ASSET_PACKAGE_MANAGER_ERROR_ALREADY_INSTALLED

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_MANAGER_ERROR_ALREADY_INSTALLED = 2

static

Already installed.

◆ ASSET_PACKAGE_MANAGER_ERROR_ASSET_TYPE

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_MANAGER_ERROR_ASSET_TYPE = 8

static

Resource type error.

◆ ASSET_PACKAGE_MANAGER_ERROR_DECOMPRESSION

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_MANAGER_ERROR_DECOMPRESSION = 6

static

Decompression error.

◆ ASSET_PACKAGE_MANAGER_ERROR_IMPROPER_STATUS

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_MANAGER_ERROR_IMPROPER_STATUS = 5

static

Incorrect status.

◆ ASSET_PACKAGE_MANAGER_ERROR_INVALID_PACKAGE

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_MANAGER_ERROR_INVALID_PACKAGE = 7

static

Invalid package.

◆ ASSET_PACKAGE_MANAGER_ERROR_IO

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_MANAGER_ERROR_IO = 13

static

Input and output error.

◆ ASSET_PACKAGE_MANAGER_ERROR_META_CONTENT

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_MANAGER_ERROR_META_CONTENT = 10

static

Meta content error.

◆ ASSET_PACKAGE_MANAGER_ERROR_NAME

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_MANAGER_ERROR_NAME = 1

static

Wrong name.

◆ ASSET_PACKAGE_MANAGER_ERROR_NO_ERROR

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_MANAGER_ERROR_NO_ERROR = 0

static

Installed successfully.

◆ ASSET_PACKAGE_MANAGER_ERROR_NOT_INSTALLED

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_MANAGER_ERROR_NOT_INSTALLED = 4

static

Not installed yet.

◆ ASSET_PACKAGE_MANAGER_ERROR_PERMISSION

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_MANAGER_ERROR_PERMISSION = 9

static

License error.

◆ ASSET_PACKAGE_MANAGER_ERROR_RESOURCE

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_MANAGER_ERROR_RESOURCE = 14

static

Resource error.

◆ ASSET_PACKAGE_MANAGER_ERROR_SDK_VERSION

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_MANAGER_ERROR_SDK_VERSION = 11

static

SDK version error.

◆ ASSET_PACKAGE_MANAGER_ERROR_UPGRADE_VERSION

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_MANAGER_ERROR_UPGRADE_VERSION = 12

static

Upgrade version error.

◆ ASSET_PACKAGE_MANAGER_ERROR_WORKING_INPROGRESS

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_MANAGER_ERROR_WORKING_INPROGRESS = 3

static

Installation or upgrade in progress.

◆ ASSET_PACKAGE_STATUS_INSTALLING

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_STATUS_INSTALLING = 1

static

Installing status.

◆ ASSET_PACKAGE_STATUS_NOTINSTALLED

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_STATUS_NOTINSTALLED = 0

static

Uninstalled state.

◆ ASSET_PACKAGE_STATUS_READY

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_STATUS_READY = 2

static

Preparation status.

◆ ASSET_PACKAGE_STATUS_UPGRADING

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_STATUS_UPGRADING = 3

static

Upgrading status.

◆ ASSET_PACKAGE_TYPE_ANIMATEDSTICKER

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_ANIMATEDSTICKER = 3

static

Animated sticker type.

◆ ASSET_PACKAGE_TYPE_ANIMATEDSTICKER_ANIMATION

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_ANIMATEDSTICKER_ANIMATION = 16

static

Sticker period animation type.

◆ ASSET_PACKAGE_TYPE_ANIMATEDSTICKER_IN_ANIMATION

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_ANIMATEDSTICKER_IN_ANIMATION = 17

static

Sticker in animation type.

◆ ASSET_PACKAGE_TYPE_ANIMATEDSTICKER_OUT_ANIMATION

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_ANIMATEDSTICKER_OUT_ANIMATION = 18

static

Sticker out animation type.

◆ ASSET_PACKAGE_TYPE_ARSCENE

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_ARSCENE = 6

static

AR scene type.

◆ ASSET_PACKAGE_TYPE_AVATAR_MATERIAL

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_AVATAR_MATERIAL = 15

static

Custom avatar material type.

◆ ASSET_PACKAGE_TYPE_AVATAR_MODEL

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_AVATAR_MODEL = 14

static

Custom avatar model type.

◆ ASSET_PACKAGE_TYPE_CAPTION_ANIMATION

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_CAPTION_ANIMATION = 10

static

Modular caption animation type.

◆ ASSET_PACKAGE_TYPE_CAPTION_CONTEXT

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_CAPTION_CONTEXT = 8

static

Modular caption context type.

◆ ASSET_PACKAGE_TYPE_CAPTION_IN_ANIMATION

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_CAPTION_IN_ANIMATION = 11

static

Modular caption in-animation type.

◆ ASSET_PACKAGE_TYPE_CAPTION_OUT_ANIMATION

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_CAPTION_OUT_ANIMATION = 12

static

Modular caption out-animation type.

◆ ASSET_PACKAGE_TYPE_CAPTION_RENDERER

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_CAPTION_RENDERER = 9

static

Modular caption renderer type.

◆ ASSET_PACKAGE_TYPE_CAPTIONSTYLE

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_CAPTIONSTYLE = 2

static

Caption style type.

◆ ASSET_PACKAGE_TYPE_CAPTURESCENE

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_CAPTURESCENE = 5

static

Capture scene type.

◆ ASSET_PACKAGE_TYPE_COMPOUND_CAPTION

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_COMPOUND_CAPTION = 7

static

Compound caption type.

◆ ASSET_PACKAGE_TYPE_FACE_MESH

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_FACE_MESH = 20

static

Face mesh type.

◆ ASSET_PACKAGE_TYPE_MAKEUP

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_MAKEUP = 19

static

Makeup type.

◆ ASSET_PACKAGE_TYPE_PROJECT

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_PROJECT = 22

static

Project type

◆ ASSET_PACKAGE_TYPE_TEMPLATE

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_TEMPLATE = 13

static

Template type.

◆ ASSET_PACKAGE_TYPE_THEME

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_THEME = 4

static

Theme type.

◆ ASSET_PACKAGE_TYPE_VIDEOFX

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_VIDEOFX = 0

static

Video effect type.

◆ ASSET_PACKAGE_TYPE_VIDEOTRANSITION

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_VIDEOTRANSITION = 1

static

Video transition type.

◆ ASSET_PACKAGE_TYPE_WARP

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_TYPE_WARP = 21

static

Warp type.

◆ TEIMPLATE_FOOTAGE_TYPE_AUDIO

final int com.meicam.sdk.NvsAssetPackageManager.TEIMPLATE_FOOTAGE_TYPE_AUDIO = 3

static

◆ TEIMPLATE_FOOTAGE_TYPE_FREEZE_FRAME

final int com.meicam.sdk.NvsAssetPackageManager.TEIMPLATE_FOOTAGE_TYPE_FREEZE_FRAME = 4

static

◆ TEIMPLATE_FOOTAGE_TYPE_IMAGE

final int com.meicam.sdk.NvsAssetPackageManager.TEIMPLATE_FOOTAGE_TYPE_IMAGE = 2

static

◆ TEIMPLATE_FOOTAGE_TYPE_VIDEO

final int com.meicam.sdk.NvsAssetPackageManager.TEIMPLATE_FOOTAGE_TYPE_VIDEO = 1

static

◆ TEIMPLATE_FOOTAGE_TYPE_VIDEO_IMAGE

final int com.meicam.sdk.NvsAssetPackageManager.TEIMPLATE_FOOTAGE_TYPE_VIDEO_IMAGE = 0

static

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

src/android/jar/com/meicam/sdk/NvsAssetPackageManager.java

Classes

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NvsAssetPackageManager()

Member Function Documentation

◆ changeTemplateAspectRatio()

◆ getARSceneAssetPackageBeautyPreset()

◆ getARSceneAssetPackageCameraPreset()

◆ getARSceneAssetPackagePrompt()

◆ getARSceneAssetPackageShapeBeautificationPreset()

◆ getAssetPackageContentType()

◆ getAssetPackageIdFromAssetPackageFilePath()

◆ getAssetPackageListOfType()

◆ getAssetPackageStatus()

◆ getAssetPackageSupportedAspectRatio()

◆ getAssetPackageVersion()

◆ getAssetPackageVersionFromAssetPackageFilePath()

◆ getExpValueList()

◆ getTemplateCaptions()

◆ getTemplateCompoundCaptions()

◆ getTemplateCurrentAspectRatio()

◆ getTemplateDefaultAspectRatio()

◆ getTemplateFootages()

◆ getTranslationMap()

◆ getVideoFxAssetPackageDescription()

◆ hasAudioInAssetPackage()

◆ hasDetectionInAssetPackage()

◆ installAssetPackage()

◆ isARSceneAssetPackageContainFaceMesh()

◆ isARSceneAssetPackageContainMakeup()

◆ isARSceneAssetPackageContainWarp()

◆ isCustomAnimatedSticker()

◆ isParticleFX()

◆ isThemeContainMusic()

◆ setCallbackInterface()

◆ setGenerateTemplateCallbackInterface()

◆ uninstallAssetPackage()

◆ upgradeAssetPackage()

Member Data Documentation

◆ ASSET_PACKAGE_ASPECT_RATIO_16v9

◆ ASSET_PACKAGE_ASPECT_RATIO_18v9

◆ ASSET_PACKAGE_ASPECT_RATIO_1v1

◆ ASSET_PACKAGE_ASPECT_RATIO_3v4

◆ ASSET_PACKAGE_ASPECT_RATIO_4v3

◆ ASSET_PACKAGE_ASPECT_RATIO_9v16

◆ ASSET_PACKAGE_ASPECT_RATIO_9v18

◆ ASSET_PACKAGE_MANAGER_ERROR_ALREADY_INSTALLED

◆ ASSET_PACKAGE_MANAGER_ERROR_ASSET_TYPE

◆ ASSET_PACKAGE_MANAGER_ERROR_DECOMPRESSION

◆ ASSET_PACKAGE_MANAGER_ERROR_IMPROPER_STATUS

◆ ASSET_PACKAGE_MANAGER_ERROR_INVALID_PACKAGE

◆ ASSET_PACKAGE_MANAGER_ERROR_IO

◆ ASSET_PACKAGE_MANAGER_ERROR_META_CONTENT

◆ ASSET_PACKAGE_MANAGER_ERROR_NAME

◆ ASSET_PACKAGE_MANAGER_ERROR_NO_ERROR

◆ ASSET_PACKAGE_MANAGER_ERROR_NOT_INSTALLED

◆ ASSET_PACKAGE_MANAGER_ERROR_PERMISSION

◆ ASSET_PACKAGE_MANAGER_ERROR_RESOURCE

◆ ASSET_PACKAGE_MANAGER_ERROR_SDK_VERSION

◆ ASSET_PACKAGE_MANAGER_ERROR_UPGRADE_VERSION

◆ ASSET_PACKAGE_MANAGER_ERROR_WORKING_INPROGRESS

◆ ASSET_PACKAGE_STATUS_INSTALLING

◆ ASSET_PACKAGE_STATUS_NOTINSTALLED

◆ ASSET_PACKAGE_STATUS_READY

◆ ASSET_PACKAGE_STATUS_UPGRADING

◆ ASSET_PACKAGE_TYPE_ANIMATEDSTICKER

◆ ASSET_PACKAGE_TYPE_ANIMATEDSTICKER_ANIMATION

◆ ASSET_PACKAGE_TYPE_ANIMATEDSTICKER_IN_ANIMATION

◆ ASSET_PACKAGE_TYPE_ANIMATEDSTICKER_OUT_ANIMATION

◆ ASSET_PACKAGE_TYPE_ARSCENE

◆ ASSET_PACKAGE_TYPE_AVATAR_MATERIAL

◆ ASSET_PACKAGE_TYPE_AVATAR_MODEL

◆ ASSET_PACKAGE_TYPE_CAPTION_ANIMATION

◆ ASSET_PACKAGE_TYPE_CAPTION_CONTEXT

◆ ASSET_PACKAGE_TYPE_CAPTION_IN_ANIMATION

◆ ASSET_PACKAGE_TYPE_CAPTION_OUT_ANIMATION

◆ ASSET_PACKAGE_TYPE_CAPTION_RENDERER

◆ ASSET_PACKAGE_TYPE_CAPTIONSTYLE