class for camera device handling More...

Collaboration diagram for maxstAR.CameraDevice:

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	SetNewFrame (byte[] data, int length, int width, int height, ColorFormat format)
	Set external camera image to AR engine.(Free, Enterprise license key can activate this interface. Mobile only supported) More...

bool	SetNewFrame (ulong data, int length, int width, int height, ColorFormat format)
	Set external camera image to AR engine.(Free, Enterprise license key can activate this interface. Mobile only supported) More...

bool	SetNewFrameAndTimestamp (byte[] data, int length, int width, int height, ColorFormat format, ulong timestamp)
	Set external camera image and timestamp to AR engine.(Free, Enterprise license key can activate this interface. Mobile only supported) More...

bool	SetNewFrameAndTimestamp (ulong data, int length, int width, int height, ColorFormat format, ulong timestamp)
	Set external camera image and timestamp to AR engine.(Free, Enterprise license key can activate this interface. Mobile only supported) 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...

bool	SetZoom (float zoomValue)
	Set Camera Zoom Scale More...

float	getMaxZoomValue ()
	Get Camera Device Max Zoom value. 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...

ResultCode	Stop ()
	Stop camera preview More...

int	GetWidth ()

int	GetHeight ()

Matrix4x4	GetProjectionMatrix ()
	Get projection matrix More...

float []	GetBackgroundPlaneInfo ()
	Get background plane info More...

bool	IsFlipHorizontal ()
	Get flip state More...

bool	IsFlipVertical ()
	Get flip state More...

bool	CheckCameraMove (TrackedImage image)

Static Public Member Functions
static CameraDevice	GetInstance ()
	Get a CameraDevice instance. More...

Detailed Description

class for camera device handling

Member Enumeration Documentation

◆ CameraResolution

enum maxstAR.CameraDevice.CameraResolution

strong

Supported camera resolution

Enumerator
Resolution640x480	640 * 480 (4:3 Resolution)
Resolution1280x720	1280 * 720 (16:9 Resolution)
Resolution1920x1080	1920 * 1080 (16:9 Resolution)

◆ CameraType

enum maxstAR.CameraDevice.CameraType

strong

Supported camera type (Mobile only)

Enumerator
Rear	Rear camera
Face	Face camera

◆ FlipDirection

enum maxstAR.CameraDevice.FlipDirection

strong

Flip video

Enumerator
HORIZONTAL	Horizontal flip
VERTICAL	Vertical flip

◆ FocusMode

enum maxstAR.CameraDevice.FocusMode

strong

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

◆ CheckCameraMove()

bool maxstAR.CameraDevice.CheckCameraMove ( TrackedImage image )

Here is the call graph for this function:

◆ FlipVideo()

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

Flip video background

Parameters

direction	Flip direction
on	True to set. False to rest

Here is the call graph for this function:

◆ GetBackgroundPlaneInfo()

float [] maxstAR.CameraDevice.GetBackgroundPlaneInfo ( )

Get background plane info

Returns: float[5] background plane info

Here is the call graph for this function:

◆ GetHeight()

int maxstAR.CameraDevice.GetHeight ( )

Returns: get camera preview height

Here is the call graph for this function:

◆ GetInstance()

static CameraDevice maxstAR.CameraDevice.GetInstance ( )

static

Get a CameraDevice instance.

Returns: Return the CameraDevice instance

◆ getMaxZoomValue()

float maxstAR.CameraDevice.getMaxZoomValue ( )

Get Camera Device Max Zoom value.

Returns: Max Zoom value.

Here is the call graph for this function:

◆ GetParamList()

List<string> maxstAR.CameraDevice.GetParamList ( )

Get parameter key list (Android only supported now)

Returns: parameter key list

Here is the call graph for this function:

◆ GetProjectionMatrix()

Matrix4x4 maxstAR.CameraDevice.GetProjectionMatrix ( )

Get projection matrix

Returns: Matrix4x4 projection matrix

Here is the call graph for this function:

◆ GetWidth()

int maxstAR.CameraDevice.GetWidth ( )

Returns: get camera preview width

Here is the call graph for this function:

◆ IsFlipHorizontal()

bool maxstAR.CameraDevice.IsFlipHorizontal ( )

Get flip state

Returns: Horizontal flip

◆ IsFlipVertical()

bool maxstAR.CameraDevice.IsFlipVertical ( )

Get flip state

Returns: Vertical flip

◆ SetAutoWhiteBalanceLock()

bool maxstAR.CameraDevice.SetAutoWhiteBalanceLock ( bool toggle )

Toggle auto white balance lock (Android only supported now)

Here is the call graph for this function:

◆ SetFlashLightMode()

bool maxstAR.CameraDevice.SetFlashLightMode ( bool toggle )

Turn on/off flash light

Here is the call graph for this function:

