Maxst AR SDK 4.0.0  4.0.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...
 
(void) - setNewFrameAndTimestamp:length:width:height:format:timestamp:
 
(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

Method Documentation

◆ flipVideo:toggle:()

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

Flip video.

Parameters
directionFlip direction
toggletrue for set, false for reset

◆ getBackgroundPlaneProjectionMatrix()

- (matrix_float4x4) getBackgroundPlaneProjectionMatrix

Get projection matrix for background plane rendering.

Returns
4x4 matrix (Column major)

◆ getHeight()

- (int) getHeight
Returns
camera preview height

◆ getParamList()

- (NSMutableArray *) getParamList

Get supported parameter key list.

Returns
Parameter key list

◆ getProjectionMatrix()

- (matrix_float4x4) getProjectionMatrix

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

Returns
4x4 matrix (Column major)

◆ getWidth()

- (int) getWidth
Returns
camera preview width

◆ setFocusMode:()

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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

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