MaxstARSDK  3.5.0
Public Types | Public Member Functions | Static Public Member Functions | Package Functions | List of all members
maxstAR.CameraDevice Class Reference

class for camera device handling More...

Public Types

enum  FocusMode { FocusMode.FOCUS_MODE_CONTINUOUS_AUTO = 1, FocusMode.FOCUS_MODE_AUTO = 2 }
 Camera focus mode More...
 
enum  CameraType { CameraType.Rear = 0, CameraType.Face = 1 }
 Supported camera type (Mobile only) More...
 
enum  CameraResolution { CameraResolution.Resolution640x480, CameraResolution.Resolution1280x720, CameraResolution.Resolution1920x1080 }
 Supported camera resolution More...
 
enum  FlipDirection { FlipDirection.HORIZONTAL = 0, FlipDirection.VERTICAL = 1 }
 Flip video More...
 

Public Member Functions

ResultCode Start ()
 Start camera preview More...
 
bool SetFocusMode (FocusMode focusMode)
 Set camera focus mode More...
 
bool SetFlashLightMode (bool toggle)
 Turn on/off flash light More...
 
bool SetAutoWhiteBalanceLock (bool toggle)
 Toggle auto white balance lock (Android only supported now) More...
 
void FlipVideo (FlipDirection direction, bool on)
 Flip video background More...
 
List< string > GetParamList ()
 Get parameter key list (Android only supported now) More...
 
bool SetParam (string key, bool boolTypeValue)
 Set camera parameter (Android only supported now) More...
 
bool SetParam (string key, int intTypeValue)
 Set camera parameter (Android only supported now) More...
 
bool SetParam (string key, int min, int max)
 Set camera parameter (Android only supported now) More...
 
bool SetParam (string key, string stringTypeValue)
 Set camera parameter (Android only supported now) More...
 
void Stop ()
 Stop camera preview More...
 
int GetWidth ()
 
int GetHeight ()
 

Static Public Member Functions

static CameraDevice GetInstance ()
 Get a CameraDevice instance. More...
 

Package Functions

void GetProjectionMatrix (float[] matrix)
 
bool IsFlipHorizontal ()
 
bool IsFlipVertical ()
 
byte [] GetCameraFrameBuffer ()
 

Detailed Description

class for camera device handling

Definition at line 17 of file CameraDevice.cs.

Member Enumeration Documentation

◆ CameraResolution

Supported camera resolution

Enumerator
Resolution640x480 

640 * 480 (4:3 Resolution)

Resolution1280x720 

1280 * 720 (16:9 Resolution)

Resolution1920x1080 

1920 * 1080 (16:9 Resolution)

Definition at line 53 of file CameraDevice.cs.

◆ CameraType

Supported camera type (Mobile only)

Enumerator
Rear 

Rear camera

Face 

Face camera

Definition at line 37 of file CameraDevice.cs.

◆ FlipDirection

Flip video

Enumerator
HORIZONTAL 

Horizontal flip

VERTICAL 

Vertical flip

Definition at line 74 of file CameraDevice.cs.

◆ FocusMode

Camera focus mode

Enumerator
FOCUS_MODE_CONTINUOUS_AUTO 

Continuous focus mode. This focus mode is proper for AR

FOCUS_MODE_AUTO 

Single auto focus mode

Definition at line 22 of file CameraDevice.cs.

Member Function Documentation

◆ FlipVideo()

void maxstAR.CameraDevice.FlipVideo ( FlipDirection  direction,
bool  on 
)

Flip video background

Parameters
directionFlip direction
onTrue to set. False to rest

Definition at line 217 of file CameraDevice.cs.

◆ GetHeight()

int maxstAR.CameraDevice.GetHeight ( )

Returns
get camera preview height

Definition at line 381 of file CameraDevice.cs.

◆ GetInstance()

static CameraDevice maxstAR.CameraDevice.GetInstance ( )
static

Get a CameraDevice instance.

Returns
Return the CameraDevice instance

Definition at line 93 of file CameraDevice.cs.

◆ GetParamList()

List<string> maxstAR.CameraDevice.GetParamList ( )

Get parameter key list (Android only supported now)

Returns
parameter key list

Definition at line 243 of file CameraDevice.cs.

◆ GetWidth()

int maxstAR.CameraDevice.GetWidth ( )

Returns
get camera preview width

Definition at line 366 of file CameraDevice.cs.

◆ SetAutoWhiteBalanceLock()

bool maxstAR.CameraDevice.SetAutoWhiteBalanceLock ( bool  toggle)

Toggle auto white balance lock (Android only supported now)

Definition at line 200 of file CameraDevice.cs.

◆ SetFlashLightMode()

bool maxstAR.CameraDevice.SetFlashLightMode ( bool  toggle)

Turn on/off flash light

Definition at line 185 of file CameraDevice.cs.

◆ SetFocusMode()

bool maxstAR.CameraDevice.SetFocusMode ( FocusMode  focusMode)

Set camera focus mode

Parameters
focusMode
Returns

Definition at line 170 of file CameraDevice.cs.

◆ SetParam() [1/4]

bool maxstAR.CameraDevice.SetParam ( string  key,
bool  boolTypeValue 
)

Set camera parameter (Android only supported now)

Parameters
keyParameter key
boolTypeValueParameter value
Returns
True if setting success

Definition at line 281 of file CameraDevice.cs.

◆ SetParam() [2/4]

bool maxstAR.CameraDevice.SetParam ( string  key,
int  intTypeValue 
)

Set camera parameter (Android only supported now)

Parameters
keyParameter key
intTypeValueParameter value
Returns
True success

Definition at line 299 of file CameraDevice.cs.

◆ SetParam() [3/4]

bool maxstAR.CameraDevice.SetParam ( string  key,
int  min,
int  max 
)

Set camera parameter (Android only supported now)

Parameters
keyParameter key
minmin value
maxmin value
Returns
True success

Definition at line 318 of file CameraDevice.cs.

◆ SetParam() [4/4]

bool maxstAR.CameraDevice.SetParam ( string  key,
string  stringTypeValue 
)

Set camera parameter (Android only supported now)

Parameters
keyParameter key
stringTypeValueParameter value
Returns
True if setting success

Definition at line 336 of file CameraDevice.cs.

◆ Start()

ResultCode maxstAR.CameraDevice.Start ( )

Start camera preview

Definition at line 116 of file CameraDevice.cs.

◆ Stop()

void maxstAR.CameraDevice.Stop ( )

Stop camera preview

Definition at line 351 of file CameraDevice.cs.


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