美摄SDK For Android  1.0.0
| Public 成员函数 | 所有成员列表
com.meicam.sdk.NvsAssetPackageManager类 参考

资源包管理器,管理视频场景中的资源包 更多...

interface  AssetPackageManagerCallback
 资源包管理回调接口 更多...
 

Public 成员函数

 NvsAssetPackageManager (boolean isEffectSdk)
 
void setInternalObject (long internalObject)
 
void setCallbackInterface (AssetPackageManagerCallback callback)
 设置包管理器回调接口 更多...
 
String getAssetPackageIdFromAssetPackageFilePath (String assetPackageFilePath)
 从资源包的文件路径获得资源包的ID 更多...
 
int getAssetPackageVersionFromAssetPackageFilePath (String assetPackageFilePath)
 从资源包的文件路径获得资源包的版本 更多...
 
int installAssetPackage (String assetPackageFilePath, String licenseFilePath, int type, boolean synchronous, StringBuilder assetPackageId)
 安装资源包 更多...
 
int upgradeAssetPackage (String assetPackageFilePath, String licenseFilePath, int type, boolean synchronous, StringBuilder assetPackageId)
 升级资源包 更多...
 
int uninstallAssetPackage (String assetPackageId, int type)
 卸载资源包 更多...
 
int getAssetPackageStatus (String assetPackageId, int type)
 获取资源包的当前状态 更多...
 
int getAssetPackageVersion (String assetPackageId, int type)
 获取资源包的版本 更多...
 
int getAssetPackageSupportedAspectRatio (String assetPackageId, int type)
 获取资源包的所支持的横纵比 更多...
 
List< String > getAssetPackageListOfType (int type)
 获取某个类型的资源包列表 更多...
 
boolean isCustomAnimatedSticker (String uuidString)
 判断是否为自定义贴纸 更多...
 
boolean isParticleFX (String uuidString)
 判断是否为粒子特效 更多...
 
boolean isThemeContainMusic (String uuidString)
 检查主题包是否含有音乐 更多...
 
String getVideoFxAssetPackageDescription (String uuidString)
 获取VideoFx类型的资源描述信息 更多...
 

静态 Public 属性

资源包类型

static final int ASSET_PACKAGE_TYPE_VIDEOFX = 0
 视频特效类型 更多...
 
static final int ASSET_PACKAGE_TYPE_VIDEOTRANSITION = 1
 视频转场类型 更多...
 
static final int ASSET_PACKAGE_TYPE_CAPTIONSTYLE = 2
 字幕样式类型 更多...
 
static final int ASSET_PACKAGE_TYPE_ANIMATEDSTICKER = 3
 动画贴纸类型 更多...
 
static final int ASSET_PACKAGE_TYPE_THEME = 4
 主题类型 更多...
 
static final int ASSET_PACKAGE_TYPE_CAPTURESCENE = 5
 采集场景类型 更多...
 
static final int ASSET_PACKAGE_TYPE_ARSCENE = 6
 AR场景类型 更多...
 
资源包状态

static final int ASSET_PACKAGE_STATUS_NOTINSTALLED = 0
 未安装状态 更多...
 
static final int ASSET_PACKAGE_STATUS_INSTALLING = 1
 正在安装状态 更多...
 
static final int ASSET_PACKAGE_STATUS_READY = 2
 准备状态 更多...
 
static final int ASSET_PACKAGE_STATUS_UPGRADING = 3
 正在升级状态 更多...
 
资源包管理错误类型

static final int ASSET_PACKAGE_MANAGER_ERROR_NO_ERROR = 0
 安装成功 更多...
 
static final int ASSET_PACKAGE_MANAGER_ERROR_NAME = 1
 名称错误 更多...
 
static final int ASSET_PACKAGE_MANAGER_ERROR_ALREADY_INSTALLED = 2
 已经安装 更多...
 
static final int ASSET_PACKAGE_MANAGER_ERROR_WORKING_INPROGRESS = 3
 安装或升级正在进行中 更多...
 
static final int ASSET_PACKAGE_MANAGER_ERROR_NOT_INSTALLED = 4
 尚未安装 更多...
 
static final int ASSET_PACKAGE_MANAGER_ERROR_IMPROPER_STATUS = 5
 不正确状态 更多...
 
static final int ASSET_PACKAGE_MANAGER_ERROR_DECOMPRESSION = 6
 解压错误 更多...
 
