26d8bedc39
We really don't need to bore the 99.9% of people who won't care. And it's certainly not more important than camera. Reviewed-by: Derick Hawcroft (cherry picked from commit 51e3a1bc45ffc2688fcd3949216aedda4c41bf81) Change-Id: I8add47e42c2c06bf5e16f406604a19531af6901e Reviewed-on: http://codereview.qt-project.org/5501 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Michael Goddard <michael.goddard@nokia.com>
415 lines
9.9 KiB
C++
415 lines
9.9 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
|
|
** All rights reserved.
|
|
** Contact: Nokia Corporation (qt-info@nokia.com)
|
|
**
|
|
** This file is part of the Qt Toolkit.
|
|
**
|
|
** $QT_BEGIN_LICENSE:LGPL$
|
|
** GNU Lesser General Public License Usage
|
|
** This file may be used under the terms of the GNU Lesser General Public
|
|
** License version 2.1 as published by the Free Software Foundation and
|
|
** appearing in the file LICENSE.LGPL included in the packaging of this
|
|
** file. Please review the following information to ensure the GNU Lesser
|
|
** General Public License version 2.1 requirements will be met:
|
|
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
|
**
|
|
** In addition, as a special exception, Nokia gives you certain additional
|
|
** rights. These rights are described in the Nokia Qt LGPL Exception
|
|
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU General
|
|
** Public License version 3.0 as published by the Free Software Foundation
|
|
** and appearing in the file LICENSE.GPL included in the packaging of this
|
|
** file. Please review the following information to ensure the GNU General
|
|
** Public License version 3.0 requirements will be met:
|
|
** http://www.gnu.org/copyleft/gpl.html.
|
|
**
|
|
** Other Usage
|
|
** Alternatively, this file may be used in accordance with the terms and
|
|
** conditions contained in a signed written agreement between you and Nokia.
|
|
**
|
|
**
|
|
**
|
|
**
|
|
**
|
|
** $QT_END_LICENSE$
|
|
**
|
|
****************************************************************************/
|
|
|
|
#include "qmediaplayercontrol.h"
|
|
#include "qmediacontrol_p.h"
|
|
#include "qmediaplayer.h"
|
|
|
|
QT_BEGIN_NAMESPACE
|
|
|
|
|
|
/*!
|
|
\class QMediaPlayerControl
|
|
\inmodule QtMultimediaKit
|
|
\ingroup multimedia-serv
|
|
\since 1.0
|
|
|
|
|
|
\brief The QMediaPlayerControl class provides access to the media playing
|
|
functionality of a QMediaService.
|
|
|
|
If a QMediaService can play media is will implement QMediaPlayerControl.
|
|
This control provides a means to set the \l {setMedia()}{media} to play,
|
|
\l {play()}{start}, \l {pause()} {pause} and \l {stop()}{stop} playback,
|
|
\l {setPosition()}{seek}, and control the \l {setVolume()}{volume}.
|
|
It also provides feedback on the \l {duration()}{duration} of the media,
|
|
the current \l {position()}{position}, and \l {bufferStatus()}{buffering}
|
|
progress.
|
|
|
|
The functionality provided by this control is exposed to application
|
|
code through the QMediaPlayer class.
|
|
|
|
The interface name of QMediaPlayerControl is \c com.nokia.Qt.QMediaPlayerControl/1.0 as
|
|
defined in QMediaPlayerControl_iid.
|
|
|
|
\sa QMediaService::requestControl(), QMediaPlayer
|
|
*/
|
|
|
|
/*!
|
|
\macro QMediaPlayerControl_iid
|
|
|
|
\c com.nokia.Qt.QMediaPlayerControl/1.0
|
|
|
|
Defines the interface name of the QMediaPlayerControl class.
|
|
|
|
\relates QMediaPlayerControl
|
|
*/
|
|
|
|
/*!
|
|
Destroys a media player control.
|
|
*/
|
|
QMediaPlayerControl::~QMediaPlayerControl()
|
|
{
|
|
}
|
|
|
|
/*!
|
|
Constructs a new media player control with the given \a parent.
|
|
*/
|
|
QMediaPlayerControl::QMediaPlayerControl(QObject *parent):
|
|
QMediaControl(*new QMediaControlPrivate, parent)
|
|
{
|
|
}
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::state() const
|
|
|
|
Returns the state of a player control.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::stateChanged(QMediaPlayer::State state)
|
|
|
|
Signals that the \a state of a player control has changed.
|
|
|
|
\since 1.0
|
|
\sa state()
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::mediaStatus() const
|
|
|
|
Returns the status of the current media.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::mediaStatusChanged(QMediaPlayer::MediaStatus status)
|
|
|
|
Signals that the \a status of the current media has changed.
|
|
|
|
\since 1.0
|
|
\sa mediaStatus()
|
|
*/
|
|
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::duration() const
|
|
|
|
Returns the duration of the current media in milliseconds.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::durationChanged(qint64 duration)
|
|
|
|
Signals that the \a duration of the current media has changed.
|
|
|
|
\since 1.0
|
|
\sa duration()
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::position() const
|
|
|
|
Returns the current playback position in milliseconds.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::setPosition(qint64 position)
|
|
|
|
Sets the playback \a position of the current media. This will initiate a seek and it may take
|
|
some time for playback to reach the position set.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::positionChanged(qint64 position)
|
|
|
|
Signals the playback \a position has changed.
|
|
|
|
This is only emitted in when there has been a discontinous change in the playback postion, such
|
|
as a seek or the position being reset.
|
|
|
|
\since 1.0
|
|
\sa position()
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::volume() const
|
|
|
|
Returns the audio volume of a player control.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::setVolume(int volume)
|
|
|
|
Sets the audio \a volume of a player control.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::volumeChanged(int volume)
|
|
|
|
Signals the audio \a volume of a player control has changed.
|
|
|
|
\since 1.0
|
|
\sa volume()
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::isMuted() const
|
|
|
|
Returns the mute state of a player control.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::setMuted(bool mute)
|
|
|
|
Sets the \a mute state of a player control.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::mutedChanged(bool mute)
|
|
|
|
Signals a change in the \a mute status of a player control.
|
|
|
|
\since 1.0
|
|
\sa isMuted()
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::bufferStatus() const
|
|
|
|
Returns the buffering progress of the current media. Progress is measured in the percentage
|
|
of the buffer filled.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::bufferStatusChanged(int progress)
|
|
|
|
Signals that buffering \a progress has changed.
|
|
|
|
\since 1.0
|
|
\sa bufferStatus()
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::isAudioAvailable() const
|
|
|
|
Identifies if there is audio output available for the current media.
|
|
|
|
Returns true if audio output is available and false otherwise.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::audioAvailableChanged(bool audio)
|
|
|
|
Signals that there has been a change in the availability of \a audio output.
|
|
|
|
\since 1.0
|
|
\sa isAudioAvailable()
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::isVideoAvailable() const
|
|
|
|
Identifies if there is video output available for the current media.
|
|
|
|
Returns true if video output is available and false otherwise.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::videoAvailableChanged(bool video)
|
|
|
|
Signals that there has been a change in the availability of \a video output.
|
|
|
|
\since 1.0
|
|
\sa isVideoAvailable()
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::isSeekable() const
|
|
|
|
Identifies if the current media is seekable.
|
|
|
|
Returns true if it possible to seek within the current media, and false otherwise.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::seekableChanged(bool seekable)
|
|
|
|
Signals that the \a seekable state of a player control has changed.
|
|
|
|
\since 1.0
|
|
\sa isSeekable()
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::availablePlaybackRanges() const
|
|
|
|
Returns a range of times in milliseconds that can be played back.
|
|
|
|
Usually for local files this is a continuous interval equal to [0..duration()]
|
|
or an empty time range if seeking is not supported, but for network sources
|
|
it refers to the buffered parts of the media.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::availablePlaybackRangesChanged(const QMediaTimeRange &ranges)
|
|
|
|
Signals that the available media playback \a ranges have changed.
|
|
|
|
\since 1.0
|
|
\sa QMediaPlayerControl::availablePlaybackRanges()
|
|
*/
|
|
|
|
/*!
|
|
\fn qreal QMediaPlayerControl::playbackRate() const
|
|
|
|
Returns the rate of playback.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::setPlaybackRate(qreal rate)
|
|
|
|
Sets the \a rate of playback.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::media() const
|
|
|
|
Returns the current media source.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::mediaStream() const
|
|
|
|
Returns the current media stream. This is only a valid if a stream was passed to setMedia().
|
|
|
|
\since 1.0
|
|
\sa setMedia()
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::setMedia(const QMediaContent &media, QIODevice *stream)
|
|
|
|
Sets the current \a media source. If a \a stream is supplied; data will be read from that
|
|
instead of attempting to resolve the media source. The media source may still be used to
|
|
supply media information such as mime type.
|
|
|
|
Setting the media to a null QMediaContent will cause the control to discard all
|
|
information relating to the current media source and to cease all I/O operations related
|
|
to that media.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::mediaChanged(const QMediaContent& content)
|
|
|
|
Signals that the current media \a content has changed.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::play()
|
|
|
|
Starts playback of the current media.
|
|
|
|
If successful the player control will immediately enter the \l {QMediaPlayer::PlayingState}
|
|
{playing} state.
|
|
|
|
\since 1.0
|
|
\sa state()
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::pause()
|
|
|
|
Pauses playback of the current media.
|
|
|
|
If sucessful the player control will immediately enter the \l {QMediaPlayer::PausedState}
|
|
{paused} state.
|
|
|
|
\since 1.0
|
|
\sa state(), play(), stop()
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::stop()
|
|
|
|
Stops playback of the current media.
|
|
|
|
If successful the player control will immediately enter the \l {QMediaPlayer::StoppedState}
|
|
{stopped} state.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::error(int error, const QString &errorString)
|
|
|
|
Signals that an \a error has occurred. The \a errorString provides a more detailed explanation.
|
|
\since 1.0
|
|
*/
|
|
|
|
/*!
|
|
\fn QMediaPlayerControl::playbackRateChanged(qreal rate)
|
|
|
|
Signal emitted when playback rate changes to \a rate.
|
|
\since 1.0
|
|
*/
|
|
|
|
#include "moc_qmediaplayercontrol.cpp"
|
|
QT_END_NAMESPACE
|
|
|