diff options
Diffstat (limited to 'src/imports/multimedia/qdeclarativemultimediaglobal.cpp')
| -rw-r--r-- | src/imports/multimedia/qdeclarativemultimediaglobal.cpp | 220 |
1 files changed, 220 insertions, 0 deletions
diff --git a/src/imports/multimedia/qdeclarativemultimediaglobal.cpp b/src/imports/multimedia/qdeclarativemultimediaglobal.cpp new file mode 100644 index 000000000..ff1b4bc6a --- /dev/null +++ b/src/imports/multimedia/qdeclarativemultimediaglobal.cpp @@ -0,0 +1,220 @@ +/**************************************************************************** +** +** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the plugins of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Digia gives you certain additional +** rights. These rights are described in the Digia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qdeclarativemultimediaglobal_p.h" + +#include <qcamerainfo.h> +#include <qjsengine.h> + +QT_BEGIN_NAMESPACE + +/*! +\qmltype QtMultimedia +\inqmlmodule QtMultimedia +\ingroup multimedia_qml +\since QtMultimedia 5.4 +\brief Provides a global object with useful functions from Qt Multimedia. + +The \c QtMultimedia object is a global object with utility functions and properties. + +It is not instantiable; to use it, call the members of the global \c QtMultimedia object directly. +For example: + +\qml +import QtQuick 2.0 +import QtMultimedia 5.4 + +Camera { + deviceId: QtMultimedia.defaultCamera.deviceId +} +\endqml + +*/ + +/*! + \qmlproperty object QtMultimedia::QtMultimedia::defaultCamera + \readonly + + The \c defaultCamera object provides information about the default camera on the system. + + Its properties are \c deviceId, \c displayName, \c position and \c orientation. See + \l{QtMultimedia::QtMultimedia::availableCameras}{availableCameras} for a description of each + of them. + + If there is no default camera, \c defaultCamera.deviceId will contain an empty string. + + \note This property is static; it is not updated if the system's default camera changes after the + application started. +*/ + +/*! + \qmlproperty list<object> QtMultimedia::QtMultimedia::availableCameras + \readonly + + This property provides information about the cameras available on the system. + + Each object in the list has the following properties: + + \table + \row + \li \c deviceId + \li + This read-only property holds the unique identifier of the camera. + + You can choose which device to use with a \l Camera object by setting its + \l{Camera::deviceId}{deviceId} property to this value. + + \row + \li \c displayName + \li + This read-only property holds the human-readable name of the camera. + You can use this property to display the name of the camera in a user interface. + + \row + \li \c position + \li + This read-only property holds the physical position of the camera on the hardware system. + Please see \l{Camera::position}{Camera.position} for more information. + + \row + \li \c orientation + \li + This read-only property holds the physical orientation of the camera sensor. + Please see \l{Camera::orientation}{Camera.orientation} for more information. + + \endtable + + \note This property is static; it is not updated when cameras are added or removed from + the system, like USB cameras on a desktop platform. + + The following example shows how to display a list of available cameras. The user can change + the active camera by selecting one of the items in the list. + + \qml + import QtQuick 2.0 + import QtMultimedia 5.4 + + Item { + + Camera { + id: camera + } + + VideoOutput { + anchors.fill: parent + source: camera + } + + ListView { + anchors.fill: parent + + model: QtMultimedia.availableCameras + delegate: Text { + text: modelData.displayName + + MouseArea { + anchors.fill: parent + onClicked: camera.deviceId = modelData.deviceId + } + } + } + } + + \endqml +*/ + +namespace QDeclarativeMultimedia { + +#define FREEZE_SOURCE "(function deepFreeze(o) { "\ + " var prop, propKey;" \ + " Object.freeze(o);" \ + " for (propKey in o) {" \ + " prop = o[propKey];" \ + " if (!o.hasOwnProperty(propKey) || !(typeof prop === \"object\") || " \ + " Object.isFrozen(prop)) {" \ + " continue;" \ + " }" \ + " deepFreeze(prop);" \ + " }" \ + "})" + +static void deepFreeze(QJSEngine *jsEngine, const QJSValue &obj) +{ + QJSValue freezeFunc = jsEngine->evaluate(QString::fromUtf8(FREEZE_SOURCE)); + freezeFunc.call(QJSValueList() << obj); +} + +static QJSValue cameraInfoToJSValue(QJSEngine *jsEngine, const QCameraInfo &camera) +{ + QJSValue o = jsEngine->newObject(); + o.setProperty(QStringLiteral("deviceId"), camera.deviceName()); + o.setProperty(QStringLiteral("displayName"), camera.description()); + o.setProperty(QStringLiteral("position"), int(camera.position())); + o.setProperty(QStringLiteral("orientation"), camera.orientation()); + return o; +} + +QJSValue initGlobalObject(QQmlEngine *qmlEngine, QJSEngine *jsEngine) +{ + Q_UNUSED(qmlEngine) + + QJSValue globalObject = jsEngine->newObject(); + + // property object defaultCamera + globalObject.setProperty(QStringLiteral("defaultCamera"), + cameraInfoToJSValue(jsEngine, QCameraInfo::defaultCamera())); + + // property list<object> availableCameras + QList<QCameraInfo> cameras = QCameraInfo::availableCameras(); + QJSValue availableCameras = jsEngine->newArray(cameras.count()); + for (int i = 0; i < cameras.count(); ++i) + availableCameras.setProperty(i, cameraInfoToJSValue(jsEngine, cameras.at(i))); + globalObject.setProperty(QStringLiteral("availableCameras"), availableCameras); + + // freeze global object to prevent properties to be modified from QML + deepFreeze(jsEngine, globalObject); + + return globalObject; +} + +} + +QT_END_NAMESPACE |