static final int ASSET_PACKAGE_MANAGER_ERROR_INVALID_PACKAGE = 7
 无效包 更多...
 
static final int ASSET_PACKAGE_MANAGER_ERROR_ASSET_TYPE = 8
 资源类型错误 更多...
 
static final int ASSET_PACKAGE_MANAGER_ERROR_PERMISSION = 9
 许可错误 更多...
 
static final int ASSET_PACKAGE_MANAGER_ERROR_META_CONTENT = 10
 元内容错误 更多...
 
static final int ASSET_PACKAGE_MANAGER_ERROR_SDK_VERSION = 11
 SDK版本错误 更多...
 
static final int ASSET_PACKAGE_MANAGER_ERROR_UPGRADE_VERSION = 12
 升级版本错误 更多...
 
static final int ASSET_PACKAGE_MANAGER_ERROR_IO = 13
 输入输出错误 更多...
 
static final int ASSET_PACKAGE_MANAGER_ERROR_RESOURCE = 14
 资源错误 更多...
 
资源包支持的横纵比

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
 

详细描述

资源包管理器,管理视频场景中的资源包

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

警告
NvsAssetPackageManager类中,所有public API都在UI线程使用!!!

构造及析构函数说明

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

成员函数说明

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

从资源包的文件路径获得资源包的ID

参数
assetPackageFilePath资源包的文件路径
返回
返回表示资源包ID的字符串
List<String> com.meicam.sdk.NvsAssetPackageManager.getAssetPackageListOfType ( int  type)
inline

获取某个类型的资源包列表

参数
type资源包类型。注:待输入参数是以ASSET_PACKAGE_TYPE打头的静态int属性值。请参见资源包类型
返回
返回表示某个类型下资源包的的列表。列表里的每个元素都是一个资源包ID
int com.meicam.sdk.NvsAssetPackageManager.getAssetPackageStatus ( String  assetPackageId,
int  type 
)
inline

获取资源包的当前状态

参数
assetPackageId待查询状态资源包的ID
type待查询状态资源包的类型。注:待输入参数是以ASSET_PACKAGE_TYPE打头的静态int属性值。请参见资源包类型
返回
返回资源包的当前状态值。

注意:返回值是ASSET_PACKAGE_STATUS打头的静态int属性值。返回值是0,即返回ASSET_PACKAGE_STATUS_NOTINSTALLED,表示尚未安装。请参见资源包状态

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

获取资源包的所支持的横纵比

参数
assetPackageId资源包ID
type资源包类型。注:待输入参数是以ASSET_PACKAGE_TYPE打头的静态int属性值。请参见资源包类型
返回
返回资源包的所支持的横纵比,这个值是若干横纵比的按位或的结果,请参见资源包支持的横纵比
int com.meicam.sdk.NvsAssetPackageManager.getAssetPackageVersion ( String  assetPackageId,
int  type 
)
inline

获取资源包的版本

参数
assetPackageId资源包ID
type资源包类型。注:待输入参数是以ASSET_PACKAGE_TYPE打头的静态int属性值。请参见资源包类型
返回
返回获得的资源包版本
int com.meicam.sdk.NvsAssetPackageManager.getAssetPackageVersionFromAssetPackageFilePath ( String  assetPackageFilePath)
inline

从资源包的文件路径获得资源包的版本

参数
assetPackageFilePath资源包的文件路径
返回
返回表示资源包版本,如果资源包不包含版本号则返回1
String com.meicam.sdk.NvsAssetPackageManager.getVideoFxAssetPackageDescription ( String  uuidString)
inline

获取VideoFx类型的资源描述信息

参数
uuidString特效uuid
返回
返回String对象,资源描述信息
自从
1.14.0
int com.meicam.sdk.NvsAssetPackageManager.installAssetPackage ( String  assetPackageFilePath,
String  licenseFilePath,
int  type,
boolean  synchronous,
StringBuilder  assetPackageId 
)
inline

安装资源包

参数
assetPackageFilePath待安装资源包的文件路径
licenseFilePath待安装资源包的授权文件路径
type待安装资源包的类型。注:待输入参数是以ASSET_PACKAGE_TYPE打头的静态int属性值。请参见资源包类型
synchronous是否同步安装。值为true则安装过程会阻塞当前线程直到安装成功或者失败,false则安装过程的结果通过delegate异步通知(但也在当前线程通知)。
assetPackageId输出参数,返回该资源包ID
返回
返回表示资源包错误类型的整形值。

