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

#import <NvsAssetPackageManager.h>

类 NvsAssetPackageManager 继承关系图:

构造函数
(NSString *)	- getAssetPackageIdFromAssetPackageFilePath:
	从资源包的文件路径获得资源包ID 更多...

(int)	- getAssetPackageVersionFromAssetPackageFilePath:
	从资源包的文件路径获得资源包版本号更多...

(NvsAssetPackageManagerError)	- installAssetPackage:license:type:sync:assetPackageId:
	安装资源包更多...

(NvsAssetPackageManagerError)	- upgradeAssetPackage:license:type:sync:assetPackageId:
	升级资源包更多...

(NvsAssetPackageManagerError)	- uninstallAssetPackage:type:
	卸载资源包更多...

(NvsAssetPackageStatus)	- getAssetPackageStatus:type:
	获取资源包的当前状态。更多...

(int)	- getAssetPackageVersion:type:
	获取已安装资源包的版本号更多...

(NSString *)	- getAssetPackageMinSdkVersion:type:
	获取已安装资源包需要的SDK最低版本号更多...

(NSString *)	- getAssetPackageContentType:type:
	获取资源包的内容类型。更多...

(NSArray< NvsExpressionParam * > *)	- getExpValueList:type:
	获取资源包的表达式参数的列表。更多...

(NSDictionary< NSString , NSString > *)	- getTranslationMap:type:
	翻译资源包中的字段。更多...

(int)	- getAssetPackageSupportedAspectRatio:type:
	获取资源包的所支持的横纵比更多...

(NSArray *)	- getAssetPackageListOfType:
	获取某个类型的资源包列表更多...

(BOOL)	- isCustomAnimatedSticker:
	判断是否为自定义贴纸更多...

(BOOL)	- isParticleFx:
	判断是否为粒子特效更多...

(BOOL)	- isThemeContainMusic:
	检查主题包是否含有音乐更多...

(NSString *)	- GetVideoFxAssetPackageDescription:
	获取某个类型为VideoFx的资源的特效描述信息更多...

(NSArray< NvsTemplateFootageDesc * > *)	- getTemplateFootages:
	获取Template资源里的footage信息列表更多...

(NSArray< NvsTemplateCaptionDesc * > *)	- getTemplateCaptions:
	获取Template资源里的字幕信息列表更多...

(int)	- getTemplateCurrentAspectRatio:
	获取Template当前使用的画幅比例更多...

(NSArray< NvsTemplateCompoundCaptionDesc * > *)	- getTemplateCampoundCaptions:
	获取Template资源里的复合字幕信息列表更多...

(BOOL)	- changeTemplateAspectRatio:aspectRatio:
	更改模板的画幅比例更多...

(NSString *)	- getARSceneAssetPackagePrompt:
	获取ARScene资源包的提示信息更多...

(BOOL)	- isARSceneAssetPackageContainMakeup:
	是否含有美妆更多...

(BOOL)	- isARSceneAssetPackageContainFaceMesh:
	是否包含新版美型更多...

(BOOL)	- isARSceneAssetPackageContainWarp:
	是否包含旧版美型更多...

(BOOL)	- getARSceneAssetPackage:beautyPreset:
	获取ARScene资源包美颜的预设参数更多...

(BOOL)	- getARSceneAssetPackage:shapeBeautificationPreset:
	获取ARScene资源包美型的预设参数更多...

(BOOL)	- getARSceneAssetPackage:cameraPreset:
	获取ARScene资源包相机的预设参数更多...

(BOOL)	- hasAudioInAssetPackage:type:
	判断是否含有音频在包裹内更多...

属性
id< NvsAssetPackageManagerDelegate >	delegate

id< NvsAssetPackageManagerGenerateTemplateDelegate >	generateTemplateDelegate

详细描述

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

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

警告: NvsAssetPackageManager类中，所有public API都在UI线程使用！！！

函数文档

◆ changeTemplateAspectRatio:aspectRatio:

- (BOOL) changeTemplateAspectRatio:	(NSString *)	uuidString
aspectRatio:	(int)	aspectRatio

更改模板的画幅比例

参数

uuidString 特效uuid

返回: 返回是否成功

自从: 2.18.1

◆ getARSceneAssetPackage:beautyPreset:

- (BOOL) getARSceneAssetPackage:	(NSString *)	uuidString
beautyPreset:	(NvsARSceneBeautyPreset *)	beautyPreset

获取ARScene资源包美颜的预设参数

参数

uuidString	资源包uuid
beautyPreset	一个NvsARSceneBeautyPreset结构的指针，预设数据将会被返回在这个结构里。

返回: 成功时返回YES，失败或者没有预设返回NO。当返回NO时，preset里面的数据时未定义的！

