From a00c588c70a6f4df6ddaf112a49e9fed763a29e2 Mon Sep 17 00:00:00 2001 From: Yoann Lopes Date: Mon, 10 Aug 2015 16:46:10 +0200 Subject: Improve documentation for mediaObject property. In Camera and MediaPlayer types. Change-Id: Iaf17dc7e5f7075ce7eeefcf7992b970d1ea99e83 Reviewed-by: Venugopal Shivashankar --- src/imports/multimedia/qdeclarativeaudio.cpp | 34 +++++++++++++-------------- src/imports/multimedia/qdeclarativecamera.cpp | 11 ++++++++- 2 files changed, 26 insertions(+), 19 deletions(-) (limited to 'src/imports/multimedia') diff --git a/src/imports/multimedia/qdeclarativeaudio.cpp b/src/imports/multimedia/qdeclarativeaudio.cpp index bb1af91db..17d57ffb7 100644 --- a/src/imports/multimedia/qdeclarativeaudio.cpp +++ b/src/imports/multimedia/qdeclarativeaudio.cpp @@ -774,19 +774,18 @@ void QDeclarativeAudio::_q_statusChanged() */ /*! - \qmlproperty variant QtMultimedia::Audio::metaData.title + \qmlproperty variant QtMultimedia::Audio::mediaObject - This property holds the title of the media. + This property holds the native media object. - \sa {QMediaMetaData} -*/ + It can be used to get a pointer to a QMediaPlayer object in order to intergrate with C++ code. -/*! - \qmlproperty variant QtMultimedia::Audio::metaData.subTitle + \code + QObject *qmlAudio; // The QML Audio object + QMediaPlayer *player = qvariant_cast(qmlAudio->property("mediaObject")); + \endcode - This property holds the sub-title of the media. - - \sa {QMediaMetaData} + \note This property is not accessible from QML. */ /*! @@ -1470,19 +1469,18 @@ void QDeclarativeAudio::_q_statusChanged() */ /*! - \qmlproperty variant QtMultimedia::MediaPlayer::metaData.title + \qmlproperty variant QtMultimedia::MediaPlayer::mediaObject - This property holds the title of the media. + This property holds the native media object. - \sa {QMediaMetaData} -*/ + It can be used to get a pointer to a QMediaPlayer object in order to intergrate with C++ code. -/*! - \qmlproperty variant QtMultimedia::MediaPlayer::metaData.subTitle + \code + QObject *qmlMediaPlayer; // The QML MediaPlayer object + QMediaPlayer *player = qvariant_cast(qmlMediaPlayer->property("mediaObject")); + \endcode - This property holds the sub-title of the media. - - \sa {QMediaMetaData} + \note This property is not accessible from QML. */ /*! diff --git a/src/imports/multimedia/qdeclarativecamera.cpp b/src/imports/multimedia/qdeclarativecamera.cpp index c5d899e98..d3faf8db8 100644 --- a/src/imports/multimedia/qdeclarativecamera.cpp +++ b/src/imports/multimedia/qdeclarativecamera.cpp @@ -778,7 +778,16 @@ void QDeclarativeCamera::setDigitalZoom(qreal value) /*! \qmlproperty variant QtMultimedia::Camera::mediaObject - This property holds the media object for the camera. + This property holds the native media object for the camera. + + It can be used to get a pointer to a QCamera object in order to intergrate with C++ code. + + \code + QObject *qmlCamera; // The QML Camera object + QCamera *camera = qvariant_cast(qmlCamera->property("mediaObject")); + \endcode + + \note This property is not accessible from QML. */ /*! -- cgit v1.2.3