slapin/qtmultimedia
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Remove antiquated \since lines in docs.

Browse Source 
They aren't useful in the case of QtMultimedia{Kit}

Change-Id: If1b0b6625763c85907fb05beb9c440046472ddef
Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>
This commit is contained in:
Michael Goddard
2012-01-16 15:19:20 +10:00
committed by Qt by Nokia
parent b228ff95d7
commit a6268601c9
81 changed files with 0 additions and 1319 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/multimedia/playback/qaudioendpointselector.cpp
View File

@@ -49,7 +49,6 @@ QT_BEGIN_NAMESPACE
\brief The QAudioEndpointSelector class provides an audio endpoint selector media control.
\inmodule QtMultimedia
\ingroup multimedia
\since 1.0
The QAudioEndpointSelector class provides descriptions of the audio
endpoints available on a system and allows one to be selected as the audio
@@ -90,49 +89,42 @@ QAudioEndpointSelector::~QAudioEndpointSelector()
\fn QList<QString> QAudioEndpointSelector::availableEndpoints() const
Returns a list of the names of the available audio endpoints.
\since 1.0
*/
/*!
\fn QString QAudioEndpointSelector::endpointDescription(const QString& name) const
Returns the description of the endpoint \a name.
\since 1.0
*/
/*!
\fn QString QAudioEndpointSelector::defaultEndpoint() const
Returns the name of the default audio endpoint.
\since 1.0
*/
/*!
\fn QString QAudioEndpointSelector::activeEndpoint() const
Returns the name of the currently selected audio endpoint.
\since 1.0
*/
/*!
\fn QAudioEndpointSelector::setActiveEndpoint(const QString& name)
Set the active audio endpoint to \a name.
\since 1.0
*/
/*!
\fn QAudioEndpointSelector::activeEndpointChanged(const QString& name)
Signals that the audio endpoint has changed to \a name.
\since 1.0
*/
/*!
\fn QAudioEndpointSelector::availableEndpointsChanged()
Signals that list of available endpoints has changed.
\since 1.0
*/
#include "moc_qaudioendpointselector.cpp"

14
src/multimedia/playback/qmediacontent.cpp
View File

@@ -89,7 +89,6 @@ private:
\inmodule QtMultimedia
\ingroup multimedia
\since 1.0
QMediaContent is used within the multimedia framework as the logical handle
to media content. A QMediaContent object is composed of one or more
@@ -112,7 +111,6 @@ QMediaContent::QMediaContent()
/*!
Constructs a media content with \a url providing a reference to the content.
\since 1.0
*/
QMediaContent::QMediaContent(const QUrl &url):
@@ -126,7 +124,6 @@ QMediaContent::QMediaContent(const QUrl &url):
This constructor can be used to reference media content via network protocols such as HTTP.
This may include additional information required to obtain the resource, such as Cookies or HTTP headers.
\since 1.0
*/
QMediaContent::QMediaContent(const QNetworkRequest &request):
@@ -137,7 +134,6 @@ QMediaContent::QMediaContent(const QNetworkRequest &request):
/*!
Constructs a media content with \a resource providing a reference to the content.
\since 1.0
*/
QMediaContent::QMediaContent(const QMediaResource &resource):
@@ -148,7 +144,6 @@ QMediaContent::QMediaContent(const QMediaResource &resource):
/*!
Constructs a media content with \a resources providing a reference to the content.
\since 1.0
*/
QMediaContent::QMediaContent(const QMediaResourceList &resources):
@@ -158,7 +153,6 @@ QMediaContent::QMediaContent(const QMediaResourceList &resources):
/*!
Constructs a copy of the media content \a other.
\since 1.0
*/
QMediaContent::QMediaContent(const QMediaContent &other):
@@ -176,7 +170,6 @@ QMediaContent::~QMediaContent()
/*!
Assigns the value of \a other to this media content.
\since 1.0
*/
QMediaContent& QMediaContent::operator=(const QMediaContent &other)
@@ -187,7 +180,6 @@ QMediaContent& QMediaContent::operator=(const QMediaContent &other)
/*!
Returns true if \a other is equivalent to this media content; false otherwise.
\since 1.0
*/
bool QMediaContent::operator==(const QMediaContent &other) const
@@ -199,7 +191,6 @@ bool QMediaContent::operator==(const QMediaContent &other) const
/*!
Returns true if \a other is not equivalent to this media content; false otherwise.
\since 1.0
*/
bool QMediaContent::operator!=(const QMediaContent &other) const
@@ -209,7 +200,6 @@ bool QMediaContent::operator!=(const QMediaContent &other) const
/*!
Returns true if this media content is null (uninitialized); false otherwise.
\since 1.0
*/
bool QMediaContent::isNull() const
@@ -219,7 +209,6 @@ bool QMediaContent::isNull() const
/*!
Returns a QUrl that represents that canonical resource for this media content.
\since 1.0
*/
QUrl QMediaContent::canonicalUrl() const
@@ -229,7 +218,6 @@ QUrl QMediaContent::canonicalUrl() const
/*!
Returns a QNetworkRequest that represents that canonical resource for this media content.
\since 1.0
*/
QNetworkRequest QMediaContent::canonicalRequest() const
@@ -239,7 +227,6 @@ QNetworkRequest QMediaContent::canonicalRequest() const
/*!
Returns a QMediaResource that represents that canonical resource for this media content.
\since 1.0
*/
QMediaResource QMediaContent::canonicalResource() const
@@ -252,7 +239,6 @@ QMediaResource QMediaContent::canonicalResource() const
/*!
Returns a list of alternative resources for this media content. The first item in this list
is always the canonical resource.
\since 1.0
*/
QMediaResourceList QMediaContent::resources() const

45
src/multimedia/playback/qmediaplayer.cpp
View File

