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

特效上下文 更多...

class  SdkVersion
 美摄SDK的版本信息 更多...
 
class  VerifyLicenseResult
 

Public 成员函数

boolean isSdkAuthorised ()
 检测sdk是否授权 更多...
 
SdkVersion getSdkVersion ()
 获取美摄SDK的版本信息 更多...
 
NvsAssetPackageManager getAssetPackageManager ()
 获取资源包管理器 更多...
 
List< String > getAllBuiltinVideoFxNames ()
 获取全部内嵌视频特效名称 更多...
 
NvsVideoEffect createVideoEffect (String fxIds, NvsRational aspectRatio)
 创建特效对象 更多...
 
NvsEffectRenderCore createEffectRenderCore ()
 创建特效渲染对象 更多...
 

静态 Public 成员函数

static void setDebugLevel (int debugLevel)
 
static void setSaveDebugMessagesToFile (boolean saveDebugMessagesToFile)
 
static Context getContext ()
 
static ClassLoader getClassLoader ()
 
static NvsEffectSdkContext init (Context ctx, String sdkLicenseFilePath, int flags)
 对特效上下文的单例实例进行初始化 更多...
 
static NvsEffectSdkContext init (Activity mainActivity, String sdkLicenseFilePath, int flags)
 对特效上下文的单例实例进行初始化 更多...
 
static NvsEffectSdkContext init (Activity mainActivity, String sdkLicenseFilePath)
 对特效上下文的单例实例进行初始化 更多...
 
static void close ()
 销毁特效上下文实例。注意: 销毁之后可以再次创建及获取 更多...
 
static NvsEffectSdkContext getInstance ()
 获取特效上下文的单例实例(必须进行初始化后才能使用) 更多...
 
static int hasARModule ()
 检测当前SDK是否含有AR模块 更多...
 
static boolean initHumanDetection (Context cxt, String modelFilePath, String licenseFilePath, int features)
 初始化人体检测机制 更多...
 
static void closeHumanDetection ()
 关闭人体检测机制 更多...
 
static boolean setupHumanDetectionData (int dataType, String dataFilePath)
 初始化人体检测相关数据包 更多...
 

静态 Public 属性

人体检测特征

static final int HUMAN_DETECTION_FEATURE_FACE_LANDMARK = 1
 人脸点位 更多...
 
static final int HUMAN_DETECTION_FEATURE_FACE_ACTION = 2
 
人体检测数据包类型

static final int HUMAN_DETECTION_DATA_TYPE_FAKE_FACE = 0
 

详细描述

特效上下文

特效上下文类可视作整个SDK框架的入口。开发过程中,NvsEffectSdkContext提供了静态sharedInstance接口创建流媒体上下文的唯一实例。 通过这个实例对象,我们可以一个或者多个特效的处理。整个使用完成后,要销毁特效上下文的对象实例。 添加素材资源包(采集特效包,场景资源包等),都得先安装,安装成功后获取packageId才能使用,而内建采集特效(builtin)只需获取特效名称即可使用。
sdk接口中凡是需要传入资源、授权等文件路径时一定是全路径。

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

成员函数说明

static void com.meicam.effect.sdk.NvsEffectSdkContext.close ( )
inlinestatic

销毁特效上下文实例。注意: 销毁之后可以再次创建及获取

参见
init
getInstance
static void com.meicam.effect.sdk.NvsEffectSdkContext.closeHumanDetection ( )
inlinestatic

关闭人体检测机制

自从
2.5.0
NvsEffectRenderCore com.meicam.effect.sdk.NvsEffectSdkContext.createEffectRenderCore ( )
inline

创建特效渲染对象

返回
返回创建的特效渲染对象
NvsVideoEffect com.meicam.effect.sdk.NvsEffectSdkContext.createVideoEffect ( String  fxIds,
NvsRational  aspectRatio 
)
inline

创建特效对象

参数
fxIds特效id。对于内嵌视频特效,就是特效的名字,如果是资源包特效,就是资源包id
aspectRatio特效的宽幅比。
返回
返回创建的特效对象
List<String> com.meicam.effect.sdk.NvsEffectSdkContext.getAllBuiltinVideoFxNames ( )
inline

获取全部内嵌视频特效名称