自从: 2.9.0

◆ getARSceneAssetPackage:cameraPreset:

- (BOOL) getARSceneAssetPackage:	(NSString *)	uuidString
cameraPreset:	(NvsARSceneCameraPreset *)	cameraPreset

获取ARScene资源包相机的预设参数

参数

uuidString	资源包uuid
cameraPreset	一个NvsARSceneCameraPreset结构的指针，预设数据将会被返回在这个结构里。

返回: 返回含有预设参数的ARSceneCameraPreset对象，如果没有预设则返回null

自从: 3.7.2

◆ getARSceneAssetPackage:shapeBeautificationPreset:

- (BOOL) getARSceneAssetPackage:	(NSString *)	uuidString
shapeBeautificationPreset:	(NvsARSceneShapeBeautificationPreset *)	shapeBeautificationPreset

获取ARScene资源包美型的预设参数

参数

uuidString	资源包uuid
shapeBeautificationPreset	一个NvsARSceneShapeBeautificationPreset结构的指针，预设数据将会被返回在这个结构里。

返回: 成功时返回YES，失败或者没有预设返回NO。当返回NO时，preset里面的数据时未定义的！

自从: 2.9.0

◆ getARSceneAssetPackagePrompt:

- (NSString *) getARSceneAssetPackagePrompt: (NSString *) uuidString

获取ARScene资源包的提示信息

参数

uuidString 资源包uuid

返回: 返回提示信息的String对象

自从: 2.9.0

◆ getAssetPackageContentType:type:

- (NSString*) getAssetPackageContentType:	(NSString *)	assetPackageId
type:	(NvsAssetPackageType)	type

获取资源包的内容类型。

参数

assetPackageId	资源包的ID。
type	资源类型。

返回: 返回内容类型。如果该资源包未安装，则返回nil。

只有安装过的资源包，才可以通过该方法获取。请在使用前注意检查是否安装。请参见getAssetPackageStatus()

◆ getAssetPackageIdFromAssetPackageFilePath:

- (NSString *) getAssetPackageIdFromAssetPackageFilePath: (NSString *) assetPackageFilePath

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

参数

assetPackageFilePath 资源包的文件路径

返回: 返回表示资源包ID的字符串

警告: 通过路径中字符判断，所以不建议修改已有的文件名！

◆ getAssetPackageListOfType:

- (NSArray *) getAssetPackageListOfType: (NvsAssetPackageType) type

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

参数

type 资源包类型

返回: 返回NSArray数组对象，表示某个类型下资源包的的列表。列表里每个NSString元素都是一个资源包ID。

◆ getAssetPackageMinSdkVersion:type:

- (NSString*) getAssetPackageMinSdkVersion:	(NSString *)	assetPackageId
type:	(NvsAssetPackageType)	type

获取已安装资源包需要的SDK最低版本号

参数

assetPackageId	待查询状态资源包ID
type	待查询状态资源包的类型

返回: 返回SDK版本号。如果该资源包未安装，则返回nil。

只有安装过的资源包，才可以通过该方法获取。请在使用前注意检查是否安装。请参见getAssetPackageStatus()

◆ getAssetPackageStatus:type:

- (NvsAssetPackageStatus) getAssetPackageStatus:	(NSString *)	assetPackageId
type:	(NvsAssetPackageType)	type

获取资源包的当前状态。

参数

assetPackageId	待查询状态资源包ID
type	待查询状态资源包的类型

返回: 返回资源包的当前状态值.

◆ getAssetPackageSupportedAspectRatio:type:

- (int) getAssetPackageSupportedAspectRatio:	(NSString *)	assetPackageId
type:	(NvsAssetPackageType)	type

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

参数

assetPackageId	待查询状态资源包ID
type	待查询状态资源包的类型

返回: 返回资源包的所支持的横纵比，这个值是若干横纵比(NvsAssetPackageAspectRatio_XXX)的按位或的结果。

◆ getAssetPackageVersion:type:

- (int) getAssetPackageVersion:	(NSString *)	assetPackageId
type:	(NvsAssetPackageType)	type

获取已安装资源包的版本号

参数

assetPackageId	待查询状态资源包ID
type	待查询状态资源包的类型

返回: 返回资源包的版本号。如果该资源包未安装，则返回1。

只有安装过的资源包，才可以通过该方法获取。请在使用前注意检查是否安装。请参见getAssetPackageStatus()

◆ getAssetPackageVersionFromAssetPackageFilePath:

- (int) getAssetPackageVersionFromAssetPackageFilePath: (NSString *) assetPackageFilePath

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

参数

assetPackageFilePath 资源包的文件路径

