ICamera Struct Reference

#include <Camera.h>

Inherited by CitrixMobile.

List of all members.

Public Member Functions
STDMETHODIMP	TakePicture ([in]CMP_IMAGE_FORMAT pictureType,[in]CMP_UNIQUE_ID pictureId,[out, retval]CMPRESULT *result)
	Take a picture.
STDMETHODIMP	GetPictureState ([in]CMP_UNIQUE_ID pictureId,[out]INT32 *size,[out]CMP_PICTURE_STATE *pictState,[out, retval]CMPRESULT *result)
	Get the current picture state based on unique Id.
STDMETHODIMP	GetPictureFilename ([in]CMP_UNIQUE_ID pictureId,[out]BSTR *filename,[out, retval]CMPRESULT *result)
	Get the picture filename from the mobile device.
STDMETHODIMP	RemovePicture ([in]CMP_UNIQUE_ID pictureId,[out, retval]CMPRESULT *result)
	Remove the picture on the mobile device.

---

Member Function Documentation

STDMETHODIMP ICamera::GetPictureFilename	(	[in] CMP_UNIQUE_ID	pictureId,
		[out] BSTR *	filename,
		[out, retval] CMPRESULT *	result
	)

Get the picture filename from the mobile device.

Get the filename of the picture from the mobile device camera. Once the application has the name, it can directly access the picture data as a file.

Parameters:

pictureId	- unique picture identifier
filename	- returned filename
result	- returned CMP-based result

Returns:

HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICamera::GetPictureState	(	[in] CMP_UNIQUE_ID	pictureId,
		[out] INT32 *	size,
		[out] CMP_PICTURE_STATE *	pictState,
		[out, retval] CMPRESULT *	result
	)

Get the current picture state based on unique Id.

Get the picture state from the mobile device camera. This could be used to poll the status of the camera after taking a picture. An alternative is to use the events related to the picture being taken.

Parameters:

pictureId	- unique picture identifier
size	- returned size of picture
pictState	- returned state of the picture (downloading, downloaded)
result	- returned CMP-based result

Returns:

HRESULT

STDMETHODIMP ICamera::RemovePicture	(	[in] CMP_UNIQUE_ID	pictureId,
		[out, retval] CMPRESULT *	result
	)

Remove the picture on the mobile device.

Remove the picture from the mobile device. We no longer need it for download and there is no reason to keep it on the device. This function only works with images that were taken with our API. The pictureId only works with our pictures. The client does not know if it is okay to delete a picture until it is told.

Parameters:

pictureId	- unique picture identifier
result	- returned CMP-based result

Returns:

HRESULT

Reimplemented in CitrixMobile.

STDMETHODIMP ICamera::TakePicture	(	[in] CMP_IMAGE_FORMAT	pictureType,
		[in] CMP_UNIQUE_ID	pictureId,
		[out, retval] CMPRESULT *	result
	)

Take a picture.

Starts the process of taking a picture on the mobile device camera. The image type is selected to specify which image format should be used. At this time it is either PNG or JPEG. A unique picture Id should be used to track the picture status and be able to retrieve the data

Parameters:

pictureType	- picture format type (either JPEG or PNG)
pictureId	- unique picture identifier
result	- returned CMP-based result

Returns:

HRESULT

Reimplemented in CitrixMobile.

---

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

• Camera.h
• cmpcom_en.txt