This document introduces you to the Snapshot API.


This API allows the client to request snapshot data in a specified image format for both still images and video. The client can specify the properties of the snapshot, such as size, background colour and position to be used. For example, details about whether the snapshot has been scaled.

Snapshot API Library Details

The DLL that provides the functionality and the library to which your code must link is identified below.

DLL LIB Short Description





These files are used for implementing the Snapshot APIs.

Architectural Relationship

This is part of the camera component.


The client application using this API should provide McameraObserver2 interface to be signalled, with event KuidECamEventCameraSnapshot , when snapshot data is available to be retrieved from the Ecam server. The client can then retrieve the snapshot data from the server.

Key Snapshot API Classes

The key classes that make up the Snapshot API are as follows:

Using Snapshot API

Clients can use the Snapshot API to:

  • Create snapshots for still images and video.

  • View the captured images on the display instantly.

See also

Overview of the Camera component

The Snapshot tutorial