summaryrefslogtreecommitdiffstats
path: root/src/multimedia/qmediaplaylist.cpp
diff options
context:
space:
mode:
authorJustin McPherson <justin.mcpherson@nokia.com>2010-05-26 15:00:20 +1000
committerJustin McPherson <justin.mcpherson@nokia.com>2010-05-26 15:00:37 +1000
commitb6bedcfce424873bcbd14093e02903ee7834bc6f (patch)
tree8d0c4bf3588018c0715b7e42fdacc79b0f623a4d /src/multimedia/qmediaplaylist.cpp
parentde147cf31408edf301b5b1e322f25599e5306acd (diff)
Docs; minor fixes
Diffstat (limited to 'src/multimedia/qmediaplaylist.cpp')
-rw-r--r--src/multimedia/qmediaplaylist.cpp44
1 files changed, 23 insertions, 21 deletions
diff --git a/src/multimedia/qmediaplaylist.cpp b/src/multimedia/qmediaplaylist.cpp
index 447184d076..69e17b23d8 100644
--- a/src/multimedia/qmediaplaylist.cpp
+++ b/src/multimedia/qmediaplaylist.cpp
@@ -90,8 +90,8 @@ Q_GLOBAL_STATIC_WITH_ARGS(QMediaPluginLoader, playlistIOLoader,
player->play();
\endcode
- Depending on playlist source implementation,
- most of playlist modifcation operations can be asynchronous.
+ Depending on playlist source implementation, most of the playlist mutating
+ operations can be asynchronous.
\sa QMediaContent
*/
@@ -104,12 +104,12 @@ Q_GLOBAL_STATIC_WITH_ARGS(QMediaPluginLoader, playlistIOLoader,
\value CurrentItemOnce The current item is played only once.
- \value CurrentItemInLoop The current item is played in the loop.
+ \value CurrentItemInLoop The current item is played repeatedly in a loop.
- \value Sequential Playback starts from the current to the last items and stops.
- next item is a null item when the last one is currently playing.
+ \value Sequential Playback starts from the current and moves through each successive item until the last is reached and then stops.
+ The next item is a null item when the last one is currently playing.
- \value Loop Playback continues from the first item after the last one finished playing.
+ \value Loop Playback restarts at the first item after the last has finished playing.
\value Random Play items in random order.
*/
@@ -254,7 +254,7 @@ void QMediaPlaylist::setPlaybackMode(QMediaPlaylist::PlaybackMode mode)
}
/*!
- Returns position of the current media source in the playlist.
+ Returns position of the current media content in the playlist.
*/
int QMediaPlaylist::currentIndex() const
{
@@ -271,7 +271,7 @@ QMediaContent QMediaPlaylist::currentMedia() const
}
/*!
- Returns the index of item, which were current after calling next()
+ Returns the index of the item, which would be current after calling next()
\a steps times.
Returned value depends on the size of playlist, current position
@@ -285,7 +285,7 @@ int QMediaPlaylist::nextIndex(int steps) const
}
/*!
- Returns the index of item, which were current after calling previous()
+ Returns the index of the item, which would be current after calling previous()
\a steps times.
\sa QMediaPlaylist::playbackMode
@@ -309,6 +309,7 @@ int QMediaPlaylist::mediaCount() const
/*!
Returns true if the playlist contains no items; otherwise returns false.
+
\sa size()
*/
bool QMediaPlaylist::isEmpty() const
@@ -318,6 +319,7 @@ bool QMediaPlaylist::isEmpty() const
/*!
Returns true if the playlist can be modified; otherwise returns false.
+
\sa size()
*/
bool QMediaPlaylist::isReadOnly() const
@@ -337,7 +339,7 @@ QMediaContent QMediaPlaylist::media(int index) const
/*!
Append the media \a content to the playlist.
- Returns true if the operation is successfull, other wise return false.
+ Returns true if the operation is successful, otherwise return false.
*/
bool QMediaPlaylist::addMedia(const QMediaContent &content)
{
@@ -347,7 +349,7 @@ bool QMediaPlaylist::addMedia(const QMediaContent &content)
/*!
Append multiple media content \a items to the playlist.
- Returns true if the operation is successfull, other wise return false.
+ Returns true if the operation is successful, otherwise return false.
*/
bool QMediaPlaylist::addMedia(const QList<QMediaContent> &items)
{
@@ -379,7 +381,7 @@ 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 successfull, other wise return false.
+ Returns true if the operation is successful, otherwise return false.
*/
bool QMediaPlaylist::removeMedia(int pos)
{
@@ -388,9 +390,9 @@ bool QMediaPlaylist::removeMedia(int pos)
}
/*!
- Remove the items from the playlist from position \a start to \a end inclusive.
+ Remove items in the playlist from \a start to \a end inclusive.
- Returns true if the operation is successfull, other wise return false.
+ Returns true if the operation is successful, otherwise return false.
*/
bool QMediaPlaylist::removeMedia(int start, int end)
{
@@ -401,7 +403,7 @@ bool QMediaPlaylist::removeMedia(int start, int end)
/*!
Remove all the items from the playlist.
- Returns true if the operation is successfull, other wise return false.
+ Returns true if the operation is successful, otherwise return false.
*/
bool QMediaPlaylist::clear()
{
@@ -433,7 +435,7 @@ bool QMediaPlaylistPrivate::writeItems(QMediaPlaylistWriter *writer)
New items are appended to playlist.
- QMediaPlaylist::loaded() signal is emited if playlist was loaded succesfully,
+ QMediaPlaylist::loaded() signal is emitted if playlist was loaded successfully,
otherwise the playlist emits loadFailed().
*/
void QMediaPlaylist::load(const QUrl &location, const char *format)
@@ -479,7 +481,7 @@ void QMediaPlaylist::load(const QUrl &location, const char *format)
New items are appended to playlist.
- QMediaPlaylist::loaded() signal is emited if playlist was loaded succesfully,
+ QMediaPlaylist::loaded() signal is emitted if playlist was loaded successfully,
otherwise the playlist emits loadFailed().
*/
void QMediaPlaylist::load(QIODevice * device, const char *format)
@@ -523,7 +525,7 @@ void QMediaPlaylist::load(QIODevice * device, const char *format)
Save playlist to \a location. If \a format is specified, it is used,
otherwise format is guessed from location name.
- Returns true if playlist was saved succesfully, otherwise returns false.
+ Returns true if playlist was saved successfully, otherwise returns false.
*/
bool QMediaPlaylist::save(const QUrl &location, const char *format)
{
@@ -549,7 +551,7 @@ 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 succesfully, otherwise returns false.
+ Returns true if playlist was saved successfully, otherwise returns false.
*/
bool QMediaPlaylist::save(QIODevice * device, const char *format)
{
@@ -665,13 +667,13 @@ void QMediaPlaylist::setCurrentIndex(int playlistPosition)
/*!
\fn void QMediaPlaylist::mediaAboutToBeInserted(int start, int end)
- Signal emitted when item to be inserted at \a start and ending at \a end.
+ Signal emitted when items are to be inserted at \a start and ending at \a end.
*/
/*!
\fn void QMediaPlaylist::mediaAboutToBeRemoved(int start, int end)
- Signal emitted when item to de deleted ar \a start and ending at \a end.
+ Signal emitted when item are to be deleted at \a start and ending at \a end.
*/
/*!