CAMClose

Syntax

#include <cafe/camera/camera.h>

int CAMClose(CAMHandle hCam);

Parameters

hCam Handle returned from CAMInit.

Return Values

A value of zero indicates success and any other value indicates the type of error that was encountered.

The following error codes can be returned.

CAMERA_ERROR_INVALID_HANDLE hCam handle is invalid.
CAMERA_ERROR_UNIINITIALIZED Camera driver is either not initialized or is not open.
CAMERA_ERROR_UVD_FAILURE UVD decoder failed to close.
CAMERA_ERROR_DEVICE_NOT_READY Camera streaming failed to close.
CAMERA_ERROR_NONE No error.

Description

Calling this function will stop the streaming of video frames from the DRC camera. All the underlying drivers will go to a quiescent state and the target surfaces will not be touched. It is safe for the application to destroy the submitted target surfaces at this time. Camera streaming can be started again by calling CAMOpen which ignores any previously submitted surfaces and reinitializes the target surface queues in the camera driver.

NOTE:
The DRC screen briefly turns black when calling this function. This is a hardware specification and it is recommended to take action to anticipate this occurrence such as manually fading out to black.

Do Not Call From

Background Do not call this function from the background.
Interrupt handler Do not call this function from any interrupt handler.
Exception handler Do not call this function from any exception handler.

See Also

CAMHandle
CAMInit
CAMOpen

Revision History

2013-05-08 Automated cleanup pass.
2012-08-02 Cleanup Pass.
2011-10-24 Initial version.


CONFIDENTIAL