CopperSpice API  1.9.2
Public Methods | Static Public Methods | List of all members
QCameraInfo Class Reference
CsMultimedia

Provides general information about camera devices. More...

Public Methods

 QCameraInfo (const QCamera &camera)
 
 QCameraInfo (const QCameraInfo &other)
 
 QCameraInfo (const QString &name=QString ())
 
 ~QCameraInfo ()
 
QString description () const
 
QString deviceName () const
 
bool isNull () const
 
bool operator!= (const QCameraInfo &other) const
 
QCameraInfo & operator= (const QCameraInfo &other)
 
bool operator== (const QCameraInfo &other) const
 
int orientation () const
 
QCamera::Position position () const
 

Static Public Methods

static QList< QCameraInfo > availableCameras (QCamera::Position position=QCamera::UnspecifiedPosition)
 
static QCameraInfo defaultCamera ()
 

Detailed Description

The QCameraInfo class provides general information about camera devices. It is used to check for camera devices that are currently available on the system. The static methods defaultCamera() and availableCameras() provide a list of all available cameras.

This example prints the name of all available cameras.

QList<QCameraInfo> cameras = QCameraInfo::availableCameras();
for (const QCameraInfo &cameraInfo : cameras) {
qDebug() << cameraInfo.deviceName();
}

A QCameraInfo can be used to construct a QCamera. The following example instantiates a QCamera for the camera device named 'front-camera'.

QList<QCameraInfo> cameras = QCameraInfo::availableCameras();
for (const QCameraInfo &cameraInfo : cameras) {
if (cameraInfo.deviceName() == "front-camera") {
camera = new QCamera(cameraInfo);
}
}

You can also use QCameraInfo to get general information about a camera device such as description, physical position on the system, or camera sensor orientation.

QCamera myCamera;
QCameraInfo cameraInfo(myCamera);
if (cameraInfo.position() == QCamera::FrontFace) {
qDebug() << "Camera is on the front face of the hardware system.";
} else if (cameraInfo.position() == QCamera::BackFace) {
qDebug() << "Camera is on the back face of the hardware system.";
}
qDebug() << "The camera sensor orientation is " << cameraInfo.orientation() << " degrees.";
See also
QCamera

Constructor & Destructor Documentation

QCameraInfo::QCameraInfo ( const QString &  name = QString())
explicit

Constructs a camera info object from a camera device name. If no such device exists the QCameraInfo object will be invalid and isNull() will return true.

QCameraInfo::QCameraInfo ( const QCamera &  camera)
explicit

Constructs a camera info object for camera.

You can use it to query information about the camera object passed as argument. If the camera is invalid, for example when no camera device is available on the system, the QCameraInfo object will be invalid and isNull() will return true.

QCameraInfo::QCameraInfo ( const QCameraInfo &  other)

Constructs a copy of other.

QCameraInfo::~QCameraInfo ( )

Destroys the QCameraInfo.

Method Documentation

QList< QCameraInfo > QCameraInfo::availableCameras ( QCamera::Position  position = QCamera::UnspecifiedPosition)
static

Returns a list of available cameras on the system which are located at position. If position is not specified or if the value is QCamera::UnspecifiedPosition, a list of all available cameras will be returned.

QCameraInfo QCameraInfo::defaultCamera ( )
static

Returns the default camera on the system. The returned object should be checked using isNull() before being used, in case there is no default camera or no cameras at all.

See also
availableCameras()
QString QCameraInfo::description ( ) const

Returns the human-readable description of the camera.

QString QCameraInfo::deviceName ( ) const

Returns the device name of the camera

This is a unique ID to identify the camera and may not be human-readable.

bool QCameraInfo::isNull ( ) const

Returns true if this QCameraInfo is null or invalid.

bool QCameraInfo::operator!= ( const QCameraInfo &  other) const
inline

Returns true if this QCameraInfo is different from other.

QCameraInfo & QCameraInfo::operator= ( const QCameraInfo &  other)

Copy assigns from other and returns a reference to this object.

bool QCameraInfo::operator== ( const QCameraInfo &  other) const

Returns true if this QCameraInfo is equal to other.

int QCameraInfo::orientation ( ) const

Returns the physical orientation of the camera sensor.

The value is the orientation angle (clockwise, in steps of 90 degrees) of the camera sensor in relation to the display in its natural orientation. You can show the camera image in the correct orientation by rotating it by this value in the anti-clockwise direction.

For example, suppose a mobile device which is naturally in portrait orientation. The back-facing camera is mounted in landscape. If the top side of the camera sensor is aligned with the right edge of the screen in natural orientation, the value should be 270. If the top side of a front-facing camera sensor is aligned with the right of the screen, the value should be 90.

QCamera::Position QCameraInfo::position ( ) const

Returns the physical position of the camera on the hardware system.