返回: 返回表示资源包版本号。如果该资源包不包含版本号则返回1.

警告: 通过路径中字符判断，所以不建议修改已有的文件名！

◆ getExpValueList:type:

- (NSArray <NvsExpressionParam >) getExpValueList:	(NSString *)	assetPackageId
type:	(NvsAssetPackageType)	type

获取资源包的表达式参数的列表。

参数

assetPackageId	资源包的ID。
type	资源类型。

返回: 返回资源包的表达式参数的列表。如果该资源包未安装，则返回nil。

只有安装过的资源包，才可以通过该方法获取。请在使用前注意检查是否安装。请参见getAssetPackageStatus()

◆ getTemplateCampoundCaptions:

- (NSArray <NvsTemplateCompoundCaptionDesc *>*) getTemplateCampoundCaptions: (NSString *) uuidString

获取Template资源里的复合字幕信息列表

参数

uuidString 特效uuid

返回: 返回ArrayList，复合字幕信息列表

自从: 2.18.1

◆ getTemplateCaptions:

- (NSArray <NvsTemplateCaptionDesc *>*) getTemplateCaptions: (NSString *) uuidString

获取Template资源里的字幕信息列表

参数

uuidString 特效uuid

返回: 返回ArrayList，字幕信息列表

自从: 2.18.1

◆ getTemplateCurrentAspectRatio:

- (int) getTemplateCurrentAspectRatio: (NSString *) uuidString

获取Template当前使用的画幅比例

参数

uuidString 特效uuid

返回: 返回画幅比例(NvsAssetPackageAspectRatio)

自从: 2.18.1

◆ getTemplateFootages:

- (NSArray <NvsTemplateFootageDesc *>*) getTemplateFootages: (NSString *) uuidString

获取Template资源里的footage信息列表

参数

uuidString 特效uuid

返回: 返回ArrayList，footage信息列表

自从: 2.18.1

◆ getTranslationMap:type:

- (NSDictionary<NSString, NSString>*) getTranslationMap:	(NSString *)	assetPackageId
type:	(NvsAssetPackageType)	type

翻译资源包中的字段。

参数

assetPackageId	资源包的ID。
type	资源类型。

返回: 返回翻译后的字符串。。如果该资源包未安装，则返回nil。

只有安装过的资源包，才可以通过该方法翻译。请在使用前注意检查是否安装。请参见getAssetPackageStatus()

◆ GetVideoFxAssetPackageDescription:

- (NSString *) GetVideoFxAssetPackageDescription: (NSString *) uuidString

获取某个类型为VideoFx的资源的特效描述信息

参数

uuidString 特效资源uuid

返回: 返回String对象，特效资源的特效描述信息

自从: 1.14.0

◆ hasAudioInAssetPackage:type:

- (BOOL) hasAudioInAssetPackage:	(NSString *)	uuidString
type:	(NvsAssetPackageType)	assetPackageType

判断是否含有音频在包裹内

参数

uuidString	贴纸uuid
assetPackageType	Asset package type

返回: 返回BOOL值，表示是否含有音频

自从: 3.8.0

◆ installAssetPackage:license:type:sync:assetPackageId:

- (NvsAssetPackageManagerError) installAssetPackage:	(NSString *)	assetPackageFilePath
license:	(NSString *)	licenseFilePath
type:	(NvsAssetPackageType)	type
sync:	(BOOL)	synchronous
assetPackageId:	(NSMutableString *)	assetPackageId

安装资源包

参数

assetPackageFilePath	待安装资源包的文件路径
licenseFilePath	待安装资源包的授权文件路径
type	待安装资源包的类型
synchronous	是否同步安装。值为YES则安装过程会阻塞当前线程直到安装成功或者失败，NO则安装过程的结果通过delegate异步通知（但也在当前线程通知）。
注意：如果type是模板类型，那么只能使用异步安装。
assetPackageId	返回值，返回该资源包ID。

返回: 返回错误类型值。NvsAssetPackageManagerError_NoError: 表示安装成功（只有同步安装才可能返回这个)，任何其它返回值都表示安装错误。

参见: - upgradeAssetPackage:license:type:sync:assetPackageId:; - uninstallAssetPackage:type:

◆ isARSceneAssetPackageContainFaceMesh:

- (BOOL) isARSceneAssetPackageContainFaceMesh: (NSString *) uuidString

是否包含新版美型

参数

uuidString 资源包uuid

返回: 返回是否包含新版美型

自从: 3.4.0

◆ isARSceneAssetPackageContainMakeup:

- (BOOL) isARSceneAssetPackageContainMakeup: (NSString *) uuidString

是否含有美妆

参数

uuidString 资源包uuid

返回: 返回是否含有美妆