◆ SetFocusMode()

bool maxstAR.CameraDevice.SetFocusMode ( FocusMode focusMode )

Set camera focus mode

Parameters

focusMode

Returns

Here is the call graph for this function:

◆ SetNewFrame() [1/2]

bool maxstAR.CameraDevice.SetNewFrame	(	byte []	data,
		int	length,
		int	width,
		int	height,
		ColorFormat	format
	)

Set external camera image to AR engine.(Free, Enterprise license key can activate this interface. Mobile only supported)

Parameters

data	Byte array of camera image
length	Lenght of data buffer
width	Width of camera image
height	Height of camera image
format	Color format

Returns: True success

Here is the call graph for this function:

◆ SetNewFrame() [2/2]

bool maxstAR.CameraDevice.SetNewFrame	(	ulong	data,
		int	length,
		int	width,
		int	height,
		ColorFormat	format
	)

Set external camera image to AR engine.(Free, Enterprise license key can activate this interface. Mobile only supported)

Parameters

data	Native address of camera image
length	Lenght of data buffer
width	Width of camera image
height	Height of camera image
format	Color format

Returns: True success

Here is the call graph for this function:

◆ SetNewFrameAndTimestamp() [1/2]

bool maxstAR.CameraDevice.SetNewFrameAndTimestamp	(	byte []	data,
		int	length,
		int	width,
		int	height,
		ColorFormat	format,
		ulong	timestamp
	)

Set external camera image and timestamp to AR engine.(Free, Enterprise license key can activate this interface. Mobile only supported)

Parameters

data	Byte array of camera image
length	Lenght of data buffer
width	Width of camera image
height	Height of camera image
format	Color format
timestamp	Timestamp

Returns: True success

Here is the call graph for this function:

◆ SetNewFrameAndTimestamp() [2/2]

bool maxstAR.CameraDevice.SetNewFrameAndTimestamp	(	ulong	data,
		int	length,
		int	width,
		int	height,
		ColorFormat	format,
		ulong	timestamp
	)

Set external camera image and timestamp to AR engine.(Free, Enterprise license key can activate this interface. Mobile only supported)

Parameters

data	Native address of camera image
length	Lenght of data buffer
width	Width of camera image
height	Height of camera image
format	Color format
timestamp	Timestamp

Returns: True success

Here is the call graph for this function:

◆ SetParam() [1/4]

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

Set camera parameter (Android only supported now)

Parameters

key	Parameter key
boolTypeValue	Parameter value

Returns: True if setting success

Here is the call graph for this function:

◆ SetParam() [2/4]

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

Set camera parameter (Android only supported now)

Parameters

key	Parameter key
intTypeValue	Parameter value

Returns: True success

Here is the call graph for this function:

◆ SetParam() [3/4]

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

Set camera parameter (Android only supported now)

Parameters

key	Parameter key
min	min value
max	min value

Returns: True success

Here is the call graph for this function:

◆ SetParam() [4/4]

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

Set camera parameter (Android only supported now)

Parameters

key	Parameter key
stringTypeValue	Parameter value

Returns: True if setting success

Here is the call graph for this function:

◆ SetZoom()

bool maxstAR.CameraDevice.SetZoom ( float zoomValue )

Set Camera Zoom Scale

Parameters

zoomValue zoomScale Zoom value

Returns: result Zoom.

Here is the call graph for this function:

◆ Start()

ResultCode maxstAR.CameraDevice.Start ( )

Start camera preview

Here is the call graph for this function:

◆ Stop()

ResultCode maxstAR.CameraDevice.Stop ( )

Stop camera preview

Here is the call graph for this function:

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

/Users/keane/Work/MaxstARSDK/MaxstARSDK_master/MaxstARUnity/Assets/MaxstAR/Script/Wrapper/CameraDevice.cs

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ CameraResolution

◆ CameraType

◆ FlipDirection

◆ FocusMode

Member Function Documentation

◆ CheckCameraMove()

◆ FlipVideo()

◆ GetBackgroundPlaneInfo()

◆ GetHeight()

◆ GetInstance()

◆ getMaxZoomValue()

◆ GetParamList()

◆ GetProjectionMatrix()

◆ GetWidth()

◆ IsFlipHorizontal()

◆ IsFlipVertical()

◆ SetAutoWhiteBalanceLock()

◆ SetFlashLightMode()

◆ SetFocusMode()

◆ SetNewFrame() [1/2]

◆ SetNewFrame() [2/2]

◆ SetNewFrameAndTimestamp() [1/2]

◆ SetNewFrameAndTimestamp() [2/2]

◆ SetParam() [1/4]

◆ SetParam() [2/4]

◆ SetParam() [3/4]

◆ SetParam() [4/4]

◆ SetZoom()

◆ Start()

◆ Stop()