注意:返回值是ASSET_PACKAGE_MANAGER_ERROR打头的静态int属性值。若返回ASSET_PACKAGE_MANAGER_ERROR_NO_ERROR: 表示安装成功(只有同步安装才可能返回这个),任何其它返回值都表示安装错误。请参见资源包管理错误类型

参见
upgradeAssetPackage uninstallAssetPackage
boolean com.meicam.sdk.NvsAssetPackageManager.isCustomAnimatedSticker ( String  uuidString)
inline

判断是否为自定义贴纸

参数
uuidString贴纸uuid
返回
返回boolean对象,表示是否为自定义贴纸
自从
1.11.0
boolean com.meicam.sdk.NvsAssetPackageManager.isParticleFX ( String  uuidString)
inline

判断是否为粒子特效

参数
uuidString粒子特效uuid
返回
返回boolean对象,表示是否为粒子特效
自从
1.14.0
boolean com.meicam.sdk.NvsAssetPackageManager.isThemeContainMusic ( String  uuidString)
inline

检查主题包是否含有音乐

参数
uuidString主题包uuid
返回
返回boolean值,表示否含有音乐
自从
2.6.0
void com.meicam.sdk.NvsAssetPackageManager.setCallbackInterface ( AssetPackageManagerCallback  callback)
inline

设置包管理器回调接口

参数
callback包管理器回调接口
void com.meicam.sdk.NvsAssetPackageManager.setInternalObject ( long  internalObject)
inline
int com.meicam.sdk.NvsAssetPackageManager.uninstallAssetPackage ( String  assetPackageId,
int  type 
)
inline

卸载资源包

参数
assetPackageId待卸载资源包的ID
type待卸载资源包的类型。注:待输入参数是以ASSET_PACKAGE_TYPE打头的静态int属性值。请参见资源包类型
返回
返回表示资源包错误类型的整形值。

注意:返回值是ASSET_PACKAGE_MANAGER_ERROR打头的静态int属性值。若返回ASSET_PACKAGE_MANAGER_ERROR_NO_ERROR: 表示卸载成功,其它则卸载失败。请参见资源包管理错误类型

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

升级资源包

参数
assetPackageFilePath待升级资源包的文件路径
licenseFilePath待升级资源包的授权文件路径
type待升级资源包的类型。注:待输入参数是以ASSET_PACKAGE_TYPE打头的静态int属性值。请参见资源包类型
synchronous是否同步升级。值为true则升级过程会阻塞当前线程直到升级成功或者失败,false则升级过程的结果通过delegate异步通知(但也在当前线程通知)。
assetPackageId输出参数,返回该资源包ID
返回
返回表示资源包错误类型的整形值。

注意:返回值是ASSET_PACKAGE_MANAGER_ERROR打头的静态int属性值。若返回ASSET_PACKAGE_MANAGER_ERROR_NO_ERROR: 表示升级成功(只有同步升级才可能返回这个),任何其它返回值都表示升级错误。请参见资源包管理错误类型

参见
installAssetPackage uninstallAssetPackage

类成员变量说明

final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_ASPECT_RATIO_16v9 = 1
static
final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_ASPECT_RATIO_18v9 = 32
static
final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_ASPECT_RATIO_1v1 = 2
static
final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_ASPECT_RATIO_3v4 = 16
static
final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_ASPECT_RATIO_4v3 = 8
static
final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_ASPECT_RATIO_9v16 = 4
static
final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_ASPECT_RATIO_9v18 = 64
static
final int com.meicam.sdk.NvsAssetPackageManager.ASSET_PACKAGE_MANAGER_ERROR_ALREADY_INSTALLED = 2
static

已经安装

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

资源类型错误

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

解压错误

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

不正确状态

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

无效包

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

输入输出错误

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

元内容错误

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

名称错误

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

安装成功

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

尚未安装

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

许可错误

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

资源错误

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

SDK版本错误

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

升级版本错误

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

安装或升级正在进行中

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

正在安装状态

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

未安装状态

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

准备状态

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

正在升级状态

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

动画贴纸类型

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

AR场景类型

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

字幕样式类型

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

采集场景类型

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

主题类型

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

视频特效类型

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

视频转场类型


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