返回
返回包含所有内嵌的视频特效名称的List集合
参见
getAllBuiltinAudioFxNames
NvsAssetPackageManager com.meicam.effect.sdk.NvsEffectSdkContext.getAssetPackageManager ( )
inline

获取资源包管理器

返回
返回获取的资源包管理器对象
static ClassLoader com.meicam.effect.sdk.NvsEffectSdkContext.getClassLoader ( )
inlinestatic
static Context com.meicam.effect.sdk.NvsEffectSdkContext.getContext ( )
inlinestatic
static NvsEffectSdkContext com.meicam.effect.sdk.NvsEffectSdkContext.getInstance ( )
inlinestatic

获取特效上下文的单例实例(必须进行初始化后才能使用)

返回
返回特效上下文的单例实例对象
参见
init
close
SdkVersion com.meicam.effect.sdk.NvsEffectSdkContext.getSdkVersion ( )
inline

获取美摄SDK的版本信息

返回
返回美摄SDK的版本信息对象
自从
2.3.0
static int com.meicam.effect.sdk.NvsEffectSdkContext.hasARModule ( )
inlinestatic

检测当前SDK是否含有AR模块

返回
返回值表示是否含有AR模块
自从
2.5.0
static NvsEffectSdkContext com.meicam.effect.sdk.NvsEffectSdkContext.init ( Context  ctx,
String  sdkLicenseFilePath,
int  flags 
)
inlinestatic

对特效上下文的单例实例进行初始化

参数
ctx安卓Context对象
sdkLicenseFilePath指定SDK license文件的路径
flags标志字段,如果无特殊需求请填写0。
返回
返回特效上下文的单例实例对象
自从
2.3.0
参见
getInstance
close
static NvsEffectSdkContext com.meicam.effect.sdk.NvsEffectSdkContext.init ( Activity  mainActivity,
String  sdkLicenseFilePath,
int  flags 
)
inlinestatic

对特效上下文的单例实例进行初始化

参数
mainActivity主安卓Activity对象
sdkLicenseFilePath指定SDK license文件的路径
flags标志字段,如果无特殊需求请填写0
返回
返回特效上下文的单例实例对象
自从
2.3.0
参见
getInstance
close
static NvsEffectSdkContext com.meicam.effect.sdk.NvsEffectSdkContext.init ( Activity  mainActivity,
String  sdkLicenseFilePath 
)
inlinestatic

对特效上下文的单例实例进行初始化

参数
mainActivity主安卓Activity对象
sdkLicenseFilePath指定SDK license文件的路径
返回
返回特效上下文的单例实例对象
参见
getInstance
close
static boolean com.meicam.effect.sdk.NvsEffectSdkContext.initHumanDetection ( Context  cxt,
String  modelFilePath,
String  licenseFilePath,
int  features 
)
inlinestatic

初始化人体检测机制

参数
cxt安卓Context对象
modelFilePath人脸模型文件路径
licenseFilePath授权文件路径
features人体检测特征标志字段。请参见流媒体上下文标志
返回
返回值表示是否成功
自从
2.5.0
boolean com.meicam.effect.sdk.NvsEffectSdkContext.isSdkAuthorised ( )
inline

检测sdk是否授权

static void com.meicam.effect.sdk.NvsEffectSdkContext.setDebugLevel ( int  debugLevel)
inlinestatic
static void com.meicam.effect.sdk.NvsEffectSdkContext.setSaveDebugMessagesToFile ( boolean  saveDebugMessagesToFile)
inlinestatic
static boolean com.meicam.effect.sdk.NvsEffectSdkContext.setupHumanDetectionData ( int  dataType,
String  dataFilePath 
)
inlinestatic

初始化人体检测相关数据包

参数
dataType人体检测数据包类型。请参见人体检测数据包类型
dataFilePath数据文件路径
返回
返回值表示是否成功
自从
2.6.0

类成员变量说明

final int com.meicam.effect.sdk.NvsEffectSdkContext.HUMAN_DETECTION_DATA_TYPE_FAKE_FACE = 0
static

假脸数据包类型

final int com.meicam.effect.sdk.NvsEffectSdkContext.HUMAN_DETECTION_FEATURE_FACE_ACTION = 2
static

人脸表情

final int com.meicam.effect.sdk.NvsEffectSdkContext.HUMAN_DETECTION_FEATURE_FACE_LANDMARK = 1
static

人脸点位


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