14. API Reference
This section provides a detailed description of ARGear classes.
ARGSession class stores statuses of an application and provides corresponding functions based on the statuses.
Properties | Description |
NS_OPTIONS ARGInferenceFeature | ARGear Inference Option |
NS_OPTIONS ARGInferenceDebugOption | ARGear Debugging Option |
ARGSessionDelegate | Description |
- didUpdateFrame | Called when ARGFrame is updated |
Method | Description |
- initWithARGConfig:error | Initialize ARGSession with ARGConfig. |
- initWithARGConfig:feature:error: | Initialize ARGSession with ARGConfig and ARGInferenceFeature. |
- inferenceConfig: | Configure SDK with ARGInferenceOption. |
- runWithInferenceConfig: | Run ARGSession with ARGInferenceOption. |
- run | Run ARGSession. |
- pause | Pause ARGSession. |
- updateSampleBuffer:frromConnection: *)connection | Pass sampleBuffer and connection to ARGSession. |
- updateMetadataObjects:fromConnection | Pass metadataObjects and connection to ARGSession. |
- applyAdditionalFaceInfoWithPixelbuffer: transform:vertices:viewportSize:convert: | Pass additional information for face detection and CVPixelBuffer. |
- feedPixelbuffer: | Pass CVPixelBuffer. |
- destroy | Destroy ARGSession. |
typedef NS_OPTIONS (NSInteger,ARGInferenceFeature) |
ARGInferenceFeature is a required parameter and can be obtained from ARGFrame. Types of feature inferences are declared as follows. typedef NS_OPTIONS (NSInteger,ARGInferenceFeature) { ARGInferenceFeatureFaceLowTracking = 1 << 0, // Machine Learning based Tracking ARGInferenceFeatureFaceHighTracking = 1 << 1, ARGInferenceFeatureFaceMeshTracking = 1 << 2, // ARGInferenceFeatureFaceBlendShapes = 1 << 3, // ARGInferenceFeatureSegmentationHalf = 1 << 4, // ARGInferenceFeatureSegmentationFull = 1 << 5, // ARGInferenceFeatureHandTracking = 1 << 6, // ARGInferenceFeatureHandLandmark2D = 1 << 7, // ARGInferenceFeatureHandLandmark3D = 1 << 8, // ARGInferenceFeatureBodyTracking = 1 << 9, // ARGInferenceFeatureBodyPose2D = 1 << 10, // ARGInferenceFeatureBodyPose3D = 1 << 11, ARGInferenceFeatureExtARKitFaceTracking = 1 << 12
}; |
typedef NS_OPTIONS (NSInteger,ARGInferenceDebugOption) |
Types of Debugging Options in ARGear.
ARGInferenceOptionDebugNON: Turn off Debugging Mode ARGInferenceOptionDebugFaceTracking: Draw Face Tracking Boxes for Debugging ARGInferenceOptionDebugFaceLandmark2D: Draw Face Landmark for Debugging |
- (void)didUpdateFrame:(ARGFrame *)frame |
- (instancetype _Nullable)initWithARGConfig:(ARGConfig*)argconfig error:(NSError **)error |
Parameters
Returns
|