@@ -65,7 +65,6 @@ QT_BEGIN_NAMESPACE
\brief The QMediaPlayer class allows the playing of a media source.
\inmodule QtMultimedia
\ingroup multimedia
\since 1.0
@@ -265,7 +264,6 @@ static QMediaService *playerService(QMediaPlayer::Flags flags, QMediaServiceProv
parented to \a parent and with \a flags.
If a playback service is not specified the system default will be used.
\since 1.0
*/
QMediaPlayer::QMediaPlayer(QObject *parent, QMediaPlayer::Flags flags, QMediaServiceProvider *provider):
@@ -345,7 +343,6 @@ QMediaContent QMediaPlayer::media() const
This is only valid if a stream was passed to setMedia().
\since 1.0
\sa setMedia()
*/
@@ -407,7 +404,6 @@ void QMediaPlayer::setPlaylist(QMediaPlaylist *playlist)
configuration that can be used for network access.
This will invalidate the choice of previous configurations.
\since 1.2
*/
void QMediaPlayer::setNetworkConfigurations(const QList<QNetworkConfiguration> &configurations)
{
@@ -524,7 +520,6 @@ qreal QMediaPlayer::playbackRate() const
/*!
Returns the current error state.
\since 1.0
*/
QMediaPlayer::Error QMediaPlayer::error() const
@@ -542,7 +537,6 @@ QString QMediaPlayer::errorString() const
If a default contructed QNetworkConfiguration is returned
this feature is not available or that none of the
current supplied configurations are in use.
\since 1.2
*/
QNetworkConfiguration QMediaPlayer::currentNetworkConfiguration() const
{
@@ -557,7 +551,6 @@ QNetworkConfiguration QMediaPlayer::currentNetworkConfiguration() const
//public Q_SLOTS:
/*!
Start or resume playing the current source.
\since 1.0
*/
void QMediaPlayer::play()
@@ -584,7 +577,6 @@ void QMediaPlayer::play()
/*!
Pause playing the current source.
\since 1.0
*/
void QMediaPlayer::pause()
@@ -597,7 +589,6 @@ void QMediaPlayer::pause()
/*!
Stop playing, and reset the play position to the beginning.
\since 1.0
*/
void QMediaPlayer::stop()
@@ -660,7 +651,6 @@ void QMediaPlayer::setPlaybackRate(qreal rate)
Setting the media to a null QMediaContent will cause the player to discard all
information relating to the current media source and to cease all I/O operations related
to that media.
\since 1.0
*/
void QMediaPlayer::setMedia(const QMediaContent &media, QIODevice *stream)
@@ -676,7 +666,6 @@ void QMediaPlayer::setMedia(const QMediaContent &media, QIODevice *stream)
/*!
\internal
\since 1.0
*/
bool QMediaPlayer::bind(QObject *obj)
@@ -686,7 +675,6 @@ bool QMediaPlayer::bind(QObject *obj)
/*!
\internal
\since 1.0
*/
void QMediaPlayer::unbind(QObject *obj)
@@ -699,7 +687,6 @@ void QMediaPlayer::unbind(QObject *obj)
The \a flags argument allows additional requirements such as performance indicators to be
specified.
\since 1.0
*/
QtMultimedia::SupportEstimate QMediaPlayer::hasSupport(const QString &mimeType,
const QStringList& codecs,
@@ -722,7 +709,6 @@ QtMultimedia::SupportEstimate QMediaPlayer::hasSupport(const QString &mimeType,
given mime type is not guaranteed even if the mime type is in general supported. In addition, in some
cases this function will need to load all available media plugins and query them for their support, which
may take some time.
\since 1.0
*/
QStringList QMediaPlayer::supportedMimeTypes(Flags flags)
{
@@ -737,7 +723,6 @@ QStringList QMediaPlayer::supportedMimeTypes(Flags flags)
If the media player has already video output attached,
it will be replaced with a new one.
\since 1.0
*/
void QMediaPlayer::setVideoOutput(QVideoWidget *output)
{
@@ -759,7 +744,6 @@ void QMediaPlayer::setVideoOutput(QVideoWidget *output)
If the media player has already video output attached,
it will be replaced with a new one.
\since 1.0
*/
void QMediaPlayer::setVideoOutput(QGraphicsVideoItem *output)
{
@@ -780,7 +764,6 @@ void QMediaPlayer::setVideoOutput(QGraphicsVideoItem *output)
If a video output has already been set on the media player the new surface
will replace it.
\since 1.2
*/
void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
@@ -850,14 +833,12 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
Signals that an \a error condition has occurred.
\since 1.0
\sa errorString()
*/
/*!
\fn void QMediaPlayer::stateChanged(State state)
\since 1.0
Signal the \a state of the Player object has changed.
*/
@@ -866,7 +847,6 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
Signals that the \a status of the current media has changed.
\since 1.0
\sa mediaStatus()
*/
@@ -875,7 +855,6 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
Signals that the current playing content will be obtained from \a media.
\since 1.0
\sa media()
*/
@@ -883,14 +862,12 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
\fn void QMediaPlayer::playbackRateChanged(qreal rate);
Signals the playbackRate has changed to \a rate.
\since 1.0
*/
/*!
\fn void QMediaPlayer::seekableChanged(bool seekable);
Signals the \a seekable status of the player object has changed.
\since 1.0
*/
// Properties
@@ -900,7 +877,6 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
By default this property is QMediaPlayer::Stopped
\since 1.0
\sa mediaStatus(), play(), pause(), stop()
*/
@@ -908,7 +884,6 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
\property QMediaPlayer::error
\brief a string describing the last error condition.
\since 1.0
\sa error()
*/
@@ -925,7 +900,6 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
information relating to the current media source and to cease all I/O operations related
to that media.
\since 1.0
\sa QMediaContent
*/
@@ -943,7 +917,6 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
QMediaPlaylist::setCurrentIndex(int) instead of QMediaPlayer::setMedia(),
otherwise the current playlist will be discarded.
\since 1.0
\sa QMediaContent
*/
@@ -957,7 +930,6 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
By default this property is QMediaPlayer::NoMedia
\since 1.0
\sa state
*/
@@ -969,7 +941,6 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
The value may change across the life time of the QMediaPlayer object and
may not be available when initial playback begins, connect to the
durationChanged() signal to receive status notifications.
\since 1.0
*/
/*!
@@ -980,7 +951,6 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
the beginning of the media. Periodically changes in the position will be
indicated with the signal positionChanged(), the interval between updates
can be set with QMediaObject's method setNotifyInterval().
\since 1.0
*/
/*!
@@ -989,7 +959,6 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
The playback volume is a linear in effect and the value can range from 0 -
100, values outside this range will be clamped.
\since 1.0
*/
/*!
@@ -997,7 +966,6 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
\brief the muted state of the current media.
The value will be true if the playback volume is muted; otherwise false.
\since 1.0
*/
/*!
@@ -1009,7 +977,6 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
filled before playback can resume, at which time the MediaStatus will be
BufferedMedia.
\since 1.0
\sa mediaStatus()
*/
@@ -1020,7 +987,6 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
As the life time of QMediaPlayer can be longer than the playback of one
QMediaContent, this property may change over time, the
audioAvailableChanged signal can be used to monitor it's status.
\since 1.0
*/
/*!
@@ -1032,7 +998,6 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
QMediaContent, this property may change over time, the
videoAvailableChanged signal can be used to monitor it's status.
\since 1.0
\sa QVideoWidget, QMediaContent
*/
@@ -1043,7 +1008,6 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
If seeking is supported this property will be true; false otherwise. The
status of this property may change across the life time of the QMediaPlayer
object, use the seekableChanged signal to monitor changes.
\since 1.0
*/
/*!
@@ -1059,14 +1023,12 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
Not all playback services support change of the playback rate. It is
framework defined as to the status and quality of audio and video
while fast forwarding or rewinding.
\since 1.0
*/
/*!
\fn void QMediaPlayer::durationChanged(qint64 duration)
Signal the duration of the content has changed to \a duration, expressed in milliseconds.
\since 1.0
*/
/*!
@@ -1074,49 +1036,42 @@ void QMediaPlayer::setVideoOutput(QAbstractVideoSurface *surface)
Signal the position of the content has changed to \a position, expressed in
milliseconds.
\since 1.0
*/
/*!
\fn void QMediaPlayer::volumeChanged(int volume)
Signal the playback volume has changed to \a volume.
\since 1.0
*/
/*!
\fn void QMediaPlayer::mutedChanged(bool muted)
Signal the mute state has changed to \a muted.
\since 1.0
*/
/*!
\fn void QMediaPlayer::videoAvailableChanged(bool videoAvailable)
Signal the availability of visual content has changed to \a videoAvailable.
\since 1.0
*/
/*!
\fn void QMediaPlayer::audioAvailableChanged(bool available)
Signals the availability of audio content has changed to \a available.
\since 1.0
*/
/*!
\fn void QMediaPlayer::bufferStatusChanged(int percentFilled)
Signal the amount of the local buffer filled as a percentage by \a percentFilled.
\since 1.0
*/
/*!
\fn void QMediaPlayer::networkConfigurationChanged(const QNetworkConfiguration &configuration)
Signal that the active in use network access point has been changed to \a configuration and all subsequent network access will use this \a configuration.
\since 1.2
*/
/*!

41
src/multimedia/playback/qmediaplaylist.cpp
View File

@@ -79,7 +79,6 @@ namespace
\class QMediaPlaylist
\inmodule QtMultimedia
\ingroup multimedia
\since 1.0
\brief The QMediaPlaylist class provides a list of media content to play.
@@ -151,7 +150,6 @@ QMediaPlaylist::~QMediaPlaylist()
/*!
Returns the QMediaObject instance that this QMediaPlaylist is bound too,
or 0 otherwise.
\since 1.0
*/
QMediaObject *QMediaPlaylist::mediaObject() const
{
@@ -162,7 +160,6 @@ QMediaObject *QMediaPlaylist::mediaObject() const
\internal
If \a mediaObject is null or doesn't have an intrinsic playlist,
internal local memory playlist source will be created.
\since 1.0
*/
bool QMediaPlaylist::setMediaObject(QMediaObject *mediaObject)
{
@@ -248,7 +245,6 @@ bool QMediaPlaylist::setMediaObject(QMediaObject *mediaObject)
This property defines the order, items in playlist are played.
\since 1.0
\sa QMediaPlaylist::PlaybackMode
*/
@@ -265,7 +261,6 @@ void QMediaPlaylist::setPlaybackMode(QMediaPlaylist::PlaybackMode mode)
/*!
Returns position of the current media content in the playlist.
\since 1.0
*/
int QMediaPlaylist::currentIndex() const
{
@@ -274,7 +269,6 @@ int QMediaPlaylist::currentIndex() const
/*!
Returns the current media content.
\since 1.0
*/
QMediaContent QMediaPlaylist::currentMedia() const
@@ -289,7 +283,6 @@ QMediaContent QMediaPlaylist::currentMedia() const
Returned value depends on the size of playlist, current position
and playback mode.
\since 1.0
\sa QMediaPlaylist::playbackMode
*/
int QMediaPlaylist::nextIndex(int steps) const
@@ -301,7 +294,6 @@ int QMediaPlaylist::nextIndex(int steps) const
Returns the index of the item, which would be current after calling previous()
\a steps times.
\since 1.0
\sa QMediaPlaylist::playbackMode
*/
@@ -314,7 +306,6 @@ int QMediaPlaylist::previousIndex(int steps) const
/*!
Returns the number of items in the playlist.
\since 1.0
\sa isEmpty()
*/
int QMediaPlaylist::mediaCount() const
@@ -325,7 +316,6 @@ int QMediaPlaylist::mediaCount() const
/*!
Returns true if the playlist contains no items; otherwise returns false.
\since 1.0
\sa mediaCount()
*/
bool QMediaPlaylist::isEmpty() const
@@ -336,7 +326,6 @@ bool QMediaPlaylist::isEmpty() const
/*!
Returns true if the playlist can be modified; otherwise returns false.
\since 1.0
\sa mediaCount()
*/
bool QMediaPlaylist::isReadOnly() const
@@ -346,7 +335,6 @@ bool QMediaPlaylist::isReadOnly() const
/*!
Returns the media content at \a index in the playlist.
\since 1.0
*/
QMediaContent QMediaPlaylist::media(int index) const
@@ -358,7 +346,6 @@ QMediaContent QMediaPlaylist::media(int index) const
Append the media \a content to the playlist.
Returns true if the operation is successful, otherwise return false.
\since 1.0
*/
bool QMediaPlaylist::addMedia(const QMediaContent &content)
{
@@ -369,7 +356,6 @@ bool QMediaPlaylist::addMedia(const QMediaContent &content)
Append multiple media content \a items to the playlist.
Returns true if the operation is successful, otherwise return false.
\since 1.0
*/
bool QMediaPlaylist::addMedia(const QList<QMediaContent> &items)
{
@@ -380,7 +366,6 @@ bool QMediaPlaylist::addMedia(const QList<QMediaContent> &items)
Insert the media \a content to the playlist at position \a pos.
Returns true if the operation is successful, otherwise false.
\since 1.0
*/
bool QMediaPlaylist::insertMedia(int pos, const QMediaContent &content)
@@ -392,7 +377,6 @@ bool QMediaPlaylist::insertMedia(int pos, const QMediaContent &content)
Insert multiple media content \a items to the playlist at position \a pos.
Returns true if the operation is successful, otherwise false.
\since 1.0
*/
bool QMediaPlaylist::insertMedia(int pos, const QList<QMediaContent> &items)
@@ -404,7 +388,6 @@ bool QMediaPlaylist::insertMedia(int pos, const QList<QMediaContent> &items)
Remove the item from the playlist at position \a pos.
Returns true if the operation is successful, otherwise return false.
\since 1.0
*/
bool QMediaPlaylist::removeMedia(int pos)
{
@@ -416,7 +399,6 @@ bool QMediaPlaylist::removeMedia(int pos)
Remove items in the playlist from \a start to \a end inclusive.
Returns true if the operation is successful, otherwise return false.
\since 1.0
*/
bool QMediaPlaylist::removeMedia(int start, int end)
{
@@ -428,7 +410,6 @@ bool QMediaPlaylist::removeMedia(int start, int end)
Remove all the items from the playlist.
Returns true if the operation is successful, otherwise return false.
\since 1.0
*/
bool QMediaPlaylist::clear()
{
@@ -462,7 +443,6 @@ bool QMediaPlaylistPrivate::writeItems(QMediaPlaylistWriter *writer)
QMediaPlaylist::loaded() signal is emitted if playlist was loaded successfully,
otherwise the playlist emits loadFailed().
\since 1.0
*/
void QMediaPlaylist::load(const QUrl &location, const char *format)
{
@@ -509,7 +489,6 @@ void QMediaPlaylist::load(const QUrl &location, const char *format)
QMediaPlaylist::loaded() signal is emitted if playlist was loaded successfully,
otherwise the playlist emits loadFailed().
\since 1.0
*/
void QMediaPlaylist::load(QIODevice * device, const char *format)
{
@@ -553,7 +532,6 @@ void QMediaPlaylist::load(QIODevice * device, const char *format)
otherwise format is guessed from location name.
Returns true if playlist was saved successfully, otherwise returns false.
\since 1.0
*/
bool QMediaPlaylist::save(const QUrl &location, const char *format)
{
@@ -580,7 +558,6 @@ bool QMediaPlaylist::save(const QUrl &location, const char *format)
Save playlist to QIODevice \a device using format \a format.
Returns true if playlist was saved successfully, otherwise returns false.
\since 1.0
*/
bool QMediaPlaylist::save(QIODevice * device, const char *format)
{
@@ -612,7 +589,6 @@ bool QMediaPlaylist::save(QIODevice * device, const char *format)
/*!
Returns the last error condition.
\since 1.0
*/
QMediaPlaylist::Error QMediaPlaylist::error() const
{
@@ -621,7 +597,6 @@ QMediaPlaylist::Error QMediaPlaylist::error() const
/*!
Returns the string describing the last error condition.
\since 1.0
*/
QString QMediaPlaylist::errorString() const
{
@@ -630,7 +605,6 @@ QString QMediaPlaylist::errorString() const
/*!
Shuffle items in the playlist.
\since 1.0
*/
void QMediaPlaylist::shuffle()
{
@@ -640,7 +614,6 @@ void QMediaPlaylist::shuffle()
/*!
Advance to the next media content in playlist.
\since 1.0
*/
void QMediaPlaylist::next()
{
@@ -649,7 +622,6 @@ void QMediaPlaylist::next()
/*!
Return to the previous media content in playlist.
\since 1.0
*/
void QMediaPlaylist::previous()
{
@@ -658,7 +630,6 @@ void QMediaPlaylist::previous()
/*!
Activate media content from playlist at position \a playlistPosition.
\since 1.0
*/
void QMediaPlaylist::setCurrentIndex(int playlistPosition)
@@ -671,7 +642,6 @@ void QMediaPlaylist::setCurrentIndex(int playlistPosition)
This signal is emitted after media has been inserted into the playlist.
The new items are those between \a start and \a end inclusive.
\since 1.0
*/
/*!
@@ -679,7 +649,6 @@ void QMediaPlaylist::setCurrentIndex(int playlistPosition)
This signal is emitted after media has been removed from the playlist.
The removed items are those between \a start and \a end inclusive.
\since 1.0
*/
/*!
@@ -687,68 +656,58 @@ void QMediaPlaylist::setCurrentIndex(int playlistPosition)
This signal is emitted after media has been changed in the playlist
between \a start and \a end positions inclusive.
\since 1.0
*/
/*!
\fn void QMediaPlaylist::currentIndexChanged(int position)
Signal emitted when playlist position changed to \a position.
\since 1.0
*/
/*!
\fn void QMediaPlaylist::playbackModeChanged(QMediaPlaylist::PlaybackMode mode)
Signal emitted when playback mode changed to \a mode.
\since 1.0
*/
/*!
\fn void QMediaPlaylist::mediaAboutToBeInserted(int start, int end)
Signal emitted when items are to be inserted at \a start and ending at \a end.
\since 1.0
*/
/*!
\fn void QMediaPlaylist::mediaAboutToBeRemoved(int start, int end)
Signal emitted when item are to be deleted at \a start and ending at \a end.
\since 1.0
*/
/*!
\fn void QMediaPlaylist::currentMediaChanged(const QMediaContent &content)
Signal emitted when current media changes to \a content.
\since 1.0
*/
/*!
\property QMediaPlaylist::currentIndex
\brief Current position.
\since 1.0
*/
/*!
\property QMediaPlaylist::currentMedia
\brief Current media content.
\since 1.0
*/
/*!
\fn QMediaPlaylist::loaded()
Signal emitted when playlist finished loading.
\since 1.0
*/
/*!
\fn QMediaPlaylist::loadFailed()
Signal emitted if failed to load playlist.
\since 1.0
*/
/*!

15
src/multimedia/playback/qmediaplaylistioplugin.cpp
View File

@@ -48,7 +48,6 @@ QT_BEGIN_NAMESPACE
\brief The QMediaPlaylistReader class provides an interface for reading a playlist file.
\inmodule QtMultimedia
\since 1.0
\sa QMediaPlaylistIOPlugin
*/
@@ -66,7 +65,6 @@ QMediaPlaylistReader::~QMediaPlaylistReader()
Identifies if a playlist reader has reached the end of its input.
Returns true if the reader has reached the end; and false otherwise.
\since 1.0
*/
/*!
@@ -75,14 +73,12 @@ QMediaPlaylistReader::~QMediaPlaylistReader()
Reads an item of media from a playlist file.
Returns the read media, or a null QMediaContent if no more media is available.
\since 1.0
*/
/*!
\fn QMediaPlaylistReader::close()
Closes a playlist reader's input device.
\since 1.0
*/
/*!
@@ -90,7 +86,6 @@ QMediaPlaylistReader::~QMediaPlaylistReader()
\brief The QMediaPlaylistWriter class provides an interface for writing a playlist file.
\since 1.0
\sa QMediaPlaylistIOPlugin
*/
@@ -107,20 +102,17 @@ QMediaPlaylistWriter::~QMediaPlaylistWriter()
Writes an item of \a media to a playlist file.
Returns true if the media was written successfully; and false otherwise.
\since 1.0
*/
/*!
\fn QMediaPlaylistWriter::close()
Finalizes the writing of a playlist and closes the output device.
\since 1.0
*/
/*!
\class QMediaPlaylistIOPlugin
\brief The QMediaPlaylistIOPlugin class provides an interface for media playlist I/O plug-ins.
\since 1.0
*/
/*!
@@ -144,7 +136,6 @@ QMediaPlaylistIOPlugin::~QMediaPlaylistIOPlugin()
Identifies if plug-in can read \a format data from an I/O \a device.
Returns true if the data can be read; and false otherwise.
\since 1.0
*/
/*!
@@ -153,7 +144,6 @@ QMediaPlaylistIOPlugin::~QMediaPlaylistIOPlugin()
Identifies if a plug-in can read \a format data from a URL \a location.
Returns true if the data can be read; and false otherwise.
\since 1.0
*/
/*!
@@ -162,14 +152,12 @@ QMediaPlaylistIOPlugin::~QMediaPlaylistIOPlugin()
Identifies if a plug-in can write \a format data to an I/O \a device.
Returns true if the data can be written; and false otherwise.
\since 1.0
*/
/*!
\fn QMediaPlaylistIOPlugin::keys() const
Returns a list of format keys supported by a plug-in.
\since 1.0
*/
/*!
@@ -178,7 +166,6 @@ QMediaPlaylistIOPlugin::~QMediaPlaylistIOPlugin()
Returns a new QMediaPlaylistReader which reads \a format data from an I/O \a device.
If the device is invalid or the format is unsupported this will return a null pointer.
\since 1.0
*/
/*!
@@ -187,7 +174,6 @@ QMediaPlaylistIOPlugin::~QMediaPlaylistIOPlugin()
Returns a new QMediaPlaylistReader which reads \a format data from a URL \a location.
If the location or the format is unsupported this will return a null pointer.
\since 1.0
*/
/*!
@@ -196,7 +182,6 @@ QMediaPlaylistIOPlugin::~QMediaPlaylistIOPlugin()
Returns a new QMediaPlaylistWriter which writes \a format data to an I/O \a device.
If the device is invalid or the format is unsupported this will return a null pointer.
\since 1.0
*/
#include "moc_qmediaplaylistioplugin.cpp"

23
src/multimedia/playback/qmediaplaylistnavigator.cpp
View File

@@ -196,7 +196,6 @@ int QMediaPlaylistNavigatorPrivate::previousItemPos(int steps) const
\brief The QMediaPlaylistNavigator class provides navigation for a media playlist.
\inmodule QtMultimedia
\ingroup multimedia
\since 1.0
\sa QMediaPlaylist, QMediaPlaylistProvider
*/
@@ -206,7 +205,6 @@ int QMediaPlaylistNavigatorPrivate::previousItemPos(int steps) const
Constructs a media playlist navigator for a \a playlist.
The \a parent is passed to QObject.
\since 1.0
*/
QMediaPlaylistNavigator::QMediaPlaylistNavigator(QMediaPlaylistProvider *playlist, QObject *parent)
: QObject(parent)
@@ -229,7 +227,6 @@ QMediaPlaylistNavigator::~QMediaPlaylistNavigator()
/*! \property QMediaPlaylistNavigator::playbackMode
Contains the playback mode.
\since 1.0
*/
QMediaPlaylist::PlaybackMode QMediaPlaylistNavigator::playbackMode() const
{
@@ -238,7 +235,6 @@ QMediaPlaylist::PlaybackMode QMediaPlaylistNavigator::playbackMode() const
/*!
Sets the playback \a mode.
\since 1.0
*/
void QMediaPlaylistNavigator::setPlaybackMode(QMediaPlaylist::PlaybackMode mode)
{
@@ -262,7 +258,6 @@ void QMediaPlaylistNavigator::setPlaybackMode(QMediaPlaylist::PlaybackMode mode)
/*!
Returns the playlist being navigated.
\since 1.0
*/
QMediaPlaylistProvider *QMediaPlaylistNavigator::playlist() const
@@ -272,7 +267,6 @@ QMediaPlaylistProvider *QMediaPlaylistNavigator::playlist() const
/*!
Sets the \a playlist to navigate.
\since 1.0
*/
void QMediaPlaylistNavigator::setPlaylist(QMediaPlaylistProvider *playlist)
{
@@ -314,7 +308,6 @@ void QMediaPlaylistNavigator::setPlaylist(QMediaPlaylistProvider *playlist)
Contains the media at the current position in the playlist.
\since 1.0
\sa currentIndex()
*/
@@ -328,7 +321,6 @@ QMediaContent QMediaPlaylistNavigator::currentItem() const
Returns the media that is \a steps positions ahead of the current
position in the playlist.
\since 1.0
\sa nextIndex()
*/
QMediaContent QMediaPlaylistNavigator::nextItem(int steps) const
@@ -340,7 +332,6 @@ QMediaContent QMediaPlaylistNavigator::nextItem(int steps) const
Returns the media that is \a steps positions behind the current
position in the playlist.
\since 1.0
\sa previousIndex()
*/
QMediaContent QMediaPlaylistNavigator::previousItem(int steps) const
@@ -350,7 +341,6 @@ QMediaContent QMediaPlaylistNavigator::previousItem(int steps) const
/*!
Returns the media at a \a position in the playlist.
\since 1.0
*/
QMediaContent QMediaPlaylistNavigator::itemAt(int position) const
{
@@ -363,7 +353,6 @@ QMediaContent QMediaPlaylistNavigator::itemAt(int position) const
If no media is current, the property contains -1.
\since 1.0
\sa nextIndex(), previousIndex()
*/
@@ -379,7 +368,6 @@ int QMediaPlaylistNavigator::currentIndex() const
If the position is beyond the end of the playlist, this value
returned is -1.
\since 1.0
\sa currentIndex(), previousIndex(), playbackMode()
*/
@@ -396,7 +384,6 @@ int QMediaPlaylistNavigator::nextIndex(int steps) const
If the position is prior to the beginning of the playlist this will
return -1.
\since 1.0
\sa currentIndex(), nextIndex(), playbackMode()
*/
int QMediaPlaylistNavigator::previousIndex(int steps) const
@@ -407,7 +394,6 @@ int QMediaPlaylistNavigator::previousIndex(int steps) const
/*!
Advances to the next item in the playlist.
\since 1.0
\sa previous(), jump(), playbackMode()
*/
void QMediaPlaylistNavigator::next()
@@ -425,7 +411,6 @@ void QMediaPlaylistNavigator::next()
/*!
Returns to the previous item in the playlist,
\since 1.0
\sa next(), jump(), playbackMode()
*/
void QMediaPlaylistNavigator::previous()
@@ -441,7 +426,6 @@ void QMediaPlaylistNavigator::previous()
/*!
Jumps to a new \a position in the playlist.
\since 1.0
*/
void QMediaPlaylistNavigator::jump(int position)
{
@@ -479,7 +463,6 @@ void QMediaPlaylistNavigator::jump(int position)
/*!
\internal
\since 1.0
*/
void QMediaPlaylistNavigatorPrivate::_q_mediaInserted(int start, int end)
{
@@ -496,7 +479,6 @@ void QMediaPlaylistNavigatorPrivate::_q_mediaInserted(int start, int end)
/*!
\internal
\since 1.0
*/
void QMediaPlaylistNavigatorPrivate::_q_mediaRemoved(int start, int end)
{
@@ -517,7 +499,6 @@ void QMediaPlaylistNavigatorPrivate::_q_mediaRemoved(int start, int end)
/*!
\internal
\since 1.0
*/
void QMediaPlaylistNavigatorPrivate::_q_mediaChanged(int start, int end)
{
@@ -539,28 +520,24 @@ void QMediaPlaylistNavigatorPrivate::_q_mediaChanged(int start, int end)
\fn QMediaPlaylistNavigator::activated(const QMediaContent &media)
Signals that the current \a media has changed.
\since 1.0
*/
/*!
\fn QMediaPlaylistNavigator::currentIndexChanged(int position)
Signals the \a position of the current media has changed.
\since 1.0
*/
/*!
\fn QMediaPlaylistNavigator::playbackModeChanged(QMediaPlaylist::PlaybackMode mode)
Signals that the playback \a mode has changed.
\since 1.0
*/
/*!
\fn QMediaPlaylistNavigator::surroundingItemsChanged()
Signals that media immediately surrounding the current position has changed.
\since 1.0
*/
#include "moc_qmediaplaylistnavigator.cpp"

23
src/multimedia/playback/qmediaplaylistprovider.cpp
View File

@@ -51,7 +51,6 @@ QT_BEGIN_NAMESPACE
\brief The QMediaPlaylistProvider class provides an abstract list of media.
\inmodule QtMultimedia
\since 1.0
\sa QMediaPlaylist
*/
@@ -84,7 +83,6 @@ QMediaPlaylistProvider::~QMediaPlaylistProvider()
\fn QMediaPlaylistProvider::mediaCount() const;
Returns the size of playlist.
\since 1.0
*/
/*!
@@ -93,7 +91,6 @@ QMediaPlaylistProvider::~QMediaPlaylistProvider()
Returns the media at \a index in the playlist.
If the index is invalid this will return a null media content.
\since 1.0
*/
@@ -105,7 +102,6 @@ QMediaPlaylistProvider::~QMediaPlaylistProvider()
Returns true if the provider supports the format and loading from the locations URL protocol,
otherwise this will return false.
\since 1.0
*/
bool QMediaPlaylistProvider::load(const QUrl &location, const char *format)
{
@@ -122,7 +118,6 @@ bool QMediaPlaylistProvider::load(const QUrl &location, const char *format)
Returns true if the provider supports the format and loading from an I/O device, otherwise this
will return false.
\since 1.0
*/
bool QMediaPlaylistProvider::load(QIODevice * device, const char *format)
{
@@ -136,7 +131,6 @@ bool QMediaPlaylistProvider::load(QIODevice * device, const char *format)
the writer will inspect the URL to guess the format.
Returns true if the playlist was saved successfully; and false otherwise.
\since 1.0
*/
bool QMediaPlaylistProvider::save(const QUrl &location, const char *format)
{
@@ -149,7 +143,6 @@ bool QMediaPlaylistProvider::save(const QUrl &location, const char *format)
Saves the contents of a playlist to an I/O \a device in the specified \a format.
Returns true if the playlist was saved successfully; and false otherwise.
\since 1.0
*/
bool QMediaPlaylistProvider::save(QIODevice * device, const char *format)
{
@@ -160,7 +153,6 @@ bool QMediaPlaylistProvider::save(QIODevice * device, const char *format)
/*!
Returns true if a playlist is read-only; otherwise returns false.
\since 1.0
*/
bool QMediaPlaylistProvider::isReadOnly() const
{
@@ -171,7 +163,6 @@ bool QMediaPlaylistProvider::isReadOnly() const
Append \a media to a playlist.
Returns true if the media was appended; and false otherwise.
\since 1.0
*/
bool QMediaPlaylistProvider::addMedia(const QMediaContent &media)
{
@@ -183,7 +174,6 @@ bool QMediaPlaylistProvider::addMedia(const QMediaContent &media)
Append multiple media \a items to a playlist.
Returns true if the media items were appended; and false otherwise.
\since 1.0
*/
bool QMediaPlaylistProvider::addMedia(const QList<QMediaContent> &items)
{
@@ -199,7 +189,6 @@ bool QMediaPlaylistProvider::addMedia(const QList<QMediaContent> &items)
Inserts \a media into a playlist at \a position.
Returns true if the media was inserted; and false otherwise.
\since 1.0
*/
bool QMediaPlaylistProvider::insertMedia(int position, const QMediaContent &media)
{
@@ -212,7 +201,6 @@ bool QMediaPlaylistProvider::insertMedia(int position, const QMediaContent &medi
Inserts multiple media \a items into a playlist at \a position.
Returns true if the media \a items were inserted; and false otherwise.
\since 1.0
*/
bool QMediaPlaylistProvider::insertMedia(int position, const QList<QMediaContent> &items)
{
@@ -229,7 +217,6 @@ bool QMediaPlaylistProvider::insertMedia(int position, const QList<QMediaContent
Removes the media at \a position from a playlist.
Returns true if the media was removed; and false otherwise.
\since 1.0
*/
bool QMediaPlaylistProvider::removeMedia(int position)
{
@@ -241,7 +228,6 @@ bool QMediaPlaylistProvider::removeMedia(int position)
Removes the media between the given \a start and \a end positions from a playlist.
Returns true if the media was removed; and false otherwise.
\since 1.0
*/
bool QMediaPlaylistProvider::removeMedia(int start, int end)
{
@@ -257,7 +243,6 @@ bool QMediaPlaylistProvider::removeMedia(int start, int end)
Removes all media from a playlist.
Returns true if the media was removed; and false otherwise.
\since 1.0
*/
bool QMediaPlaylistProvider::clear()
{
@@ -266,7 +251,6 @@ bool QMediaPlaylistProvider::clear()
/*!
Shuffles the contents of a playlist.
\since 1.0
*/
void QMediaPlaylistProvider::shuffle()
{
@@ -277,7 +261,6 @@ void QMediaPlaylistProvider::shuffle()
Signals that new media is about to be inserted into a playlist between the \a start and \a end
positions.
\since 1.0
*/
/*!
@@ -285,7 +268,6 @@ void QMediaPlaylistProvider::shuffle()
Signals that new media has been inserted into a playlist between the \a start and \a end
positions.
\since 1.0
*/
/*!
@@ -293,35 +275,30 @@ void QMediaPlaylistProvider::shuffle()
Signals that media is about to be removed from a playlist between the \a start and \a end
positions.
\since 1.0
*/
/*!
\fn void QMediaPlaylistProvider::mediaRemoved(int start, int end);
Signals that media has been removed from a playlist between the \a start and \a end positions.
\since 1.0
*/
/*!
\fn void QMediaPlaylistProvider::mediaChanged(int start, int end);
Signals that media in playlist between the \a start and \a end positions inclusive has changed.
\since 1.0
*/
/*!
\fn void QMediaPlaylistProvider::loaded()
Signals that a load() finished successfully.
\since 1.0
*/
/*!
\fn void QMediaPlaylistProvider::loadFailed(QMediaPlaylist::Error error, const QString& errorMessage)
Signals that a load failed() due to an \a error. The \a errorMessage provides more information.
\since 1.0
*/
#include "moc_qmediaplaylistprovider.cpp"

30
src/multimedia/playback/qmediaresource.cpp
View File

@@ -66,7 +66,6 @@ namespace
\brief The QMediaResource class provides a description of a media resource.
\inmodule QtMultimedia
\ingroup multimedia
\since 1.0
A media resource is composed of a \l {url()}{URL} containing the
location of the resource and a set of properties that describe the
@@ -104,7 +103,6 @@ QMediaResource::QMediaResource()
/*!
Constructs a media resource with the given \a mimeType from a \a url.
\since 1.0
*/
QMediaResource::QMediaResource(const QUrl &url, const QString &mimeType)
{
@@ -114,7 +112,6 @@ QMediaResource::QMediaResource(const QUrl &url, const QString &mimeType)
/*!
Constructs a media resource with the given \a mimeType from a network \a request.
\since 1.0
*/
QMediaResource::QMediaResource(const QNetworkRequest &request, const QString &mimeType)
{
@@ -125,7 +122,6 @@ QMediaResource::QMediaResource(const QNetworkRequest &request, const QString &mi
/*!
Constructs a copy of a media resource \a other.
\since 1.0
*/
QMediaResource::QMediaResource(const QMediaResource &other)
: values(other.values)
@@ -134,7 +130,6 @@ QMediaResource::QMediaResource(const QMediaResource &other)
/*!
Assigns the value of \a other to a media resource.
\since 1.0
*/
QMediaResource &QMediaResource::operator =(const QMediaResource &other)
{
@@ -155,7 +150,6 @@ QMediaResource::~QMediaResource()
Compares a media resource to \a other.
Returns true if the resources are identical, and false otherwise.
\since 1.0
*/
bool QMediaResource::operator ==(const QMediaResource &other) const
{
@@ -178,7 +172,6 @@ bool QMediaResource::operator ==(const QMediaResource &other) const
Compares a media resource to \a other.
Returns true if they are different, and false otherwise.
\since 1.0
*/
bool QMediaResource::operator !=(const QMediaResource &other) const
{
@@ -189,7 +182,6 @@ bool QMediaResource::operator !=(const QMediaResource &other) const
Identifies if a media resource is null.
Returns true if the resource is null, and false otherwise.
\since 1.0
*/
bool QMediaResource::isNull() const
{
@@ -198,7 +190,6 @@ bool QMediaResource::isNull() const
/*!
Returns the URL of a media resource.
\since 1.0
*/
QUrl QMediaResource::url() const
{
@@ -207,7 +198,6 @@ QUrl QMediaResource::url() const
/*!
Returns the network request associated with this media resource.
\since 1.0
*/
QNetworkRequest QMediaResource::request() const
{
@@ -221,7 +211,6 @@ QNetworkRequest QMediaResource::request() const
Returns the MIME type of a media resource.
This may be null if the MIME type is unknown.
\since 1.0
*/
QString QMediaResource::mimeType() const
{
@@ -232,7 +221,6 @@ QString QMediaResource::mimeType() const
Returns the language of a media resource as an ISO 639-2 code.
This may be null if the language is unknown.
\since 1.0
*/
QString QMediaResource::language() const
{
@@ -241,7 +229,6 @@ QString QMediaResource::language() const
/*!
Sets the \a language of a media resource.
\since 1.0
*/
void QMediaResource::setLanguage(const QString &language)
{
@@ -256,7 +243,6 @@ void QMediaResource::setLanguage(const QString &language)
This may be null if the media resource does not contain an audio stream, or the codec is
unknown.
\since 1.0
*/
QString QMediaResource::audioCodec() const
{
@@ -265,7 +251,6 @@ QString QMediaResource::audioCodec() const
/*!
Sets the audio \a codec of a media resource.
\since 1.0
*/
void QMediaResource::setAudioCodec(const QString &codec)
{
@@ -280,7 +265,6 @@ void QMediaResource::setAudioCodec(const QString &codec)
This may be null if the media resource does not contain a video stream, or the codec is
unknonwn.
\since 1.0
*/
QString QMediaResource::videoCodec() const
{
@@ -289,7 +273,6 @@ QString QMediaResource::videoCodec() const
/*!
Sets the video \a codec of media resource.
\since 1.0
*/
void QMediaResource::setVideoCodec(const QString &codec)
{
@@ -303,7 +286,6 @@ void QMediaResource::setVideoCodec(const QString &codec)
Returns the size in bytes of a media resource.
This may be zero if the size is unknown.
\since 1.0
*/
qint64 QMediaResource::dataSize() const
{
@@ -312,7 +294,6 @@ qint64 QMediaResource::dataSize() const
/*!
Sets the \a size in bytes of a media resource.
\since 1.0
*/
void QMediaResource::setDataSize(const qint64 size)
{
@@ -326,7 +307,6 @@ void QMediaResource::setDataSize(const qint64 size)
Returns the bit rate in bits per second of a media resource's audio stream.
This may be zero if the bit rate is unknown, or the resource contains no audio stream.
\since 1.0
*/
int QMediaResource::audioBitRate() const
{
@@ -335,7 +315,6 @@ int QMediaResource::audioBitRate() const
/*!
Sets the bit \a rate in bits per second of a media resource's video stream.
\since 1.0
*/
void QMediaResource::setAudioBitRate(int rate)
{
@@ -349,7 +328,6 @@ void QMediaResource::setAudioBitRate(int rate)
Returns the audio sample rate of a media resource.
This may be zero if the sample size is unknown, or the resource contains no audio stream.
\since 1.0
*/
int QMediaResource::sampleRate() const
{
@@ -358,7 +336,6 @@ int QMediaResource::sampleRate() const
/*!
Sets the audio \a sampleRate of a media resource.
\since 1.0
*/
void QMediaResource::setSampleRate(int sampleRate)
{
@@ -372,7 +349,6 @@ void QMediaResource::setSampleRate(int sampleRate)
Returns the number of audio channels in a media resource.
This may be zero if the sample size is unknown, or the resource contains no audio stream.
\since 1.0
*/
int QMediaResource::channelCount() const
{
@@ -381,7 +357,6 @@ int QMediaResource::channelCount() const
/*!
Sets the number of audio \a channels in a media resource.
\since 1.0
*/
void QMediaResource::setChannelCount(int channels)
{
@@ -395,7 +370,6 @@ void QMediaResource::setChannelCount(int channels)
Returns the bit rate in bits per second of a media resource's video stream.
This may be zero if the bit rate is unknown, or the resource contains no video stream.
\since 1.0
*/
int QMediaResource::videoBitRate() const
{
@@ -404,7 +378,6 @@ int QMediaResource::videoBitRate() const
/*!
Sets the bit \a rate in bits per second of a media resource's video stream.
\since 1.0
*/
void QMediaResource::setVideoBitRate(int rate)
{
@@ -419,7 +392,6 @@ void QMediaResource::setVideoBitRate(int rate)
This may be null is the resolution is unknown, or the resource contains no pixel data (i.e. the
resource is an audio stream.
\since 1.0
*/
QSize QMediaResource::resolution() const
{
@@ -428,7 +400,6 @@ QSize QMediaResource::resolution() const
/*!
Sets the \a resolution in pixels of a media resource.
\since 1.0
*/
void QMediaResource::setResolution(const QSize &resolution)
{
@@ -440,7 +411,6 @@ void QMediaResource::setResolution(const QSize &resolution)
/*!
Sets the \a width and \a height in pixels of a media resource.
\since 1.0
*/
void QMediaResource::setResolution(int width, int height)
{