diff options
author | Peter Yard <peter.yard@nokia.com> | 2012-02-21 15:58:01 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-02-22 04:07:09 +0100 |
commit | cd5a8fc69d7acec07b03dc43a6a6f2bf9afa9952 (patch) | |
tree | 994b72beee2e1d642cd58b2e9b6389a7f701eff6 /src/imports/multimedia/qdeclarativeaudio_4.cpp | |
parent | e791e4f0e9d51e25d1cc547e8b48771008831099 (diff) |
Docs: fix qml links and standalone build for Multimedia
Change-Id: Ia3f1e49aef203911bb5cf1ee062c9100be213b38
Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>
Diffstat (limited to 'src/imports/multimedia/qdeclarativeaudio_4.cpp')
-rw-r--r-- | src/imports/multimedia/qdeclarativeaudio_4.cpp | 142 |
1 files changed, 71 insertions, 71 deletions
diff --git a/src/imports/multimedia/qdeclarativeaudio_4.cpp b/src/imports/multimedia/qdeclarativeaudio_4.cpp index 5cff803c7..094a264fc 100644 --- a/src/imports/multimedia/qdeclarativeaudio_4.cpp +++ b/src/imports/multimedia/qdeclarativeaudio_4.cpp @@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE -/*! +/* \qmlclass Audio QDeclarativeAudio \brief The Audio element allows you to add audio playback to a scene. @@ -78,7 +78,7 @@ QT_BEGIN_NAMESPACE \sa Video */ -/*! +/* \internal \class QDeclarativeAudio \brief The QDeclarativeAudio class provides an audio item that you can add to a QDeclarativeView. @@ -104,7 +104,7 @@ QDeclarativeAudio_4::~QDeclarativeAudio_4() shutdown(); } -/*! +/* \qmlmethod Audio::play() Starts playback of the media. @@ -121,7 +121,7 @@ void QDeclarativeAudio_4::play() setPlaying(true); } -/*! +/* \qmlmethod Audio::pause() Pauses playback of the media. @@ -138,7 +138,7 @@ void QDeclarativeAudio_4::pause() setPlaying(true); } -/*! +/* \qmlmethod Audio::stop() Stops playback of the media. @@ -155,13 +155,13 @@ void QDeclarativeAudio_4::stop() setPaused(false); } -/*! +/* \qmlproperty url Audio::source This property holds the source URL of the media. */ -/*! +/* \qmlproperty url Audio::autoLoad This property indicates if loading of media should begin immediately. @@ -169,7 +169,7 @@ void QDeclarativeAudio_4::stop() Defaults to true, if false media will not be loaded until playback is started. */ -/*! +/* \qmlproperty bool Audio::playing This property holds whether the media is playing. @@ -177,7 +177,7 @@ void QDeclarativeAudio_4::stop() Defaults to false, and can be set to true to start playback. */ -/*! +/* \qmlproperty bool Audio::paused This property holds whether the media is paused. @@ -185,31 +185,31 @@ void QDeclarativeAudio_4::stop() Defaults to false, and can be set to true to pause playback. */ -/*! +/* \qmlsignal Audio::onStarted() This handler is called when playback is started. */ -/*! +/* \qmlsignal Audio::onResumed() This handler is called when playback is resumed from the paused state. */ -/*! +/* \qmlsignal Audio::onPaused() This handler is called when playback is paused. */ -/*! +/* \qmlsignal Audio::onStopped() This handler is called when playback is stopped. */ -/*! +/* \qmlproperty enumeration Audio::status This property holds the status of media loading. It can be one of: @@ -232,7 +232,7 @@ QDeclarativeAudio_4::Status QDeclarativeAudio_4::status() const return Status(m_status); } -/*! +/* \qmlproperty int Audio::duration This property holds the duration of the media in milliseconds. @@ -240,7 +240,7 @@ QDeclarativeAudio_4::Status QDeclarativeAudio_4::status() const If the media doesn't have a fixed duration (a live stream for example) this will be 0. */ -/*! +/* \qmlproperty int Audio::position This property holds the current playback position in milliseconds. @@ -248,19 +248,19 @@ QDeclarativeAudio_4::Status QDeclarativeAudio_4::status() const If the \l seekable property is true, this property can be set to seek to a new position. */ -/*! +/* \qmlproperty real Audio::volume This property holds the volume of the audio output, from 0.0 (silent) to 1.0 (maximum volume). */ -/*! +/* \qmlproperty bool Audio::muted This property holds whether the audio output is muted. */ -/*! +/* \qmlproperty bool Audio::hasAudio This property holds whether the media contains audio. @@ -271,7 +271,7 @@ bool QDeclarativeAudio_4::hasAudio() const return !m_complete ? false : m_playerControl->isAudioAvailable(); } -/*! +/* \qmlproperty bool Audio::hasVideo This property holds whether the media contains video. @@ -282,14 +282,14 @@ bool QDeclarativeAudio_4::hasVideo() const return !m_complete ? false : m_playerControl->isVideoAvailable(); } -/*! +/* \qmlproperty real Audio::bufferProgress This property holds how much of the data buffer is currently filled, from 0.0 (empty) to 1.0 (full). */ -/*! +/* \qmlproperty bool Audio::seekable This property holds whether position of the audio can be changed. @@ -297,13 +297,13 @@ bool QDeclarativeAudio_4::hasVideo() const If true; setting a \l position value will cause playback to seek to the new position. */ -/*! +/* \qmlproperty real Audio::playbackRate This property holds the rate at which audio is played at as a multiple of the normal rate. */ -/*! +/* \qmlproperty enumeration Audio::error This property holds the error state of the audio. It can be one of: @@ -344,13 +344,13 @@ void QDeclarativeAudio_4::componentComplete() } -/*! +/* \qmlproperty string Audio::errorString This property holds a string describing the current error condition in more detail. */ -/*! +/* \qmlsignal Audio::onError(error, errorString) This handler is called when an \l {QMediaPlayer::Error}{error} has @@ -358,7 +358,7 @@ void QDeclarativeAudio_4::componentComplete() information about the error. */ -/*! +/* \qmlproperty variant Audio::metaData.title This property holds the tile of the media. @@ -366,7 +366,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Title} */ -/*! +/* \qmlproperty variant Audio::metaData.subTitle This property holds the sub-title of the media. @@ -374,7 +374,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::SubTitle} */ -/*! +/* \qmlproperty variant Audio::metaData.author This property holds the author of the media. @@ -382,7 +382,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Author} */ -/*! +/* \qmlproperty variant Audio::metaData.comment This property holds a user comment about the media. @@ -390,7 +390,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Comment} */ -/*! +/* \qmlproperty variant Audio::metaData.description This property holds a description of the media. @@ -398,7 +398,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Description} */ -/*! +/* \qmlproperty variant Audio::metaData.category This property holds the category of the media @@ -406,7 +406,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Category} */ -/*! +/* \qmlproperty variant Audio::metaData.genre This property holds the genre of the media. @@ -414,7 +414,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Genre} */ -/*! +/* \qmlproperty variant Audio::metaData.year This property holds the year of release of the media. @@ -422,7 +422,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Year} */ -/*! +/* \qmlproperty variant Audio::metaData.date This property holds the date of the media. @@ -430,7 +430,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Date} */ -/*! +/* \qmlproperty variant Audio::metaData.userRating This property holds a user rating of the media in the range of 0 to 100. @@ -438,7 +438,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::UserRating} */ -/*! +/* \qmlproperty variant Audio::metaData.keywords This property holds a list of keywords describing the media. @@ -446,7 +446,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Keywords} */ -/*! +/* \qmlproperty variant Audio::metaData.language This property holds the language of the media, as an ISO 639-2 code. @@ -454,7 +454,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Language} */ -/*! +/* \qmlproperty variant Audio::metaData.publisher This property holds the publisher of the media. @@ -462,7 +462,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Publisher} */ -/*! +/* \qmlproperty variant Audio::metaData.copyright This property holds the media's copyright notice. @@ -470,7 +470,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Copyright} */ -/*! +/* \qmlproperty variant Audio::metaData.parentalRating This property holds the parental rating of the media. @@ -478,7 +478,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::ParentalRating} */ -/*! +/* \qmlproperty variant Audio::metaData.ratingOrganization This property holds the name of the rating organization responsible for the @@ -487,7 +487,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::RatingOrganization} */ -/*! +/* \qmlproperty variant Audio::metaData.size This property property holds the size of the media in bytes. @@ -495,7 +495,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Size} */ -/*! +/* \qmlproperty variant Audio::metaData.mediaType This property holds the type of the media. @@ -503,7 +503,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::MediaType} */ -/*! +/* \qmlproperty variant Audio::metaData.audioBitRate This property holds the bit rate of the media's audio stream ni bits per @@ -512,7 +512,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::AudioBitRate} */ -/*! +/* \qmlproperty variant Audio::metaData.audioCodec This property holds the encoding of the media audio stream. @@ -520,7 +520,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::AudioCodec} */ -/*! +/* \qmlproperty variant Audio::metaData.averageLevel This property holds the average volume level of the media. @@ -528,7 +528,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::AverageLevel} */ -/*! +/* \qmlproperty variant Audio::metaData.channelCount This property holds the number of channels in the media's audio stream. @@ -536,7 +536,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::ChannelCount} */ -/*! +/* \qmlproperty variant Audio::metaData.peakValue This property holds the peak volume of media's audio stream. @@ -544,7 +544,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::PeakValue} */ -/*! +/* \qmlproperty variant Audio::metaData.sampleRate This property holds the sample rate of the media's audio stream in hertz. @@ -552,7 +552,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::SampleRate} */ -/*! +/* \qmlproperty variant Audio::metaData.albumTitle This property holds the title of the album the media belongs to. @@ -560,7 +560,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::AlbumTitle} */ -/*! +/* \qmlproperty variant Audio::metaData.albumArtist This property holds the name of the principal artist of the album the media @@ -569,7 +569,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::AlbumArtist} */ -/*! +/* \qmlproperty variant Audio::metaData.contributingArtist This property holds the names of artists contributing to the media. @@ -577,7 +577,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::ContributingArtist} */ -/*! +/* \qmlproperty variant Audio::metaData.composer This property holds the composer of the media. @@ -585,7 +585,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Composer} */ -/*! +/* \qmlproperty variant Audio::metaData.conductor This property holds the conductor of the media. @@ -593,7 +593,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Conductor} */ -/*! +/* \qmlproperty variant Audio::metaData.lyrics This property holds the lyrics to the media. @@ -601,7 +601,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Lyrics} */ -/*! +/* \qmlproperty variant Audio::metaData.mood This property holds the mood of the media. @@ -609,7 +609,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Mood} */ -/*! +/* \qmlproperty variant Audio::metaData.trackNumber This property holds the track number of the media. @@ -617,7 +617,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::TrackNumber} */ -/*! +/* \qmlproperty variant Audio::metaData.trackCount This property holds the number of track on the album containing the media. @@ -625,7 +625,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::TrackNumber} */ -/*! +/* \qmlproperty variant Audio::metaData.coverArtUrlSmall This property holds the URL of a small cover art image. @@ -633,7 +633,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::CoverArtUrlSmall} */ -/*! +/* \qmlproperty variant Audio::metaData.coverArtUrlLarge This property holds the URL of a large cover art image. @@ -641,7 +641,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::CoverArtUrlLarge} */ -/*! +/* \qmlproperty variant Audio::metaData.resolution This property holds the dimension of an image or video. @@ -649,7 +649,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Resolution} */ -/*! +/* \qmlproperty variant Audio::metaData.pixelAspectRatio This property holds the pixel aspect ratio of an image or video. @@ -657,7 +657,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::PixelAspectRatio} */ -/*! +/* \qmlproperty variant Audio::metaData.videoFrameRate This property holds the frame rate of the media's video stream. @@ -665,7 +665,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::VideoFrameRate} */ -/*! +/* \qmlproperty variant Audio::metaData.videoBitRate This property holds the bit rate of the media's video stream in bits per @@ -674,7 +674,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::VideoBitRate} */ -/*! +/* \qmlproperty variant Audio::metaData.videoCodec This property holds the encoding of the media's video stream. @@ -682,7 +682,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::VideoCodec} */ -/*! +/* \qmlproperty variant Audio::metaData.posterUrl This property holds the URL of a poster image. @@ -690,7 +690,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::PosterUrl} */ -/*! +/* \qmlproperty variant Audio::metaData.chapterNumber This property holds the chapter number of the media. @@ -698,7 +698,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::ChapterNumber} */ -/*! +/* \qmlproperty variant Audio::metaData.director This property holds the director of the media. @@ -706,7 +706,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::Director} */ -/*! +/* \qmlproperty variant Audio::metaData.leadPerformer This property holds the lead performer in the media. @@ -714,7 +714,7 @@ void QDeclarativeAudio_4::componentComplete() \sa {QtMultimedia::MetaData::LeadPerformer} */ -/*! +/* \qmlproperty variant Audio::metaData.writer This property holds the writer of the media. |