Improve documentation for mediaObject property.

In Camera and MediaPlayer types.

Change-Id: Iaf17dc7e5f7075ce7eeefcf7992b970d1ea99e83
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
This commit is contained in:
Yoann Lopes
2015-08-10 16:46:10 +02:00
parent 6684b4b23b
commit a00c588c70
2 changed files with 26 additions and 19 deletions

View File

@@ -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<QMediaPlayer *>(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<QMediaPlayer *>(qmlMediaPlayer->property("mediaObject"));
\endcode
This property holds the sub-title of the media.
\sa {QMediaMetaData}
\note This property is not accessible from QML.
*/
/*!

View File

@@ -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<QCamera *>(qmlCamera->property("mediaObject"));
\endcode
\note This property is not accessible from QML.
*/
/*!