自从: 3.1.1

◆ isARSceneAssetPackageContainWarp:

- (BOOL) isARSceneAssetPackageContainWarp: (NSString *) uuidString

是否包含旧版美型

参数

uuidString 资源包uuid

返回: 返回包含旧版美型

自从: 3.4.0

◆ isCustomAnimatedSticker:

- (BOOL) isCustomAnimatedSticker: (NSString *) uuidString

判断是否为自定义贴纸

参数

uuidString 贴纸uuid

返回: 返回BOOL值，表示是否为自定义贴纸

自从: 1.11.0

◆ isParticleFx:

- (BOOL) isParticleFx: (NSString *) uuidString

判断是否为粒子特效

参数

uuidString 特效资源uuid

返回: 返回BOOL值，表示是否为粒子特效。

自从: 1.14.0

◆ isThemeContainMusic:

- (BOOL) isThemeContainMusic: (NSString *) uuidString

检查主题包是否含有音乐

参数

uuidString 主题包uuid

返回: 返回BOOL值，表示否含有音乐

自从: 2.6.0

◆ uninstallAssetPackage:type:

- (NvsAssetPackageManagerError) uninstallAssetPackage:	(NSString *)	assetPackageId
type:	(NvsAssetPackageType)	type

卸载资源包

参数

assetPackageId	待卸载资源包ID
type	待卸载资源包的类型

返回: 返回错误类型。返回NvsAssetPackageManagerError_NoError表示卸载成功，其它则卸载失败

参见: - installAssetPackage:license:type:sync:assetPackageId:; - upgradeAssetPackage:license:type:sync:assetPackageId:

◆ upgradeAssetPackage:license:type:sync:assetPackageId:

- (NvsAssetPackageManagerError) upgradeAssetPackage:	(NSString *)	assetPackageFilePath
license:	(NSString *)	licenseFilePath
type:	(NvsAssetPackageType)	type
sync:	(BOOL)	synchronous
assetPackageId:	(NSMutableString *)	assetPackageId

升级资源包

参数

assetPackageFilePath	待升级资源包的文件路径
licenseFilePath	待升级资源包的授权文件路径
type	待升级资源包的类型
synchronous	是否同步升级。值为YES则升级过程会阻塞当前线程直到升级成功或者失败，NO则升级过程的结果通过delegate异步通知（但也在当前线程通知）。
注意：如果type是模板类型，那么只能使用异步安装。
assetPackageId	返回值，返回该资源包ID

返回: 返回错误类型。值为NvsAssetPackageManagerError_NoError表示升级成功（只有同步升级才可能返回这个)，任何其它返回值都表示升级错误。

参见: - installAssetPackage:license:type:sync:assetPackageId:; - uninstallAssetPackage:type:

属性说明

◆ delegate

- (id<NvsAssetPackageManagerDelegate>) delegate

readwritenonatomicweak

◆ generateTemplateDelegate

- (id<NvsAssetPackageManagerGenerateTemplateDelegate>) generateTemplateDelegate

readwritenonatomicweak

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

include/sdkcore/ios/NvsAssetPackageManager.h

构造函数

属性

详细描述

函数文档

◆ changeTemplateAspectRatio:aspectRatio:

◆ getARSceneAssetPackage:beautyPreset:

◆ getARSceneAssetPackage:cameraPreset:

◆ getARSceneAssetPackage:shapeBeautificationPreset:

◆ getARSceneAssetPackagePrompt:

◆ getAssetPackageContentType:type:

◆ getAssetPackageIdFromAssetPackageFilePath:

◆ getAssetPackageListOfType:

◆ getAssetPackageMinSdkVersion:type:

◆ getAssetPackageStatus:type:

◆ getAssetPackageSupportedAspectRatio:type:

◆ getAssetPackageVersion:type:

◆ getAssetPackageVersionFromAssetPackageFilePath:

◆ getExpValueList:type:

◆ getTemplateCampoundCaptions:

◆ getTemplateCaptions:

◆ getTemplateCurrentAspectRatio:

◆ getTemplateFootages:

◆ getTranslationMap:type:

◆ GetVideoFxAssetPackageDescription:

◆ hasAudioInAssetPackage:type:

◆ installAssetPackage:license:type:sync:assetPackageId:

◆ isARSceneAssetPackageContainFaceMesh:

◆ isARSceneAssetPackageContainMakeup:

◆ isARSceneAssetPackageContainWarp:

◆ isCustomAnimatedSticker:

◆ isParticleFx:

◆ isThemeContainMusic:

◆ uninstallAssetPackage:type:

◆ upgradeAssetPackage:license:type:sync:assetPackageId:

属性说明

◆ delegate

◆ generateTemplateDelegate