Class Info |
|---|
public abstract class ARConfigBase 所有ARXXXTrackingConfig的基类,包含各类设置项的枚举和公有设置项的接口。 |
Qualifier and Type | Field and Description |
|---|---|
public static final int | 启用深度能力,默认启用。 |
public static final int | ARConfigBase.ENABLE_FLASH_MODE_TORCH 启用手电筒(目前暂不支持)。 |
public static final int | ARConfigBase.ENABLE_HEALTH_DEVICE 启用健康检测。 |
public static final int | 启用遮罩能力。 |
public static final int | 启用环境Mesh能力。 |
public static final int | 不启用特殊能力。 |
public static final int | ARConfigBase.ENABLE_CLOUD_AUGMENTED_IMAGE 启用2D云图像识别。AR Engine Server 3.14及以后版本可用。 |
public static final int | ARConfigBase. ENABLE_CLOUD_OBJECT_RECOGNITION 启用3D云物体识别。 |
public static final int | 启用所有光照估计能力。AR Engine Server 3.15及以后版本可用。 |
public static final int | ARConfigBase.LIGHT_MODE_AMBIENT_INTENSITY 启用光强估计能力。AR Engine Server 3.15及以后版本可用。 |
public static final int | ARConfigBase.LIGHT_MODE_ENVIRONMENT_LIGHTING 启用环境光估计能力。AR Engine Server 3.15及以后版本可用。 |
public static final int | ARConfigBase.LIGHT_MODE_ENVIRONMENT_TEXTURE 启用光照环境纹理估计能力。AR Engine Server 3.15及以后版本可用。 |
public static final int | 不启用光照估计能力。AR Engine Server 3.15及以后版本可用。 |
public static final int | 启用3D物体对象。 |
public static final int | 启用目标语义识别模式。 注意: 该常量已废弃,使用ARConfigBase.SEMANTIC_TARGET。 |
public static final int | 禁用语义识别。 |
public static final int | 启用平面语义识别模式。 |
public static final int | 启用目标语义识别模式。该常量在AR Engine Server 3.13及以后版本可用。 |
Qualifier and Type | Method Name and Description |
|---|---|
long | 获取当前配置启用项。 |
void | setEnableItem(long enableItem) 设置当前配置的启用项。 |
| 获取当前对焦模式。 | |
| 获取当前配置的相机打开方式。 | |
List<Surface> | 获取外部输入流的Surface。应用使用外部打开相机的功能时,从AR Engine获取Surface对象,以便向引擎内存传入PREVIEW、VGA、METADATA、DEPTH等数据流。使用getImageInputSurfaces()前,应先通过ARSession.setCameraTextureName()设置纹理id。 |
List<SurfaceType> | 获取Surface类型。与getImageInputSurfaces()的返回值对应。 |
| 获取当前的光照估计模式。 注意: 该方法已废弃,请使用getLightingMode()。 | |
int | 获取当前的光照估计模式。 |
long | 获取地图数据使用的最大内存大小。在AR Engine Service 4.0.1.100及以上版本生效。 |
| 获取当前配置的功耗模式。 | |
| 获取当前ARSession更新模型。 | |
int | 获取已设置成功的语义识别模式,该方法在setSemanticMode后调用有效。 |
void | setFocusMode(FocusMode focusMode) 设置对焦模式,默认config,请根据实际情况选择对应场景,例如ARBodyTrackingConfig、ARWorldTrackingConfig等,可以按实际需要修改默认对焦模式。 |
void | setImageInputMode(ImageInputMode mode) 设置相机的打开方式,外部打开或内部打开,其中外部打开只能在ARFace里面使用,推荐使用内部打开相机的方式。 |
void | setLightingMode(LightingMode lightingMode) 设置光照估计模式。 注意: 该方法已废弃,请使用setLightingMode()。 |
void | setLightingMode(int lightingMode) 设置光照估计模式。AR Engine Server 3.15及以后版本可用。请注意,当启用多人脸检测特性时,将不支持光照估计。在使用光照估计之前,请禁用多人脸检测特性。 |
void | setMaxMapSize(long maxMapSize) 设置地图数据使用的最大内存大小。在AR Engine Service 4.0.1.100及以上版本生效。 |
void | setPowerMode(PowerMode powerMode) 设置功耗模式。 |
void | setPreviewSize(int width,int height) 设置输入预览流分辨率,默认分辨率为(1440x1080),此外还支持宽高比为4:3的物理相机预览分辨率。 说明: 获取预览列表的方法:
代码示例: Size[] supportedPreviewSizes = characteristics.get(CameraCharacteristics.SCALER_STREAM_CONFIGURATION_MAP).getOutputSizes(SurfaceTexture.class); |
void | setSemanticMode(int mode) 设置语义识别模式,设置之前请先用getSupportedSemanticMode()获取当前支持的语义识别模式。
|
void | setUpdateMode(UpdateMode updateMode) 设置当前ARSession更新模型。 |
Field |
|---|
public static final int ENABLE_FLASH_MODE_TORCH 启用手电筒。 另请参见:Constant-values 说明: 该模式目前暂不支持。 |
Field |
|---|
public static final int ENABLE_HEALTH_DEVICE 启用健康检测。 另请参见:Constant-values |
Field |
|---|
public static final int ENABLE_CLOUD_AUGMENTED_IMAGE 启用2D云图像识别。 另请参见:Constant-values |
Field |
|---|
public static final int ENABLE_CLOUD_OBJECT_RECOGNITION 启用3D云识别能力。该常量AR Engine Server 3.11及以后可用。 另请参见:Constant-values |
Field |
|---|
public static final int LIGHT_MODE_AMBIENT_INTENSITY 启用光强估计能力。 另请参见:Constant-values |
Field |
|---|
public static final int LIGHT_MODE_ENVIRONMENT_LIGHTING 启用环境光估计能力。 另请参见:Constant-values |
Field |
|---|
public static final int LIGHT_MODE_ENVIRONMENT_TEXTURE 启用光照环境纹理估计能力。 另请参见:Constant-values |
Field |
|---|
public static final int OFFSET_10 启用3D物体对象。该常量AR Engine Server 3.11及以后可用。 另请参见:Constant-values |
该常量已废弃,使用ARConfigBase.SEMANTIC_TARGET。
Field |
|---|
public static final int SEMANTIC_BOX 启用目标语义识别模式。 另请参见:Constant-values |
Method |
|---|
public long getEnableItem() 获取当前配置启用项。 |
Returns
Type | Description |
|---|---|
long | 配置启用项,返回值与ENABLE_NULL、ENABLE_FLASH_MODE_TORCH、ENABLE_DEPTH、ENABLE_MASK、ENABLE_MESH等进行与操作可以确定能力启用情况,具体请参见启用项定义。 |
Method |
|---|
public void setEnableItem(long enableItem) 设置当前配置的启用项。 说明: 如果您想要了解调用config.setEnableItem配置的参数是否成功,您需要先将配置信息传入ARSession.configure(),然后调用getEnableItem(),将返回值与设置的数据进行与操作以获取配置状态。 |
Parameters
Name | Description |
|---|---|
enableItem | 启用项,可以使用ENABLE_NULL、ENABLE_FLASH_MODE_TORCH、ENABLE_DEPTH、ENABLE_MASK、ENABLE_MESH多个值进行或操作同时设置多个配置项,如:ENABLE_DEPTH | ENABLE_MASK,同时启用DEPTH和MASK,具体请参见启用项定义。 |
Method |
|---|
public ImageInputMode getImageInputMode() 获取当前配置的相机打开方式。 |
Returns
Type | Description |
|---|---|
相机打开方式。 |
Method |
|---|
public List<Surface> getImageInputSurfaces() 获取外部输入流的Surface。应用使用外部打开相机的功能时,从AR Engine获取Surface,以便向引擎内存传入PREVIEW、VGA、METADATA、DEPTH等数据流。使用getImageInputSurfaces()前,应先通过ARSession.setCameraTextureName()设置纹理ID。 |
Returns
Type | Description |
|---|---|
List<Surface> | 外部输入数据流的Surface。 |
Method |
|---|
public List<SurfaceType> getImageInputSurfaceTypes() 获取Surface类型。与getImageInputSurfaces()的返回值一一对应。 |
Returns
Type | Description |
|---|---|
List<SurfaceType> | Surface类型。 |
该方法已废弃,请使用getLightingMode()。
Method |
|---|
public LightingMode getLightingMode() 获取当前的光照估计模式。 |
Returns
Type | Description |
|---|---|
光照估计模式。 |
Method |
|---|
public int getLightingMode() 获取当前的光照估计模式。 |
Returns
Type | Description |
|---|---|
int | 光照估计模式。 |
Method |
|---|
public long getMaxMapSize() 获取地图数据使用的最大内存大小,在AR Engine Service 4.0.1.100及以上版本生效。在执行ARSession.configure()后,可通过此接口获取当前设置的地图数据最大使用内存大小。 |
Returns
Type | Description |
|---|---|
long | 当前配置地图数据使用的最大内存,单位MB。 |
Method |
|---|
public UpdateMode getUpdateMode() 获取当前ARSession更新模型。 |
Returns
Type | Description |
|---|---|
ARSession更新模型。 |
Method |
|---|
public int getSemanticMode() 获取已设置成功的语义识别模式,该方法在setSemanticMode后调用有效。 |
Returns
Type | Description |
|---|---|
int | 语义识别模式,值可以为SEMANTIC_NONE、SEMANTIC_PLANE、SEMANTIC_TARGET,具体参见平面语义识别模式定义。 |
Method |
|---|
public void setFocusMode(FocusMode focusMode) 设置对焦模式,不同的场景需要使用不同的对焦模式,默认config,具体请参见具体场景,比如ARBodyTrackingConfig、ARWorldTrackingConfig等。 |
Parameters
Name | Description |
|---|---|
focusMode |
Method |
|---|
public void setImageInputMode(ImageInputMode mode) 设置相机的打开方式,外部打开或内部打开,其中外部打开只能在ARFace中使用,推荐使用内部打开相机的方式。 |
Parameters
Name | Description |
|---|---|
mode | 相机打开方式。 |
该方法已废弃,请使用setLightingMode()。
Method |
|---|
public void setLightingMode(LightingMode lightingMode) 设置光照估计模式。 |
Parameters
Name | Description |
|---|---|
lightingMode | 光照估计模式。 |
Method |
|---|
public void setLightingMode(int lightingMode) 设置光照估计模式。 |
Parameters
Name | Description |
|---|---|
int | 光照估计模式。 |
Method |
|---|
public void setMaxMapSize(long maxMapSize) 设置地图数据最大使用内存大小。在AR Engine Service 4.0.1.100及以上版本生效。若配置的地图数据最大使用内存范围不合法,则配置最接近用户配置的有效值,默认最大使用内存大小800MB。 |
Parameters
Name | Description |
|---|---|
maxMapSize | 地图数据最大使用内存大小,单位MB,范围:100MB~16G,若设备内存占用超过设备硬件限制,可能出现不可预知错误,需要应用侧自行评估设置的内存大小。 |
Method |
|---|
public void setPowerMode(PowerMode powerMode) 设置功耗模式。 |
Parameters
Name | Description |
|---|---|
powerMode | 功耗模式。 |
Method |
|---|
public void setPreviewSize(int width, int height) 设置输入预览流分辨率,默认分辨率为(1440x1080),此外还支持宽高比为4:3的物理相机预览分辨率。 说明: 获取预览列表的方法:
代码示例: Size[] supportedPreviewSizes = characteristics.get(CameraCharacteristics.SCALER_STREAM_CONFIGURATION_MAP).getOutputSizes(SurfaceTexture.class); |
Parameters
Name | Description |
|---|---|
width | 预览流宽度。 |
height | 预览流高度。 |
Method |
|---|
public void setSemanticMode(int mode) 设置语义识别模式,设置之前请先用getSupportedSemanticMode()获取当前支持的语义识别模式。
|
Parameters
Name | Description |
|---|---|
mode | 语义识别模式,值可以为SEMANTIC_NONE、SEMANTIC_PLANE、SEMANTIC_TARGET,需要同时支持,可以使用(SEMANTIC_PLANE | SEMANTIC_TARGET),具体参见平面语义识别模式定义。 |
Method |
|---|
public void setUpdateMode(UpdateMode updateMode) 设置当前ARSession更新模型。 |
Parameters
Name | Description |
|---|---|
updateMode | ARSession更新模型。 |