MaxstARSDK
maxstAR.CameraDevice Class Reference

class for camera device handling More...

Collaboration diagram for maxstAR.CameraDevice:
Collaboration graph

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 }
 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...
 

Detailed Description

class for camera device handling

Member Enumeration Documentation

◆ CameraResolution

Supported camera resolution

Enumerator
Resolution640x480 

640 * 480 (4:3 Resolution)

Resolution1280x720 

1280 * 720 (16:9 Resolution)

◆ CameraType

Supported camera type (Mobile only)

Enumerator
Rear 

Rear camera

Face 

Face camera

◆ FlipDirection

Flip video

Enumerator
HORIZONTAL 

Horizontal flip

VERTICAL 

Vertical flip

◆ 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

Member Function Documentation

◆ FlipVideo()

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

Flip video background

Parameters
directionFlip direction
onTrue to set. False to rest

◆ GetHeight()

int maxstAR.CameraDevice.GetHeight ( )

Returns
get camera preview height
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetInstance()

static CameraDevice maxstAR.CameraDevice.GetInstance ( )
static

Get a CameraDevice instance.

Returns
Return the CameraDevice instance
Here is the caller graph for this function:

◆ GetParamList()

List<string> maxstAR.CameraDevice.GetParamList ( )

Get parameter key list (Android only supported now)

Returns
parameter key list

◆ GetWidth()

int maxstAR.CameraDevice.GetWidth ( )

Returns
get camera preview width
Here is the caller graph for this function:

◆ SetAutoWhiteBalanceLock()

bool maxstAR.CameraDevice.SetAutoWhiteBalanceLock ( bool  toggle)

Toggle auto white balance lock (Android only supported now)

◆ SetFlashLightMode()

bool maxstAR.CameraDevice.SetFlashLightMode ( bool  toggle)

Turn on/off flash light

◆ SetFocusMode()

bool maxstAR.CameraDevice.SetFocusMode ( FocusMode  focusMode)

Set camera focus mode

Parameters
focusMode
Returns

◆ 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

◆ 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

◆ 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

◆ 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

◆ Start()

ResultCode maxstAR.CameraDevice.Start ( )

Start camera preview

Here is the call graph for this function:

◆ Stop()

void maxstAR.CameraDevice.Stop ( )

Stop camera preview


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