MaxstARSDK  3.5.0
Instance Methods | Protected Member Functions | List of all members
MasCameraDevice Class Reference

class for camera device handling More...

#import <MasCameraDevice.h>

Inheritance diagram for MasCameraDevice:

Instance Methods

(MasResultCode) - start:width:height:
 Start camera preview. More...
 
(void) - stop
 Stop camera preview.
 
(int) - getWidth
 
(int) - getHeight
 
(bool) - setFocusMode:
 
(bool) - setFlashLightMode:
 Turn on/off flash light.
 
(bool) - setAutoWhiteBalanceLock:
 Turn on/off auto white balance lock.
 
(void) - flipVideo:toggle:
 Flip video. More...
 
(NSMutableArray *) - getParamList
 Get supported parameter key list. More...
 
(bool) - setParam:toggle:
 Set camera parameter (Android only supported now) More...
 
(bool) - setParam:value:
 Set camera parameter (Android only supported now) More...
 
(bool) - setParam:min:max:
 Set camera parameter (Android only supported now) More...
 
(bool) - setParam:valueString:
 Set camera parameter (Android only supported now) More...
 
(void) - setNewFrame:length:width:height:format:
 Set new image data for tracking and background rendering (Only enterprise license key can activate this interface) More...
 
(matrix_float4x4) - getProjectionMatrix
 Get projection matrix. This is used for augmented objects projection and background rendering. More...
 
(matrix_float4x4) - getBackgroundPlaneProjectionMatrix
 Get projection matrix for background plane rendering. More...
 

Protected Member Functions

(typedef) - NS_ENUM
 
(typedef) - NS_ENUM
 
(typedef) - NS_ENUM
 

Detailed Description

class for camera device handling

Definition at line 16 of file MasCameraDevice.h.

Method Documentation

◆ flipVideo:toggle:()

- (void) flipVideo: (MasFlipDirection)  direction
toggle: (bool)  toggle 

Flip video.

Parameters
directionFlip direction
toggletrue for set, false for reset

Definition at line 54 of file MasCameraDevice.mm.

◆ getBackgroundPlaneProjectionMatrix()

- (matrix_float4x4) getBackgroundPlaneProjectionMatrix

Get projection matrix for background plane rendering.

Returns
4x4 matrix (Column major)

Definition at line 92 of file MasCameraDevice.mm.

◆ getHeight()

- (int) getHeight
Returns
camera preview height

Definition at line 42 of file MasCameraDevice.mm.

◆ getParamList()

- (NSMutableArray *) getParamList

Get supported parameter key list.

Returns
Parameter key list

Definition at line 58 of file MasCameraDevice.mm.

◆ getProjectionMatrix()

- (matrix_float4x4) getProjectionMatrix

Get projection matrix. This is used for augmented objects projection and background rendering.

Returns
4x4 matrix (Column major)

Definition at line 88 of file MasCameraDevice.mm.

◆ getWidth()

- (int) getWidth
Returns
camera preview width

Definition at line 39 of file MasCameraDevice.mm.

◆ setFocusMode:()

- (bool) setFocusMode: (MasFocusMode)  mode
Returns
true if focus setting success

Definition at line 45 of file MasCameraDevice.mm.

◆ setNewFrame:length:width:height:format:()

- (void) setNewFrame: (Byte *)  data
length: (int)  length
width: (int)  width
height: (int)  height
format: (MasColorFormat)  format 

Set new image data for tracking and background rendering (Only enterprise license key can activate this interface)

Parameters
dataimage data bytes.
lengthimage length
widthimage width
heightimage height
formatimage format

Definition at line 85 of file MasCameraDevice.mm.

◆ setParam:min:max:()

- (bool) setParam: (NSString*)  key
min: (int)  min
max: (int)  max 

Set camera parameter (Android only supported now)

Parameters
keyParameter key
minParameter min value
maxParameter max value
Returns
True if setting success

Definition at line 76 of file MasCameraDevice.mm.

◆ setParam:toggle:()

- (bool) setParam: (NSString*)  key
toggle: (bool)  toggle 

Set camera parameter (Android only supported now)

Parameters
keyParameter key
toggleParameter value
Returns
True if setting success

Definition at line 68 of file MasCameraDevice.mm.

◆ setParam:value:()

- (bool) setParam: (NSString*)  key
value: (int)  value 

Set camera parameter (Android only supported now)

Parameters
keyParameter key
valueParameter value
Returns
True if setting success

Definition at line 72 of file MasCameraDevice.mm.

◆ setParam:valueString:()

- (bool) setParam: (NSString*)  key
valueString: (NSString*)  value 

Set camera parameter (Android only supported now)

Parameters
keyParameter key
valueParameter value
Returns
True if setting success

Definition at line 80 of file MasCameraDevice.mm.

◆ start:width:height:()

- (MasResultCode) start: (int)  cameraId
width: (int)  width
height: (int)  height 

Start camera preview.

Parameters
cameraId0 is rear camera, 1 is face camera. camera index may depends on device.
widthprefer camera width
heightprefer camera height
Returns
MasResultCode

Definition at line 33 of file MasCameraDevice.mm.


The documentation for this class was generated from the following files: