/*!
\qmlclass Camera QDeclarativeCamera
- \since 4.7
\brief The Camera element allows you to add camera viewfinder to a scene.
\ingroup qml-multimedia
\inherits Item
/*!
\qmlclass CameraExposure QDeclarativeCameraExposure
- \since 5.0
\brief The CameraExposure element provides interface for exposure related camera settings.
\ingroup qml-multimedia
/*!
\qmlclass CameraFlash QDeclarativeCameraFlash
- \since 5.0
\brief The CameraFlash element provides interface for flash related camera settings.
\ingroup qml-multimedia
/*!
\qmlclass CameraFocus QDeclarativeCameraFocus
- \since 5.0
\brief The CameraFocus element provides interface for focus related camera settings.
\ingroup qml-multimedia
/*!
\qmlclass Radio QDeclarativeRadio
- \since 5.0.0
\brief The Radio element allows you to access radio functionality from a QML application.
\ingroup qml-multimedia
\inherits Item
/*!
\qmlclass RadioData QDeclarativeRadioData
- \since 5.0.0
\brief The RadioData element allows you to access RDS data from a QML application.
\ingroup qml-multimedia
\inherits Item
/*!
\qmlclass VideoOutput QDeclarativeVideoOutput
\brief The VideoOutput element allows you to render video or camera viewfinder.
- \since 5.0.0
\ingroup qml-multimedia
/*!
Constructs a copy of \a other.
- \since 1.0
*/
QAudioDeviceInfo::QAudioDeviceInfo(const QAudioDeviceInfo& other):
d(other.d)
/*!
Sets the QAudioDeviceInfo object to be equal to \a other.
- \since 1.0
*/
QAudioDeviceInfo& QAudioDeviceInfo::operator=(const QAudioDeviceInfo &other)
{
/*!
Returns whether this QAudioDeviceInfo object holds a device definition.
- \since 1.0
*/
bool QAudioDeviceInfo::isNull() const
{
They are a unique string identifier for the audio device.
eg. default, Intel, U0x46d0x9a4
- \since 1.0
*/
QString QAudioDeviceInfo::deviceName() const
{
/*!
Returns true if the supplied \a settings are supported by the audio
device described by this QAudioDeviceInfo.
- \since 1.0
*/
bool QAudioDeviceInfo::isFormatSupported(const QAudioFormat &settings) const
{
\o Input settings: 8000Hz mono 8 bit.
\o Output settings: 44100Hz stereo 16 bit little endian.
\endlist
- \since 1.0
*/
QAudioFormat QAudioDeviceInfo::preferredFormat() const
{
These settings are provided by the platform/audio plugin being used.
They are also dependent on the \l {QAudio}::Mode being used.
- \since 1.0
*/
QAudioFormat QAudioDeviceInfo::nearestFormat(const QAudioFormat &settings) const
{
For writing plugins to support additional codecs refer to:
http://www.iana.org/assignments/media-types/audio/
- \since 1.0
*/
QStringList QAudioDeviceInfo::supportedCodecs() const
{
/*!
Returns a list of supported sample rates (in Hertz).
- \since 1.0
*/
QList<int> QAudioDeviceInfo::supportedSampleRates() const
{
\obsolete
Use supportedSampleRates() instead.
- \since 1.0
*/
QList<int> QAudioDeviceInfo::supportedFrequencies() const
{
This is typically 1 for mono sound, or 2 for stereo sound.
- \since 1.0
*/
QList<int> QAudioDeviceInfo::supportedChannelCounts() const
{
\obsolete
Use supportedChannelCount() instead.
- \since 1.0
*/
QList<int> QAudioDeviceInfo::supportedChannels() const
{
Typically this will include 8 and 16 bit sample sizes.
- \since 1.0
*/
QList<int> QAudioDeviceInfo::supportedSampleSizes() const
{
/*!
Returns a list of supported byte orders.
- \since 1.0
*/
QList<QAudioFormat::Endian> QAudioDeviceInfo::supportedByteOrders() const
{
/*!
Returns a list of supported sample types.
- \since 1.0
*/
QList<QAudioFormat::SampleType> QAudioDeviceInfo::supportedSampleTypes() const
{
/*!
Returns the information for the default input audio device.
All platform and audio plugin implementations provide a default audio device to use.
- \since 1.0
*/
QAudioDeviceInfo QAudioDeviceInfo::defaultInputDevice()
{
/*!
Returns the information for the default output audio device.
All platform and audio plugin implementations provide a default audio device to use.
- \since 1.0
*/
QAudioDeviceInfo QAudioDeviceInfo::defaultOutputDevice()
{
/*!
Returns a list of audio devices that support \a mode.
- \since 1.0
*/
QList<QAudioDeviceInfo> QAudioDeviceInfo::availableDevices(QAudio::Mode mode)
{
/*!
\internal
- \since 1.0
*/
QAudioDeviceInfo::QAudioDeviceInfo(const QString &realm, const QByteArray &handle, QAudio::Mode mode):
d(new QAudioDeviceInfoPrivate(realm, handle, mode))
/*!
\internal
- \since 1.0
*/
QString QAudioDeviceInfo::realm() const
{
/*!
\internal
- \since 1.0
*/
QByteArray QAudioDeviceInfo::handle() const
{
/*!
\internal
- \since 1.0
*/
QAudio::Mode QAudioDeviceInfo::mode() const
{
\inmodule QtMultimedia
\ingroup multimedia
- \since 1.0
An audio format specifies how data in an audio stream is arranged,
i.e, how the stream is to be interpreted. The encoding itself is
/*!
Construct a new audio format using \a other.
- \since 1.0
*/
QAudioFormat::QAudioFormat(const QAudioFormat &other):
d(other.d)
/*!
Assigns \a other to this QAudioFormat implementation.
- \since 1.0
*/
QAudioFormat& QAudioFormat::operator=(const QAudioFormat &other)
{
QAudioFormat; otherwise returns false.
All elements of QAudioFormat are used for the comparison.
- \since 1.0
*/
bool QAudioFormat::operator==(const QAudioFormat &other) const
{
QAudioFormat; otherwise returns false.
All elements of QAudioFormat are used for the comparison.
- \since 1.0
*/
bool QAudioFormat::operator!=(const QAudioFormat& other) const
{
/*!
Returns true if all of the parameters are valid.
- \since 1.0
*/
bool QAudioFormat::isValid() const
{
/*!
Sets the sample rate to \a samplerate Hertz.
- \since 1.0
*/
void QAudioFormat::setSampleRate(int samplerate)
{
/*!
Returns the current sample rate in Hertz.
- \since 1.0
*/
int QAudioFormat::sampleRate() const
{
/*!
Sets the channel count to \a channels.
- \since 1.0
*/
void QAudioFormat::setChannelCount(int channels)
{
/*!
Returns the current channel count value.
- \since 1.0
*/
int QAudioFormat::channelCount() const
{
Sets the sample size to the \a sampleSize specified, in bits.
This is typically 8 or 16, but some systems may support higher sample sizes.
- \since 1.0
*/
void QAudioFormat::setSampleSize(int sampleSize)
{
/*!
Returns the current sample size value, in bits.
- \since 1.0
*/
int QAudioFormat::sampleSize() const
{
reported by the QAudioDeviceInfo::supportedCodecs() function
for the audio device you are working with.
- \since 1.0
\sa QAudioDeviceInfo::supportedCodecs()
*/
void QAudioFormat::setCodec(const QString &codec)
/*!
Returns the current codec identifier.
- \since 1.0
\sa QAudioDeviceInfo::supportedCodecs()
*/
QString QAudioFormat::codec() const
/*!
Sets the byteOrder to \a byteOrder.
- \since 1.0
*/
void QAudioFormat::setByteOrder(QAudioFormat::Endian byteOrder)
{
/*!
Returns the current byteOrder value.
- \since 1.0
*/
QAudioFormat::Endian QAudioFormat::byteOrder() const
{
/*!
Sets the sampleType to \a sampleType.
- \since 1.0
*/
void QAudioFormat::setSampleType(QAudioFormat::SampleType sampleType)
{
/*!
Returns the current SampleType value.
- \since 1.0
*/
QAudioFormat::SampleType QAudioFormat::sampleType() const
{
\inmodule QtMultimedia
\ingroup multimedia
- \since 1.0
You can construct an audio input with the system's
\l{QAudioDeviceInfo::defaultInputDevice()}{default audio input
Construct a new audio input and attach it to \a parent.
The default audio input device is used with the output
\a format parameters.
- \since 1.0
*/
QAudioInput::QAudioInput(const QAudioFormat &format, QObject *parent):
Construct a new audio input and attach it to \a parent.
The device referenced by \a audioDevice is used with the input
\a format parameters.
- \since 1.0
*/
QAudioInput::QAudioInput(const QAudioDeviceInfo &audioDevice, const QAudioFormat &format, QObject *parent):
If a problem occurs during this process the error() is set to QAudio::OpenError,
state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
- \since 1.0
\sa QIODevice
*/
If a problem occurs during this process the error() is set to QAudio::OpenError,
state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
- \since 1.0
\sa QIODevice
*/
/*!
Returns the QAudioFormat being used.
- \since 1.0
*/
QAudioFormat QAudioInput::format() const
Sets error() to QAudio::NoError, state() to QAudio::StoppedState and
emit stateChanged() signal.
- \since 1.0
*/
void QAudioInput::stop()
/*!
Drops all audio data in the buffers, resets buffers to zero.
- \since 1.0
*/
void QAudioInput::reset()
Sets error() to QAudio::NoError, state() to QAudio::SuspendedState and
emit stateChanged() signal.
- \since 1.0
*/
void QAudioInput::suspend()
Sets state() to QAudio::ActiveState if you previously called start(QIODevice*).
Sets state() to QAudio::IdleState if you previously called start().
emits stateChanged() signal.
- \since 1.0
*/
void QAudioInput::resume()
set is the actual buffer size used, calling bufferSize() anytime after start()
will return the actual buffer size being used.
- \since 1.0
*/
void QAudioInput::setBufferSize(int value)
If called after start(), returns the actual buffer size being used. This may not be what was set previously
by setBufferSize().
- \since 1.0
*/
int QAudioInput::bufferSize() const
NOTE: returned value is only valid while in QAudio::ActiveState or QAudio::IdleState
state, otherwise returns zero.
- \since 1.0
*/
int QAudioInput::bytesReady() const
Returns the period size in bytes.
Note: This is the recommended read size in bytes.
- \since 1.0
*/
int QAudioInput::periodSize() const
The minimum resolution of the timer is platform specific and values
should be checked with notifyInterval() to confirm actual value
being used.
- \since 1.0
*/
void QAudioInput::setNotifyInterval(int ms)
/*!
Returns the notify interval in milliseconds.
- \since 1.0
*/
int QAudioInput::notifyInterval() const
/*!
Returns the amount of audio data processed since start()
was called in microseconds.
- \since 1.0
*/
qint64 QAudioInput::processedUSecs() const
/*!
Returns the microseconds since start() was called, including time in Idle and
Suspend states.
- \since 1.0
*/
qint64 QAudioInput::elapsedUSecs() const
/*!
Returns the error state.
- \since 1.0
*/
QAudio::Error QAudioInput::error() const
/*!
Returns the state of audio processing.
- \since 1.0
*/
QAudio::State QAudioInput::state() const
/*!
\fn QAudioInput::stateChanged(QAudio::State state)
This signal is emitted when the device \a state has changed.
- \since 1.0
*/
/*!
\fn QAudioInput::notify()
This signal is emitted when x ms of audio data has been processed
the interval set by setNotifyInterval(x).
- \since 1.0
*/
QT_END_NAMESPACE
\inmodule QtMultimedia
\ingroup multimedia
- \since 1.0
You can construct an audio output with the system's
\l{QAudioDeviceInfo::defaultOutputDevice()}{default audio output
Construct a new audio output and attach it to \a parent.
The default audio output device is used with the output
\a format parameters.
- \since 1.0
*/
QAudioOutput::QAudioOutput(const QAudioFormat &format, QObject *parent):
QObject(parent)
Construct a new audio output and attach it to \a parent.
The device referenced by \a audioDevice is used with the output
\a format parameters.
- \since 1.0
*/
QAudioOutput::QAudioOutput(const QAudioDeviceInfo &audioDevice, const QAudioFormat &format, QObject *parent):
QObject(parent)
/*!
Returns the QAudioFormat being used.
- \since 1.0
*/
QAudioFormat QAudioOutput::format() const
{
If a problem occurs during this process the error() is set to QAudio::OpenError,
state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
- \since 1.0
\sa QIODevice
*/
void QAudioOutput::start(QIODevice* device)
If a problem occurs during this process the error() is set to QAudio::OpenError,
state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
- \since 1.0
\sa QIODevice
*/
QIODevice* QAudioOutput::start()
Sets error() to QAudio::NoError, state() to QAudio::StoppedState and
emit stateChanged() signal.
- \since 1.0
*/
void QAudioOutput::stop()
{
/*!
Drops all audio data in the buffers, resets buffers to zero.
- \since 1.0
*/
void QAudioOutput::reset()
{
Sets error() to QAudio::NoError, state() to QAudio::SuspendedState and
emits stateChanged() signal.
- \since 1.0
*/
void QAudioOutput::suspend()
{
Sets state() to QAudio::ActiveState if you previously called start(QIODevice*).
Sets state() to QAudio::IdleState if you previously called start().
emits stateChanged() signal.
- \since 1.0
*/
void QAudioOutput::resume()
{
\note The returned value is only valid while in QAudio::ActiveState or QAudio::IdleState
state, otherwise returns zero.
- \since 1.0
*/
int QAudioOutput::bytesFree() const
{
\note It is recommended to provide at least enough data for a full period with each
write operation.
- \since 1.0
*/
int QAudioOutput::periodSize() const
{
are ignored after start(). It should not be assumed that the buffer size
set is the actual buffer size used - call bufferSize() anytime after start()
to return the actual buffer size being used.
- \since 1.0
*/
void QAudioOutput::setBufferSize(int value)
{
If called after start(), returns the actual buffer size being used. This may not be what was set previously
by setBufferSize().
- \since 1.0
*/
int QAudioOutput::bufferSize() const
{
The minimum resolution of the timer is platform specific and values
should be checked with notifyInterval() to confirm the actual value
being used.
- \since 1.0
*/
void QAudioOutput::setNotifyInterval(int ms)
{
/*!
Returns the notify interval in milliseconds.
- \since 1.0
*/
int QAudioOutput::notifyInterval() const
{
/*!
Returns the amount of audio data processed since start()
was called (in microseconds).
- \since 1.0
*/
qint64 QAudioOutput::processedUSecs() const
{
/*!
Returns the microseconds since start() was called, including time in Idle and
Suspend states.
- \since 1.0
*/
qint64 QAudioOutput::elapsedUSecs() const
{
/*!
Returns the error state.
- \since 1.0
*/
QAudio::Error QAudioOutput::error() const
{
/*!
Returns the state of audio processing.
- \since 1.0
*/
QAudio::State QAudioOutput::state() const
{
/*!
Sets the volume.
Where \a volume is between 0.0 and 1.0 inclusive.
- \since 5.0
*/
void QAudioOutput::setVolume(qreal volume)
{
/*!
Returns the volume between 0.0 and 1.0 inclusive.
- \since 5.0
*/
qreal QAudioOutput::volume() const
{
\fn QAudioOutput::stateChanged(QAudio::State state)
This signal is emitted when the device \a state has changed.
This is the current state of the audio output.
- \since 1.0
*/
/*!
This signal is emitted when a certain interval of milliseconds
of audio data has been processed. The interval is set by
setNotifyInterval().
- \since 1.0
*/
QT_END_NAMESPACE
\ingroup multimedia
\inmodule QtMultimedia
\internal
- \since 1.0
This class implements the audio functionality for
QAudioDeviceInfo, i.e., QAudioDeviceInfo keeps a
/*!
\fn virtual QAudioFormat QAbstractAudioDeviceInfo::preferredFormat() const
Returns the recommended settings to use.
- \since 1.0
*/
/*!
\fn virtual bool QAbstractAudioDeviceInfo::isFormatSupported(const QAudioFormat& format) const
Returns true if \a format is available from audio device.
- \since 1.0
*/
/*!
\fn virtual QString QAbstractAudioDeviceInfo::deviceName() const
Returns the audio device name.
- \since 1.0
*/
/*!
\fn virtual QStringList QAbstractAudioDeviceInfo::supportedCodecs()
Returns the list of currently available codecs.
- \since 1.0
*/
/*!
\fn virtual QList<int> QAbstractAudioDeviceInfo::supportedSampleRates()
Returns the list of currently available sample rates.
- \since 1.0
*/
/*!
\fn virtual QList<int> QAbstractAudioDeviceInfo::supportedChannelCounts()
Returns the list of currently available channels.
- \since 1.0
*/
/*!
\fn virtual QList<int> QAbstractAudioDeviceInfo::supportedSampleSizes()
Returns the list of currently available sample sizes.
- \since 1.0
*/
/*!
\fn virtual QList<QAudioFormat::Endian> QAbstractAudioDeviceInfo::supportedByteOrders()
Returns the list of currently available byte orders.
- \since 1.0
*/
/*!
\fn virtual QList<QAudioFormat::SampleType> QAbstractAudioDeviceInfo::supportedSampleTypes()
Returns the list of currently available sample types.
- \since 1.0
*/
/*!
\class QAbstractAudioOutput
\brief The QAbstractAudioOutput class is a base class for audio backends.
- \since 1.0
\ingroup multimedia
\inmodule QtMultimedia
/*!
\fn virtual void QAbstractAudioOutput::start(QIODevice* device)
Uses the \a device as the QIODevice to transfer data.
- \since 1.0
*/
/*!
\fn virtual QIODevice* QAbstractAudioOutput::start()
Returns a pointer to the QIODevice being used to handle
the data transfer. This QIODevice can be used to write() audio data directly.
- \since 1.0
*/
/*!
\fn virtual void QAbstractAudioOutput::stop()
Stops the audio output.
- \since 1.0
*/
/*!
\fn virtual void QAbstractAudioOutput::reset()
Drops all audio data in the buffers, resets buffers to zero.
- \since 1.0
*/
/*!
\fn virtual void QAbstractAudioOutput::suspend()
Stops processing audio data, preserving buffered audio data.
- \since 1.0
*/
/*!
\fn virtual void QAbstractAudioOutput::resume()
Resumes processing audio data after a suspend()
- \since 1.0
*/
/*!
\fn virtual int QAbstractAudioOutput::bytesFree() const
Returns the free space available in bytes in the audio buffer.
- \since 1.0
*/
/*!
\fn virtual int QAbstractAudioOutput::periodSize() const
Returns the period size in bytes.
- \since 1.0
*/
/*!
\fn virtual void QAbstractAudioOutput::setBufferSize(int value)
Sets the audio buffer size to \a value in bytes.
- \since 1.0
*/
/*!
\fn virtual int QAbstractAudioOutput::bufferSize() const
Returns the audio buffer size in bytes.
- \since 1.0
*/
/*!
Sets the interval for notify() signal to be emitted. This is based on the \a ms
of audio data processed not on actual real-time. The resolution of the timer
is platform specific.
- \since 1.0
*/
/*!
\fn virtual int QAbstractAudioOutput::notifyInterval() const
Returns the notify interval in milliseconds.
- \since 1.0
*/
/*!
\fn virtual qint64 QAbstractAudioOutput::processedUSecs() const
Returns the amount of audio data processed since start() was called in milliseconds.
- \since 1.0
*/
/*!
\fn virtual qint64 QAbstractAudioOutput::elapsedUSecs() const
Returns the milliseconds since start() was called, including time in Idle and suspend states.
- \since 1.0
*/
/*!
\fn virtual QAudio::Error QAbstractAudioOutput::error() const
Returns the error state.
- \since 1.0
*/
/*!
\fn virtual QAudio::State QAbstractAudioOutput::state() const
Returns the state of audio processing.
- \since 1.0
*/
/*!
\fn virtual void QAbstractAudioOutput::setFormat(const QAudioFormat& fmt)
Set the QAudioFormat to use to \a fmt.
Setting the format is only allowable while in QAudio::StoppedState.
- \since 1.0
*/
/*!
\fn virtual QAudioFormat QAbstractAudioOutput::format() const
Returns the QAudioFormat being used.
- \since 1.0
*/
/*!
\fn virtual void QAbstractAudioOutput::setVolume(qreal volume)
Sets the volume.
Where \a volume is between 0.0 and 1.0.
- \since 5.0
*/
/*!
\fn virtual qreal QAbstractAudioOutput::volume() const
Returns the volume in the range 0.0 and 1.0.
- \since 5.0
*/
/*!
\fn QAbstractAudioOutput::errorChanged(QAudio::Error error)
This signal is emitted when the \a error state has changed.
- \since 1.0
*/
/*!
\fn QAbstractAudioOutput::stateChanged(QAudio::State state)
This signal is emitted when the device \a state has changed.
- \since 1.0
*/
/*!
\fn QAbstractAudioOutput::notify()
This signal is emitted when x ms of audio data has been processed
the interval set by setNotifyInterval(x).
- \since 1.0
*/
\class QAbstractAudioInput
\brief The QAbstractAudioInput class provides access for QAudioInput to access the audio
device provided by the plugin.
- \since 1.0
\ingroup multimedia
\inmodule QtMultimedia
/*!
\fn virtual void QAbstractAudioInput::start(QIODevice* device)
Uses the \a device as the QIODevice to transfer data.
- \since 1.0
*/
/*!
\fn virtual QIODevice* QAbstractAudioInput::start()
Returns a pointer to the QIODevice being used to handle
the data transfer. This QIODevice can be used to read() audio data directly.
- \since 1.0
*/
/*!
\fn virtual void QAbstractAudioInput::stop()
Stops the audio input.
- \since 1.0
*/
/*!
\fn virtual void QAbstractAudioInput::reset()
Drops all audio data in the buffers, resets buffers to zero.
- \since 1.0
*/
/*!
\fn virtual void QAbstractAudioInput::suspend()
Stops processing audio data, preserving buffered audio data.
- \since 1.0
*/
/*!
\fn virtual void QAbstractAudioInput::resume()
Resumes processing audio data after a suspend().
- \since 1.0
*/
/*!
\fn virtual int QAbstractAudioInput::bytesReady() const
Returns the amount of audio data available to read in bytes.
- \since 1.0
*/
/*!
\fn virtual int QAbstractAudioInput::periodSize() const
Returns the period size in bytes.
- \since 1.0
*/
/*!
\fn virtual void QAbstractAudioInput::setBufferSize(int value)
Sets the audio buffer size to \a value in milliseconds.
- \since 1.0
*/
/*!
\fn virtual int QAbstractAudioInput::bufferSize() const
Returns the audio buffer size in milliseconds.
- \since 1.0
*/
/*!
Sets the interval for notify() signal to be emitted. This is based
on the \a ms of audio data processed not on actual real-time.
The resolution of the timer is platform specific.
- \since 1.0
*/
/*!
\fn virtual int QAbstractAudioInput::notifyInterval() const
Returns the notify interval in milliseconds.
- \since 1.0
*/
/*!
\fn virtual qint64 QAbstractAudioInput::processedUSecs() const
Returns the amount of audio data processed since start() was called in milliseconds.
- \since 1.0
*/
/*!
\fn virtual qint64 QAbstractAudioInput::elapsedUSecs() const
Returns the milliseconds since start() was called, including time in Idle and suspend states.
- \since 1.0
*/
/*!
\fn virtual QAudio::Error QAbstractAudioInput::error() const
Returns the error state.
- \since 1.0
*/
/*!
\fn virtual QAudio::State QAbstractAudioInput::state() const
Returns the state of audio processing.
- \since 1.0
*/
/*!
\fn virtual void QAbstractAudioInput::setFormat(const QAudioFormat& fmt)
Set the QAudioFormat to use to \a fmt.
Setting the format is only allowable while in QAudio::StoppedState.
- \since 1.0
*/
/*!
\fn virtual QAudioFormat QAbstractAudioInput::format() const
Returns the QAudioFormat being used
- \since 1.0
*/
/*!
\fn QAbstractAudioInput::errorChanged(QAudio::Error error)
This signal is emitted when the \a error state has changed.
- \since 1.0
*/
/*!
\fn QAbstractAudioInput::stateChanged(QAudio::State state)
This signal is emitted when the device \a state has changed.
- \since 1.0
*/
/*!
\fn QAbstractAudioInput::notify()
This signal is emitted when x ms of audio data has been processed
the interval set by setNotifyInterval(x).
- \since 1.0
*/
/*!
\class QAudioSystemPlugin
\brief The QAudioSystemPlugin class provides an abstract base for audio plugins.
- \since 1.0
\ingroup multimedia
\inmodule QtMultimedia
/*!
\fn QStringList QAudioSystemPlugin::keys() const
Returns the list of device identifiers this plugin supports.
- \since 1.0
*/
/*!
\fn QList<QByteArray> QAudioSystemPlugin::availableDevices(QAudio::Mode mode) const
Returns a list of available audio devices for \a mode
- \since 1.0
*/
/*!
\fn QAbstractAudioInput* QAudioSystemPlugin::createInput(const QByteArray& device)
Returns a pointer to a QAbstractAudioInput created using \a device identifier
- \since 1.0
*/
/*!
\fn QAbstractAudioOutput* QAudioSystemPlugin::createOutput(const QByteArray& device)
Returns a pointer to a QAbstractAudioOutput created using \a device identifier
- \since 1.0
*/
/*!
\fn QAbstractAudioDeviceInfo* QAudioSystemPlugin::createDeviceInfo(const QByteArray& device, QAudio::Mode mode)
Returns a pointer to a QAbstractAudioDeviceInfo created using \a device and \a mode
- \since 1.0
*/
When you want to get a sound sample data, you need to request the QSample reference from QSampleCache.
- \since 1.1
\code
QSample *m_sample; // class member.
/*!
Plays the sound stored in the file specified by the given \a filename.
- \since 5.0
\sa stop(), loopsRemaining(), isFinished()
*/
void QSound::play(const QString& filename)
Constructs a QSound object from the file specified by the given \a
filename and with the given \a parent.
- \since 5.0
\sa play()
*/
QSound::QSound(const QString& filename, QObject* parent)
the stop() function is called before the sound object is
destroyed.
- \since 5.0
\sa stop(), isFinished()
*/
QSound::~QSound()
sound. The sound can be played again at any time, possibly mixing
or replacing previous plays of the sound.
- \since 5.0
\sa fileName()
*/
void QSound::play()
Returns the number of times the sound will play.
Return value of \c QSound::Infinite indicates infinite number of loops
- \since 5.0
\sa loopsRemaining(), setLoops()
*/
int QSound::loops() const
positive values this value decreases each time the sound is played).
Return value of \c QSound::Infinite indicates infinite number of loops
- \since 5.0
\sa loops(), isFinished()
*/
int QSound::loopsRemaining() const
Note that passing the value \c QSound::Infinite will cause the sound to loop
indefinitely.
- \since 5.0
\sa loops()
*/
void QSound::setLoops(int n)
/*!
Returns the filename associated with this QSound object.
- \since 5.0
\sa QSound()
*/
QString QSound::fileName() const
/*!
Stops the sound playing.
- \since 5.0
\sa play()
*/
void QSound::stop()
/*!
\internal
- \since 5.0
*/
void QSound::deleteOnComplete()
{
/*!
\qmlclass SoundEffect QSoundEffect
\brief The SoundEffect element provides a way to play sound effects in QML.
- \since 1.0
\inmodule QtMultimedia
/*!
\qmlproperty url SoundEffect::source
- \since 1.0
This property provides a way to control the sound to play.
*/
/*!
\qmlproperty int SoundEffect::loops
- \since 1.0
This property provides a way to control the number of times to repeat the sound on each play().
/*!
\qmlproperty qreal SoundEffect::volume
- \since 1.0
This property holds the volume of the playback, from 0.0 (silent) to 1.0 (maximum volume).
Note: Currently this has no effect on Mac OS X.
/*!
\qmlproperty bool SoundEffect::muted
- \since 1.0
This property provides a way to control muting.
*/
/*!
\qmlproperty bool SoundEffect::playing
- \since 1.1
This property indicates if the soundeffect is playing or not.
*/
/*!
\qmlproperty int SoundEffect::status
- \since 1.0
This property indicates the following status of the soundeffect.
/*!
\qmlsignal SoundEffect::sourceChanged()
- \since 1.0
This handler is called when the source has changed.
*/
/*!
\qmlsignal SoundEffect::loopCountChanged()
- \since 1.0
This handler is called when the initial number of loops has changed.
*/
/*!
\qmlsignal SoundEffect::loopsRemainingChanged()
- \since 1.0
This handler is called when the remaining number of loops has changed.
*/
/*!
\qmlsignal SoundEffect::volumeChanged()
- \since 1.0
This handler is called when the volume has changed.
*/
/*!
\qmlsignal SoundEffect::mutedChanged()
- \since 1.0
This handler is called when the mute state has changed.
*/
/*!
\qmlsignal SoundEffect::playingChanged()
- \since 1.0
This handler is called when the playing property has changed.
*/
\qmlsignal SoundEffect::statusChanged()
This handler is called when the status property has changed.
- \since 1.0
*/
/*!
- \since 1.0
*/
QSoundEffect::QSoundEffect(QObject *parent) :
This is the default method for SoundEffect.
\snippet doc/src/snippets/multimedia-snippets/soundeffect.qml play sound on click
- \since 1.0
*/
void QSoundEffect::play()
{
Note that if the backend is PulseAudio, due to the limitation of the underlying API,
tis stop will only prevent next looping but will not be able to stop current playback immediately.
- \since 1.0
*/
void QSoundEffect::stop()
{
\inmodule QtMultimedia
\ingroup camera
- \since 1.1
QCamera can be used with QVideoWidget for viewfinder display,
QMediaRecorder for video recording and QCameraImageCapture for image taking.
/*!
Return true if the camera service is ready to use.
- \since 1.1
*/
bool QCamera::isAvailable() const
{
/*!
Returns the error state of the camera service.
- \since 1.1
*/
QtMultimedia::AvailabilityError QCamera::availabilityError() const
/*!
Returns the camera exposure control object.
- \since 1.1
*/
QCameraExposure *QCamera::exposure() const
{
/*!
Returns the camera focus control object.
- \since 1.1
*/
QCameraFocus *QCamera::focus() const
{
/*!
Returns the camera image processing control object.
- \since 1.1
*/
QCameraImageProcessing *QCamera::imageProcessing() const
{
/*!
Sets the QVideoWidget based camera \a viewfinder.
The previously set viewfinder is detached.
- \since 1.1
*/
// QVideoWidget is forward declared
/*!
Sets the QGraphicsVideoItem based camera \a viewfinder.
The previously set viewfinder is detached.
- \since 1.1
*/
// QGraphicsVideoItem is forward declared
void QCamera::setViewfinder(QGraphicsVideoItem *viewfinder)
If a viewfinder has already been set on the camera the new surface
will replace it.
- \since 1.2
*/
void QCamera::setViewfinder(QAbstractVideoSurface *surface)
/*!
Returns the error state of the object.
- \since 1.1
*/
QCamera::Error QCamera::error() const
/*!
Returns a string describing a camera's error state.
- \since 1.1
*/
QString QCamera::errorString() const
{
/*!
Returns true if the capture \a mode is suported.
- \since 1.1
*/
bool QCamera::isCaptureModeSupported(QCamera::CaptureMode mode) const
{
chaging capture mode is likely to lead to camera status
chaged to QCamera::LoadedStatus, QCamera::LoadingStatus,
and when the camera is ready to QCamera::ActiveStatus.
- \since 1.1
*/
QCamera::CaptureMode QCamera::captureMode() const
While the camera state is changed to QCamera::ActiveState,
starting the camera service can be asynchronous with the actual
status reported with QCamera::status property.
- \since 1.1
*/
void QCamera::start()
{
/*!
Stops the camera.
The camera state is changed from QCamera::ActiveState to QCamera::LoadedState.
- \since 1.1
*/
void QCamera::stop()
{
In all the other cases it's possible to start the camera directly
from unloaded state.
- \since 1.1
*/
void QCamera::load()
{
/*!
Close the camera device and deallocate the related resources.
The camera state is changed to QCamera::UnloadedStatus.
- \since 1.1
*/
void QCamera::unload()
{
/*!
Returns a list of camera device's available from the default service provider.
- \since 1.1
*/
QList<QByteArray> QCamera::availableDevices()
/*!
Returns the description of the \a device.
- \since 1.1
*/
QString QCamera::deviceDescription(const QByteArray &device)
/*!
Returns the lock types, camera supports.
- \since 1.1
*/
QCamera::LockTypes QCamera::supportedLocks() const
{
/*!
Returns the requested lock types.
- \since 1.1
*/
QCamera::LockTypes QCamera::requestedLocks() const
{
/*!
Returns the status of requested camera settings locks.
- \since 1.1
*/
QCamera::LockStatus QCamera::lockStatus() const
{
/*!
Returns the status of camera settings \a lock.
- \since 1.1
*/
QCamera::LockStatus QCamera::lockStatus(QCamera::LockType lockType) const
{
It's also acceptable to relock already locked settings,
depending on the lock parameter this initiates new focusing, exposure or white balance calculation.
- \since 1.1
*/
void QCamera::searchAndLock(QCamera::LockTypes locks)
{
/*!
Lock all the supported camera settings.
- \since 1.1
*/
void QCamera::searchAndLock()
{
/*!
Unlocks the camera settings specified with \a locks or cancel the current locking if one is active.
- \since 1.1
*/
void QCamera::unlock(QCamera::LockTypes locks)
{
/*!
Unlock all the requested camera locks.
- \since 1.1
*/
void QCamera::unlock()
{
/*!
\property QCamera::state
\brief The current state of the camera object.
- \since 1.1
*/
/*!
/*!
\property QCamera::status
\brief The current status of the camera object.
- \since 1.1
*/
\enum QCamera::CaptureMode
\value CaptureStillImage Camera is configured for still frames capture.
\value CaptureVideo Camera is configured for video capture.
- \since 1.1
*/
/*!
/*!
\property QCamera::lockStatus
\brief The overall status for all the requested camera locks.
- \since 1.1
*/
/*!
\fn void QCamera::locked()
Signals all the requested camera settings are locked.
- \since 1.1
*/
/*!
\fn void QCamera::lockFailed()
Signals locking of at least one requested camera settings failed.
- \since 1.1
*/
/*!
\fn QCamera::lockStatusChanged(QCamera::LockStatus status, QCamera::LockChangeReason reason)
Signals the overall \a status for all the requested camera locks was changed with specified \a reason.
- \since 1.1
*/
/*!
\fn QCamera::lockStatusChanged(QCamera::LockType lock, QCamera::LockStatus status, QCamera::LockChangeReason reason)
Signals the \a lock \a status was changed with specified \a reason.
- \since 1.1
*/
/*!
\fn void QCamera::error(QCamera::Error value)
Signal emitted when error state changes to \a value.
- \since 1.1
*/
/*!
\fn void QCamera::captureModeChanged(QCamera::CaptureMode mode)
Signals the capture \a mode has changed.
- \since 1.1
*/
/*!
Usually the state changes is caused by calling
load(), unload(), start() and stop(),
but the state can also be changed change as a result of camera error.
- \since 1.1
*/
/*!
Signals the camera \a status has changed.
- \since 1.1
*/
QT_END_NAMESPACE
\inmodule QtMultimedia
\ingroup camera
- \since 1.1
*/
/*!
Returns true if exposure settings are supported by this camera.
- \since 1.1
*/
bool QCameraExposure::isAvailable() const
{
but some non conflicting flags combination are also allowed,
like QCameraExposure::FlashManual | QCameraExposure::FlashSlowSyncRearCurtain.
- \since 1.1
\sa QCameraExposure::isFlashModeSupported(), QCameraExposure::isFlashReady()
*/
/*!
Returns true if the flash \a mode is supported.
- \since 1.1
*/
bool QCameraExposure::isFlashModeSupported(QCameraExposure::FlashModes mode) const
\property QCameraExposure::exposureMode
\brief The exposure mode being used.
- \since 1.1
\sa QCameraExposure::isExposureModeSupported()
*/
/*!
Returns true if the exposure \a mode is supported.
- \since 1.1
*/
bool QCameraExposure::isExposureModeSupported(QCameraExposure::ExposureMode mode) const
\brief Exposure compensation in EV units.
Exposure compensation property allows to adjust the automatically calculated exposure.
- \since 1.1
*/
qreal QCameraExposure::exposureCompensation() const
\property QCameraExposure::meteringMode
\brief The metering mode being used.
- \since 1.1
\sa QCameraExposure::isMeteringModeSupported()
*/
which is typically the default spot metering point.
The spot metering point is only used with spot metering mode.
- \since 1.1
*/
QPointF QCameraExposure::spotMeteringPoint() const
/*!
Returns true if the metering \a mode is supported.
- \since 1.1
*/
bool QCameraExposure::isMeteringModeSupported(QCameraExposure::MeteringMode mode) const
{
If the camera supports arbitrary ISO sensitivities within the supported range,
*\a continuous is set to true, otherwise *\a continuous is set to false.
- \since 1.1
*/
QList<int> QCameraExposure::supportedIsoSensitivities(bool *continuous) const
{
/*!
\fn QCameraExposure::setManualIsoSensitivity(int iso)
Sets the manual sensitivity to \a iso
- \since 1.1
*/
void QCameraExposure::setManualIsoSensitivity(int iso)
/*!
\fn QCameraExposure::setAutoIsoSensitivity()
Turn on auto sensitivity
- \since 1.1
*/
void QCameraExposure::setAutoIsoSensitivity()
\property QCameraExposure::shutterSpeed
\brief Camera's shutter speed in seconds.
- \since 1.1
\sa supportedShutterSpeeds(), setAutoShutterSpeed(), setManualShutterSpeed()
*/
\fn QCameraExposure::shutterSpeedChanged(qreal speed)
Signals that a camera's shutter \a speed has changed.
- \since 1.1
*/
/*!
\brief The sensor ISO sensitivity.
\sa supportedIsoSensitivities(), setAutoIsoSensitivity(), setManualIsoSensitivity()
- \since 1.1
*/
/*!
\property QCameraExposure::aperture
\brief Lens aperture is specified as an F number, the ratio of the focal length to effective aperture diameter.
- \since 1.1
\sa supportedApertures(), setAutoAperture(), setManualAperture()
*/
If the camera supports arbitrary aperture values within the supported range,
*\a continuous is set to true, otherwise *\a continuous is set to false.
- \since 1.1
*/
QList<qreal> QCameraExposure::supportedApertures(bool * continuous) const
{
/*!
\fn QCameraExposure::setManualAperture(qreal aperture)
Sets the manual camera \a aperture value.
- \since 1.1
*/
void QCameraExposure::setManualAperture(qreal aperture)
/*!
\fn QCameraExposure::setAutoAperture()
Turn on auto aperture
- \since 1.1
*/
void QCameraExposure::setAutoAperture()
/*!
Returns the current shutter speed in seconds.
- \since 1.1
*/
qreal QCameraExposure::shutterSpeed() const
If the camera supports arbitrary shutter speed values within the supported range,
*\a continuous is set to true, otherwise *\a continuous is set to false.
- \since 1.1
*/
QList<qreal> QCameraExposure::supportedShutterSpeeds(bool *continuous) const
{
/*!
Set the manual shutter speed to \a seconds
- \since 1.1
*/
void QCameraExposure::setManualShutterSpeed(qreal seconds)
/*!
Turn on auto shutter speed
- \since 1.1
*/
void QCameraExposure::setAutoShutterSpeed()
/*!
\property QCameraExposure::flashReady
\brief Indicates if the flash is charged and ready to use.
- \since 1.1
*/
/*!
\fn void QCameraExposure::flashReady(bool ready)
Signal the flash \a ready status has changed.
- \since 1.1
*/
/*!
\fn void QCameraExposure::apertureChanged(qreal value)
Signal emitted when aperature changes to \a value.
- \since 1.1
*/
/*!
\fn void QCameraExposure::apertureRangeChanged()
Signal emitted when aperature range has changed.
- \since 1.1
*/
\fn void QCameraExposure::shutterSpeedRangeChanged()
Signal emitted when the shutter speed range has changed.
- \since 1.1
*/
\fn void QCameraExposure::isoSensitivityChanged(int value)
Signal emitted when sensitivity changes to \a value.
- \since 1.1
*/
/*!
\fn void QCameraExposure::exposureCompensationChanged(qreal value)
Signal emitted when the exposure compensation changes to \a value.
- \since 1.1
*/
#include "moc_qcameraexposure.cpp"
\inmodule QtMultimedia
\ingroup camera
- \since 1.1
For cameras that support autofocusing, in order for a camera to autofocus on
part of a sensor frame, it considers different zones within the frame. Which
\inmodule QtMultimedia
\ingroup camera
- \since 1.1
On hardware that supports it, this class lets you adjust the focus
or zoom (both optical and digital). This also includes things
Returns true if focus related settings are supported by this camera.
You may need to also check if any specific features are supported.
- \since 1.1
*/
bool QCameraFocus::isAvailable() const
{
\property QCameraFocus::focusMode
\brief The current camera focus mode.
- \since 1.1
This controls the way the camera lens assembly is configured.
/*!
Returns true if the focus \a mode is supported by camera.
- \since 1.1
*/
bool QCameraFocus::isFocusModeSupported(QCameraFocus::FocusMode mode) const
/*!
\property QCameraFocus::focusPointMode
\brief The current camera focus point selection mode.
- \since 1.1
If the camera focus mode is set to use an autofocusing mode,
this property controls the way the camera will select areas
/*!
Returns true if focus point \a mode is supported.
- \since 1.1
*/
bool QCameraFocus::isFocusPointModeSupported(QCameraFocus::FocusPointMode mode) const
{
QPointF(0,0) points to the left top frame point, QPointF(0.5,0.5) points to the frame center.
The custom focus point property is used only in \c FocusPointCustom focus mode.
- \since 1.1
*/
QPointF QCameraFocus::customFocusPoint() const
The coordinates system is the same as for custom focus points:
QPointF(0,0) points to the left top frame point, QPointF(0.5,0.5) points to the frame center.
- \since 1.1
*/
QCameraFocusZoneList QCameraFocus::focusZones() const
{
Returns the maximum optical zoom.
This will be \c 1.0 on cameras that do not support optical zoom.
- \since 1.1
*/
qreal QCameraFocus::maximumOpticalZoom() const
Returns the maximum digital zoom
This will be \c 1.0 on cameras that do not support digital zoom.
- \since 1.1
*/
qreal QCameraFocus::maximumDigitalZoom() const
\property QCameraFocus::opticalZoom
\brief The current optical zoom value.
- \since 1.1
\sa QCameraFocus::digitalZoom
*/
\property QCameraFocus::digitalZoom
\brief The current digital zoom value.
- \since 1.1
\sa QCameraFocus::opticalZoom
*/
qreal QCameraFocus::digitalZoom() const
Since there may be a physical component to move, the change in
zoom value may not be instantaneous.
- \since 1.1
*/
void QCameraFocus::zoomTo(qreal optical, qreal digital)
{
\fn void QCameraFocus::opticalZoomChanged(qreal value)
Signal emitted when optical zoom value changes to new \a value.
- \since 1.1
*/
/*!
\fn void QCameraFocus::digitalZoomChanged(qreal value)
Signal emitted when digital zoom value changes to new \a value.
- \since 1.1
*/
/*!
\fn void QCameraFocus::maximumOpticalZoomChanged(qreal zoom)
Signal emitted when the maximum supported optical \a zoom value changed.
- \since 1.1
*/
/*!
The maximum supported zoom value can depend on other camera settings,
like capture mode or resolution.
- \since 1.1
*/
This can change when a zone is focused or loses focus, or new focus zones
have been detected.
- \since 1.1
*/
\class QCameraImageCapture
\inmodule QtMultimedia
\ingroup camera
- \since 1.1
\brief The QCameraImageCapture class is used for the recording of media content.
/*!
\reimp
- \since 1.1
*/
QMediaObject *QCameraImageCapture::mediaObject() const
{
/*!
\reimp
- \since 1.1
*/
bool QCameraImageCapture::setMediaObject(QMediaObject *mediaObject)
{
/*!
Returns true if the images capture service ready to use.
- \since 1.1
*/
bool QCameraImageCapture::isAvailable() const
{
/*!
Returns the availability error code.
- \since 1.1
*/
QtMultimedia::AvailabilityError QCameraImageCapture::availabilityError() const
{
/*!
Returns the current error state.
- \since 1.1
\sa errorString()
*/
/*!
Returns a string describing the current error state.
- \since 1.1
\sa error()
*/
/*!
Returns a list of supported image codecs.
- \since 1.1
*/
QStringList QCameraImageCapture::supportedImageCodecs() const
{
/*!
Returns a description of an image \a codec.
- \since 1.1
*/
QString QCameraImageCapture::imageCodecDescription(const QString &codec) const
{
If the encoder supports arbitrary resolutions within the supported range,
*\a continuous is set to true, otherwise *\a continuous is set to false.
- \since 1.1
\sa QImageEncoderSettings::resolution()
*/
QList<QSize> QCameraImageCapture::supportedResolutions(const QImageEncoderSettings &settings, bool *continuous) const
/*!
Returns the image encoder settings being used.
- \since 1.1
\sa setEncodingSettings()
*/
If some parameters are not specified, or null settings are passed,
the encoder choose the default encoding parameters.
- \since 1.1
\sa encodingSettings()
*/
/*!
Returns the list of supported buffer image capture formats.
- \since 1.1
\sa bufferFormat() setBufferFormat()
*/
QList<QVideoFrame::PixelFormat> QCameraImageCapture::supportedBufferFormats() const
/*!
Returns the buffer image capture format being used.
- \since 1.2
\sa supportedBufferCaptureFormats() setBufferCaptureFormat()
*/
QVideoFrame::PixelFormat QCameraImageCapture::bufferFormat() const
/*!
Sets the buffer image capture format to be used.
- \since 1.2
\sa bufferCaptureFormat() supportedBufferCaptureFormats() captureDestination()
*/
void QCameraImageCapture::setBufferFormat(const QVideoFrame::PixelFormat format)
/*!
Returns true if the image capture \a destination is supported; otherwise returns false.
- \since 1.2
\sa captureDestination() setCaptureDestination()
*/
bool QCameraImageCapture::isCaptureDestinationSupported(QCameraImageCapture::CaptureDestinations destination) const
/*!
Returns the image capture destination being used.
- \since 1.2
\sa isCaptureDestinationSupported() setCaptureDestination()
*/
QCameraImageCapture::CaptureDestinations QCameraImageCapture::captureDestination() const
/*!
Sets the capture \a destination to be used.
- \since 1.2
\sa isCaptureDestinationSupported() captureDestination()
*/
void QCameraImageCapture::setCaptureDestination(QCameraImageCapture::CaptureDestinations destination)
/*!
\property QCameraImageCapture::readyForCapture
Indicates the service is ready to capture a an image immediately.
- \since 1.1
*/
bool QCameraImageCapture::isReadyForCapture() const
\fn QCameraImageCapture::readyForCaptureChanged(bool ready)
Signals that a camera's \a ready for capture state has changed.
- \since 1.1
*/
QCameraImageCapture::capture returns the capture Id parameter, used with
imageExposed(), imageCaptured() and imageSaved() signals.
- \since 1.1
*/
int QCameraImageCapture::capture(const QString &file)
{
/*!
Cancel incomplete capture requests.
Already captured and queused for proicessing images may be discarded.
- \since 1.1
*/
void QCameraImageCapture::cancelCapture()
{
Signals that the capture request \a id has failed with an \a error
and \a errorString description.
- \since 1.1
*/
/*!
\fn QCameraImageCapture::bufferFormatChanged(QVideoFrame::PixelFormat format)
Signal emitted when the buffer \a format for the buffer image capture has changed.
- \since 1.2
*/
/*!
\fn QCameraImageCapture::captureDestinationChanged(CaptureDestinations destination)
Signal emitted when the capture \a destination has changed.
- \since 1.2
*/
/*!
\fn QCameraImageCapture::imageExposed(int id)
Signal emitted when the frame with request \a id was exposed.
- \since 1.1
*/
/*!
Signal emitted when the frame with request \a id was captured, but not processed and saved yet.
Frame \a preview can be displayed to user.
- \since 1.1
*/
/*!
This signal is emitted for metadata \a value with a \a key listed in QtMultimedia::MetaData enum.
This signal is emitted between imageExposed and imageSaved signals.
- \since 1.2
*/
/*!
This signal is emitted for extended metadata \a value with a \a key not listed in QtMultimedia::MetaData enum.
This signal is emitted between imageExposed and imageSaved signals.
- \since 1.2
*/
\fn QCameraImageCapture::imageAvailable(int id, const QVideoFrame &buffer)
Signal emitted when the frame with request \a id is available as \a buffer.
- \since 1.2
*/
/*!
\fn QCameraImageCapture::imageSaved(int id, const QString &fileName)
Signal emitted when the frame with request \a id was saved to \a fileName.
- \since 1.1
*/
\inmodule QtMultimedia
\ingroup camera
- \since 1.1
After capturing the data for a camera frame, the camera hardware and
software performs various image processing tasks to produce a final
/*!
Returns true if image processing related settings are supported by this camera.
- \since 1.1
*/
bool QCameraImageProcessing::isAvailable() const
{
/*!
Returns the white balance mode being used.
- \since 1.1
*/
QCameraImageProcessing::WhiteBalanceMode QCameraImageProcessing::whiteBalanceMode() const
/*!
Sets the white balance to \a mode.
- \since 1.1
*/
void QCameraImageProcessing::setWhiteBalanceMode(QCameraImageProcessing::WhiteBalanceMode mode)
/*!
Returns true if the white balance \a mode is supported.
- \since 1.1
*/
bool QCameraImageProcessing::isWhiteBalanceModeSupported(QCameraImageProcessing::WhiteBalanceMode mode) const
Returns the current color temperature if the
current white balance mode is \c WhiteBalanceManual. For other modes the
return value is undefined.
- \since 1.1
*/
int QCameraImageProcessing::manualWhiteBalance() const
/*!
Sets manual white balance to \a colorTemperature. This is used
when whiteBalanceMode() is set to \c WhiteBalanceManual. The units are Kelvin.
- \since 1.1
*/
void QCameraImageProcessing::setManualWhiteBalance(int colorTemperature)
/*!
Returns the contrast adjustment setting.
- \since 1.1
*/
int QCameraImageProcessing::contrast() const
{
Set the contrast adjustment to \a value.
Valid contrast adjustment values range between -100 and 100, with a default of 0.
- \since 1.1
*/
void QCameraImageProcessing::setContrast(int value)
{
/*!
Returns the saturation adjustment value.
- \since 1.1
*/
int QCameraImageProcessing::saturation() const
{
Sets the saturation adjustment value to \a value.
Valid saturation values range between -100 and 100, with a default of 0.
- \since 1.1
*/
void QCameraImageProcessing::setSaturation(int value)
Identifies if sharpening is supported.
Returns true if sharpening is supported; and false if it is not.
- \since 1.1
*/
bool QCameraImageProcessing::isSharpeningSupported() const
{
This may be \c DefaultSharpening if no particular sharpening level has been applied.
- \since 1.1
*/
int QCameraImageProcessing::sharpeningLevel() const
{
to perform. Otherwise a level of 0 will disable sharpening, and a level of 100
corresponds to maximum sharpening applied.
- \since 1.1
*/
void QCameraImageProcessing::setSharpeningLevel(int level)
/*!
Returns true if denoising is supported.
- \since 1.1
*/
bool QCameraImageProcessing::isDenoisingSupported() const
{
Returns the denoising level. This may be \c DefaultDenoising if no
particular value has been set.
- \since 1.1
*/
int QCameraImageProcessing::denoisingLevel() const
{
to perform. Otherwise a level of 0 will disable denoising, and a level of 100
corresponds to maximum denoising applied.
- \since 1.1
*/
void QCameraImageProcessing::setDenoisingLevel(int level)
{
\class QAudioEncoderControl
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.0
\brief The QAudioEncoderControl class provides access to the settings of a
media service that performs audio encoding.
\fn QAudioEncoderControl::supportedAudioCodecs() const
Returns the list of supported audio codec names.
- \since 1.0
*/
/*!
\fn QAudioEncoderControl::codecDescription(const QString &codec) const
Returns description of audio \a codec.
- \since 1.0
*/
/*!
If the encoder supports arbitrary sample rates within the supported rates range,
*\a continuous is set to true, otherwise *\a continuous is set to false.
- \since 1.0
*/
/*!
\fn QAudioEncoderControl::supportedEncodingOptions(const QString &codec) const
Returns the list of \a codec specific audio encoding options.
- \since 1.0
*/
/*!
\fn QAudioEncoderControl::encodingOption(const QString &codec, const QString &option) const
Returns the value of audio encoding \a option for \a codec.
- \since 1.0
*/
/*!
\fn QAudioEncoderControl::setEncodingOption(const QString &codec, const QString &option, const QVariant &value)
Set the \a codec specific \a option to \a value.
- \since 1.0
*/
/*!
The returned value may be different tha passed to QAudioEncoderControl::setAudioSettings()
if the settings contains the default or undefined parameters.
In this case if the undefined parameters are already resolved, they should be returned.
- \since 1.0
*/
/*!
\fn QAudioEncoderControl::setAudioSettings(const QAudioEncoderSettings &settings)
Sets the selected audio \a settings.
- \since 1.0
*/
#include "moc_qaudioencodercontrol.cpp"
\fn QCameraCaptureBufferFormatControl::supportedBufferFormats() const
Returns the list of the supported buffer capture formats.
- \since 1.2
*/
/*!
\fn QCameraCaptureBufferFormatControl::bufferFormat() const
Returns the current buffer capture format.
- \since 1.2
*/
/*!
\fn QCameraCaptureBufferFormatControl::setBufferFormat(QVideoFrame::PixelFormat format)
Sets the buffer capture \a format.
- \since 1.2
*/
/*!
\fn QCameraCaptureBufferFormatControl::bufferFormatChanged(QVideoFrame::PixelFormat format)
Signals the buffer image capture format changed to \a format.
- \since 1.2
*/
#include "moc_qcameracapturebufferformatcontrol.cpp"
\fn QCameraCaptureDestinationControl::isCaptureDestinationSupported(QCameraImageCapture::CaptureDestinations destination) const
Returns true if the capture \a destination is supported; and false if it is not.
- \since 1.2
*/
/*!
\fn QCameraCaptureDestinationControl::captureDestination() const
Returns the current capture \a destination. The default destination is QCameraImageCapture::CaptureToFile.
- \since 1.2
*/
/*!
\fn QCameraCaptureDestinationControl::setCaptureDestination(QCameraImageCapture::CaptureDestinations destination)
Sets the capture \a destination.
- \since 1.2
*/
/*!
\fn QCameraCaptureDestinationControl::captureDestinationChanged(QCameraImageCapture::CaptureDestinations destination)
Signals the image capture \a destination changed.
- \since 1.2
*/
#include "moc_qcameracapturedestinationcontrol.cpp"
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.1
This service is provided by a QMediaService object via
QMediaService::control(). It is used by QCamera.
Returns the state of the camera service.
- \since 1.1
\sa QCamera::state
*/
while camera status is used as a feedback mechanism to inform application about backend status.
Status changes are reported asynchronously with QCameraControl::statusChanged() signal.
- \since 1.1
\sa QCamera::State
*/
In most cases the state chage is caused by QCameraControl::setState(),
but if critical error has occurred the state changes to QCamera::UnloadedState.
- \since 1.1
*/
/*!
Returns the status of the camera service.
- \since 1.1
\sa QCamera::state
*/
\fn void QCameraControl::statusChanged(QCamera::Status status)
Signal emitted when the camera \a status changes.
- \since 1.1
*/
Signal emitted when an error occurs with error code \a error and
a description of the error \a errorString.
- \since 1.1
*/
/*!
\fn Camera::CaptureMode QCameraControl::captureMode() const = 0
Returns the current capture mode.
- \since 1.1
*/
/*!
with the status changed to QCamera::StartingStatus.
This allows the capture settings to be applied before camera is started.
Than change the status to QCamera::StartedStatus when the capture mode change is done.
- \since 1.1
*/
/*!
\fn bool QCameraControl::isCaptureModeSupported(QCamera::CaptureMode mode) const = 0;
Returns true if the capture \a mode is suported.
- \since 1.1
*/
/*!
\fn QCameraControl::captureModeChanged(QCamera::CaptureMode mode)
Signal emitted when the camera capture \a mode changes.
- \since 1.1
*/
/*!
before the settings are changed and restarted after.
Otherwise the backend should apply the change in the current state,
with the camera status indicating the progress, if necessary.
- \since 1.1
*/
/*!
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.1
You can adjust a number of parameters that will affect images and video taken with
the corresponding QCamera object.
\fn QCamera::ExposureMode QCameraExposureControl::exposureMode() const
Returns the exposure mode.
- \since 1.1
*/
\fn void QCameraExposureControl::setExposureMode(QCameraExposure::ExposureMode mode)
Set the exposure mode to \a mode.
- \since 1.1
*/
\fn bool QCameraExposureControl::isExposureModeSupported(QCameraExposure::ExposureMode mode) const
Returns true if the exposure \a mode is supported.
- \since 1.1
*/
/*!
\fn QCameraExposure::MeteringMode QCameraExposureControl::meteringMode() const
Returns the current metering mode.
- \since 1.1
*/
/*!
\fn void QCameraExposureControl::setMeteringMode(QCameraExposure::MeteringMode mode)
Set the metering mode to \a mode.
- \since 1.1
*/
/*!
\fn bool QCameraExposureControl::isMeteringModeSupported(QCameraExposure::MeteringMode mode) const
Returns true if the metering \a mode is supported.
- \since 1.1
*/
/*!
\fn QCameraExposureControl::isParameterSupported(ExposureParameter parameter) const
Returns true is exposure \a parameter is supported by backend.
- \since 1.1
*/
/*!
\fn QCameraExposureControl::exposureParameter(ExposureParameter parameter) const
Returns the exposure \a parameter value, or invalid QVariant() if the value is unknown or not supported.
- \since 1.1
*/
/*!
\fn QCameraExposureControl::exposureParameterFlags(ExposureParameter parameter) const
Returns the properties of exposure \a parameter.
- \since 1.1
*/
\fn QCameraExposureControl::supportedParameterRange(ExposureParameter parameter) const
Returns the list of supported \a parameter values;
- \since 1.1
*/
/*!
and if possible report the actual value to user with QCameraExposureControl::exposureParameter().
Returns true if parameter is supported and value is correct.
- \since 1.1
*/
/*!
\fn QCameraExposureControl::extendedParameterName(ExposureParameter parameter)
Returns the extended exposure \a parameter name.
- \since 1.1
*/
/*!
\fn void QCameraExposureControl::flashReady(bool ready)
Signal emitted when flash state changes, flash is charged \a ready.
- \since 1.1
*/
/*!
\fn void QCameraExposureControl::exposureParameterChanged(int parameter)
Signal emitted when the exposure \a parameter has changed.
- \since 1.1
*/
/*!
\fn void QCameraExposureControl::exposureParameterRangeChanged(int parameter)
Signal emitted when the exposure \a parameter range has changed.
- \since 1.1
*/
\ingroup multimedia-serv
\inmodule QtMultimedia
- \since 1.1
\inmodule QtMultimedia
\fn QCamera::FlashModes QCameraFlashControl::flashMode() const
Returns the current flash mode.
- \since 1.1
*/
/*!
Usually a single QCameraExposure::FlashMode flag is used,
but some non conflicting flags combination are also allowed,
like QCameraExposure::FlashManual | QCameraExposure::FlashSlowSyncRearCurtain.
- \since 1.1
*/
Return true if the reqested flash \a mode is supported.
Some QCameraExposure::FlashMode values can be combined,
for example QCameraExposure::FlashManual | QCameraExposure::FlashSlowSyncRearCurtain
- \since 1.1
*/
/*!
\fn bool QCameraFlashControl::isFlashReady() const
Returns true if flash is charged.
- \since 1.1
*/
/*!
\fn void QCameraFlashControl::flashReady(bool ready)
Signal emitted when flash state changes to \a ready.
- \since 1.1
*/
#include "moc_qcameraflashcontrol.cpp"
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.1
The interface name of QCameraFocusControl is \c com.nokia.Qt.QCameraFocusControl/1.0 as
defined in QCameraFocusControl_iid.
\fn QCameraFocus::FocusMode QCameraFocusControl::focusMode() const
Returns the focus mode being used.
- \since 1.1
*/
\fn void QCameraFocusControl::setFocusMode(QCameraFocus::FocusMode mode)
Set the focus mode to \a mode.
- \since 1.1
*/
\fn bool QCameraFocusControl::isFocusModeSupported(QCameraFocus::FocusMode mode) const
Returns true if focus \a mode is supported.
- \since 1.1
*/
\fn qreal QCameraFocusControl::maximumOpticalZoom() const
Returns the maximum optical zoom value, or 1.0 if optical zoom is not supported.
- \since 1.1
*/
\fn qreal QCameraFocusControl::maximumDigitalZoom() const
Returns the maximum digital zoom value, or 1.0 if digital zoom is not supported.
- \since 1.1
*/
\fn qreal QCameraFocusControl::opticalZoom() const
Return the current optical zoom value.
- \since 1.1
*/
/*!
\fn qreal QCameraFocusControl::digitalZoom() const
Return the current digital zoom value.
- \since 1.1
*/
\fn void QCameraFocusControl::zoomTo(qreal optical, qreal digital)
Sets \a optical and \a digital zoom values.
- \since 1.1
*/
/*!
\fn QCameraFocusControl::focusPointMode() const
Returns the camera focus point selection mode.
- \since 1.1
*/
/*!
\fn QCameraFocusControl::setFocusPointMode(QCameraFocus::FocusPointMode mode)
Sets the camera focus point selection \a mode.
- \since 1.1
*/
/*!
\fn QCameraFocusControl::isFocusPointModeSupported(QCameraFocus::FocusPointMode mode) const
Returns true if the camera focus point \a mode is supported.
- \since 1.1
*/
/*!
QPointF(0,0) points to the left top frame point, QPointF(0.5,0.5) points to the frame center.
Custom focus point is used only in FocusPointCustom focus mode.
- \since 1.1
*/
/*!
it should use the nearest supported focus point,
and return the actual focus point with QCameraFocusControl::focusZones().
- \since 1.1
\sa QCameraFocusControl::customFocusPoint(), QCameraFocusControl::focusZones()
*/
\fn QCameraFocusControl::focusZones() const
Returns the list of zones, the camera is using for focusing or focused on.
- \since 1.1
*/
/*!
\fn void QCameraFocusControl::opticalZoomChanged(qreal zoom)
Signal emitted when the optical \a zoom value changed.
- \since 1.1
*/
/*!
\fn void QCameraFocusControl::digitalZoomChanged(qreal zoom)
Signal emitted when the digital \a zoom value changed.
- \since 1.1
*/
/*!
\fn void QCameraFocusControl::maximumOpticalZoomChanged(qreal zoom)
Signal emitted when the maximum supported optical \a zoom value changed.
- \since 1.1
*/
/*!
The maximum supported zoom value can depend on other camera settings,
like capture mode or resolution.
- \since 1.1
*/
Usually the zones list is changed when the camera is focused.
- \since 1.1
\sa QCameraFocusControl::focusZones()
*/
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.1
hardware initialized, flash is charged, etc).
Returns true if the camera is ready for capture; and false if it is not.
- \since 1.1
*/
/*!
\fn QCameraImageCaptureControl::readyForCaptureChanged(bool ready)
Signals that a capture control's \a ready state has changed.
- \since 1.1
*/
/*!
Returns the capture request id number, which is used later
with imageExposed(), imageCaptured() and imageSaved() signals.
- \since 1.1
*/
/*!
\fn QCameraImageCaptureControl::cancelCapture()
Cancel pending capture requests.
- \since 1.1
*/
/*!
Signals that an image with it \a requestId
has just been exposed.
This signal can be used for the shutter sound or other indicaton.
- \since 1.1
*/
/*!
Signals that an image with it \a requestId
has been captured and a \a preview is available.
- \since 1.1
*/
/*!
This signal is emitted for metadata \a value with a \a key listed in QtMultimedia::MetaData enum.
This signal should be emitted between imageExposed and imageSaved signals.
- \since 1.2
*/
/*!
This signal is emitted for extended metadata \a value with a \a key not listed in QtMultimedia::MetaData enum.
This signal should be emitted between imageExposed and imageSaved signals.
- \since 1.2
*/
/*!
\fn QCameraImageCaptureControl::imageAvailable(int requestId, const QVideoFrame &buffer)
Signals that a captured \a buffer with a \a requestId is available.
- \since 1.2
*/
/*!
Signals that a captured image with a \a requestId has been saved
to \a fileName.
- \since 1.1
*/
/*!
\fn QCameraImageCaptureControl::driveMode() const
Returns the current camera drive mode.
- \since 1.1
*/
/*!
\fn QCameraImageCaptureControl::setDriveMode(QCameraImageCapture::DriveMode mode)
Sets the current camera drive \a mode.
- \since 1.1
*/
Signals the capture request \a id failed with \a error code and message \a errorString.
- \since 1.1
\sa QCameraImageCapture::Error
*/
\class QCameraImageProcessingControl
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.1
\brief The QCameraImageProcessingControl class provides an abstract class
/*!
\fn QCameraImageProcessingControl::whiteBalanceMode() const
Return the white balance mode being used.
- \since 1.1
*/
/*!
\fn QCameraImageProcessingControl::setWhiteBalanceMode(QCameraImageProcessing::WhiteBalanceMode mode)
Set the white balance mode to \a mode
- \since 1.1
*/
/*!
\fn QCameraImageProcessingControl::isWhiteBalanceModeSupported(QCameraImageProcessing::WhiteBalanceMode mode) const
Returns true if the white balance \a mode is supported.
The backend should support at least QCameraImageProcessing::WhiteBalanceAuto mode.
- \since 1.1
*/
/*!
but some parameter may not be available depending on other
camera settings, like presets.
In such case the currently supported parameters should be returned.
- \since 1.1
*/
/*!
\fn QCameraImageProcessingControl::processingParameter(ProcessingParameter parameter) const
Returns the image processing \a parameter value.
- \since 1.1
*/
/*!
For sharpening and denoising the range is 0..100,
0 for sharpening or denoising disabled
and 100 for maximum sharpening/denoising applied.
- \since 1.1
*/
/*!
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.1
This service is provided by a QMediaService object via
QMediaService::control(). It is used by QCamera.
\fn QCameraLocksControl::supportedLocks() const
Returns the lock types, the camera supports.
- \since 1.1
*/
/*!
\fn QCameraLocksControl::lockStatus(QCamera::LockType lock) const
Returns the camera \a lock status.
- \since 1.1
*/
/*!
\fn QCameraLocksControl::searchAndLock(QCamera::LockTypes locks)
Request camera \a locks.
- \since 1.1
*/
/*!
\fn QCameraLocksControl::unlock(QCamera::LockTypes locks)
Unlock camera \a locks.
- \since 1.1
*/
/*!
\fn QCameraLocksControl::lockStatusChanged(QCamera::LockType lock, QCamera::LockStatus status, QCamera::LockChangeReason reason)
Signals the \a lock \a status was changed with a specified \a reason.
- \since 1.1
*/
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.0
\brief The QImageEncoderControl class provides access to the settings of a media service that
performs image encoding.
If the encoder supports arbitrary resolutions within the supported resolutions range,
*\a continuous is set to true, otherwise *\a continuous is set to false.
- \since 1.0
*/
/*!
\fn QImageEncoderControl::supportedImageCodecs() const
Returns a list of supported image codecs.
- \since 1.0
*/
/*!
\fn QImageEncoderControl::imageCodecDescription(const QString &codec) const
Returns a description of an image \a codec.
- \since 1.0
*/
/*!
The returned value may be different tha passed to QImageEncoderControl::setImageSettings()
if the settings contains the default or undefined parameters.
In this case if the undefined parameters are already resolved, they should be returned.
- \since 1.0
*/
/*!
\fn QImageEncoderControl::setImageSettings(const QImageEncoderSettings &settings)
Sets the selected image encoder \a settings.
- \since 1.0
*/
#include "moc_qimageencodercontrol.cpp"
\class QMediaBackgroundPlaybackControl
\inmodule QtMultimedia
\ingroup multimedia
- \since 5.0
\brief The QMediaBackgroundPlaybackControl class provides access to the background playback
contextId is an unique string set by the application and is used by the background daemon to
distinguish and manage different context for different application.
- \since 1.0
*/
/*!
\fn QMediaBackgroundPlaybackControl::acquire()
Try to acquire the playback resource for current application
- \since 1.0
*/
/*!
\fn QMediaBackgroundPlaybackControl::release()
Give up the playback resource if current applicaiton holds it.
- \since 1.0
*/
/*!
By default this property is false
- \since 1.0
*/
/*!
Signals that the playback resource is acquired
- \since 1.0
*/
/*!
Signals that the playback resource is lost
- \since 1.0
*/
#include "moc_qmediabackgroundplaybackcontrol.cpp"
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.0
If a QMediaService supports writing encoded data it will implement
QMediaContainerControl. This control provides information about the output
\fn QMediaContainerControl::supportedContainers() const
Returns a list of MIME types of supported container formats.
- \since 1.0
*/
/*!
\fn QMediaContainerControl::containerMimeType() const
Returns the MIME type of the selected container format.
- \since 1.0
*/
/*!
\fn QMediaContainerControl::setContainerMimeType(const QString &mimeType)
Sets the current container format to the format identified by the given \a mimeType.
- \since 1.0
*/
/*!
\fn QMediaContainerControl::containerDescription(const QString &mimeType) const
Returns a description of the container format identified by the given \a mimeType.
- \since 1.0
*/
#include "moc_qmediacontainercontrol.cpp"
\class QMediaGaplessPlaybackControl
\inmodule QtMultimedia
\ingroup multimedia
- \since 5.0
\brief The QMediaGaplessPlaybackControl class provides access to the gapless playback
related control of a QMediaService.
\fn QMediaGaplessPlaybackControl::nextMedia() const
Returns the content of the next media
- \since 1.0
*/
/*!
\fn QMediaGaplessPlaybackControl::setNextMedia(const QMediaContent& media)
Sets the next media for smooth transition.
- \since 1.0
*/
/*!
Signals that the next media has changed (either explicitly via \l setNextMedia() or when the
player clears the next media while advancing to it).
- \since 1.0
\sa nextMedia()
*/
Signals when the player advances to the next media (the content of next media will be cleared).
- \since 1.0
\sa nextMedia()
*/
If crossfading is not supported, \l setCrossfadTime() will be ignored and \l crossfadeTime() will
always return 0.
- \since 1.0
*/
/*!
A crossfade time of zero or negative will result in gapless playback (suitable for some
continuous media).
- \since 1.0
*/
/*!
\fn QMediaGaplessPlaybackControl::crossfadeTime() const
Returns current crossfade time in seconds.
- \since 1.0
*/
/*!
Signals that the crossfade time has changed.
- \since 1.0
\sa crossfadeTime()
*/
\brief The QMediaNetworkAccessControl class allows the setting of the Network Access Point for media related activities.
\ingroup multimedia-serv
\inmodule QtMultimedia
- \since 1.2
The functionality provided by this control allows the
setting of a Network Access Point.
It is assumed the list is given in highest to lowest preference order.
By calling this function all previous configurations will be invalidated
and replaced with the new list.
- \since 1.2
*/
/*
\fn QMediaNetworkAccessControl::configurationChanged(const QNetworkConfiguration &configuration)
This signal is emitted when the current active network configuration changes
to \a configuration.
- \since 1.2
*/
\class QMediaPlayerControl
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.0
\brief The QMediaPlayerControl class provides access to the media playing
\fn QMediaPlayerControl::state() const
Returns the state of a player control.
- \since 1.0
*/
/*!
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
*/
/*!
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
*/
/*!
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
*/
/*!
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
*/
/*!
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
*/
/*!
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
*/
/*!
Signals a change in the \a mute status of a player control.
- \since 1.0
\sa isMuted()
*/
Returns the buffering progress of the current media. Progress is measured in the percentage
of the buffer filled.
- \since 1.0
*/
/*!
Signals that buffering \a progress has changed.
- \since 1.0
\sa bufferStatus()
*/
Identifies if there is audio output available for the current media.
Returns true if audio output is available and false otherwise.
- \since 1.0
*/
/*!
Signals that there has been a change in the availability of \a audio output.
- \since 1.0
\sa isAudioAvailable()
*/
Identifies if there is video output available for the current media.
Returns true if video output is available and false otherwise.
- \since 1.0
*/
/*!
Signals that there has been a change in the availability of \a video output.
- \since 1.0
\sa isVideoAvailable()
*/
Identifies if the current media is seekable.
Returns true if it possible to seek within the current media, and false otherwise.
- \since 1.0
*/
/*!
Signals that the \a seekable state of a player control has changed.
- \since 1.0
\sa isSeekable()
*/
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
*/
/*!
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
*/
/*!
Returns the current media stream. This is only a valid if a stream was passed to setMedia().
- \since 1.0
\sa setMedia()
*/
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
*/
/*!
If successful the player control will immediately enter the \l {QMediaPlayer::PlayingState}
{playing} state.
- \since 1.0
\sa state()
*/
If sucessful the player control will immediately enter the \l {QMediaPlayer::PausedState}
{paused} state.
- \since 1.0
\sa state(), play(), stop()
*/
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"
\class QMediaPlaylistControl
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.0
\brief The QMediaPlaylistControl class provides access to the playlist
\fn QMediaPlaylistControl::playlistProvider() const
Returns the playlist used by this media player.
- \since 1.0
*/
/*!
Returns true if player can use this passed playlist; otherwise returns false.
- \since 1.0
*/
/*!
\fn QMediaPlaylistControl::currentIndex() const
Returns position of the current media source in the playlist.
- \since 1.0
*/
/*!
\fn QMediaPlaylistControl::setCurrentIndex(int position)
Jump to the item at the given \a position.
- \since 1.0
*/
/*!
Returned value depends on the size of playlist, current position
and playback mode.
- \since 1.0
\sa QMediaPlaylist::playbackMode
*/
Returns the index of item, which were current after calling previous()
\a step times.
- \since 1.0
\sa QMediaPlaylist::playbackMode
*/
\fn QMediaPlaylistControl::next()
Moves to the next item in playlist.
- \since 1.0
*/
/*!
\fn QMediaPlaylistControl::previous()
Returns to the previous item in playlist.
- \since 1.0
*/
/*!
Returns the playlist navigation mode.
- \since 1.0
\sa QMediaPlaylist::PlaybackMode
*/
Sets the playback \a mode.
- \since 1.0
\sa QMediaPlaylist::PlaybackMode
*/
\fn QMediaPlaylistControl::playlistProviderChanged()
Signal emitted when the playlist provider has changed.
- \since 1.0
*/
/*!
\fn QMediaPlaylistControl::currentIndexChanged(int position)
Signal emitted when the playlist \a position is changed.
- \since 1.0
*/
/*!
\fn QMediaPlaylistControl::playbackModeChanged(QMediaPlaylist::PlaybackMode mode)
Signal emitted when the playback \a mode is changed.
- \since 1.0
*/
/*!
\fn QMediaPlaylistControl::currentMediaChanged(const QMediaContent& content)
Signal emitted when current media changes to \a content.
- \since 1.0
*/
#include "moc_qmediaplaylistcontrol.cpp"
\class QMediaPlaylistSourceControl
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.0
\brief The QMediaPlaylistSourceControl class provides access to the playlist playback
Returns the current playlist.
Should return a null pointer if no playlist is assigned.
- \since 1.0
*/
/*!
If a null pointer is passed, the playlist source should be disabled.
The current media should be replaced with the current item of the media playlist.
- \since 1.0
*/
\fn QMediaPlaylistSourceControl::playlistChanged(QMediaPlaylist* playlist)
Signal emitted when the playlist has changed to \a playlist.
- \since 1.0
*/
#include "moc_qmediaplaylistsourcecontrol.cpp"
\class QMediaRecorderControl
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.0
\brief The QMediaRecorderControl class provides access to the recording
\fn QUrl QMediaRecorderControl::outputLocation() const
Returns the current output location being used.
- \since 1.0
*/
/*!
The \a location can be relative or empty;
in this case the service should use the system specific place and file naming scheme.
After recording has stated, QMediaRecorderControl::outputLocation() should return the actual output location.
- \since 1.0
*/
/*!
\fn int QMediaRecorderControl::state() const
Return the current recording state.
- \since 1.0
*/
/*!
\fn qint64 QMediaRecorderControl::duration() const
Return the current duration in milliseconds.
- \since 1.0
*/
/*!
\fn void QMediaRecorderControl::record()
Start recording.
- \since 1.0
*/
/*!
\fn void QMediaRecorderControl::pause()
Pause recording.
- \since 1.0
*/
/*!
\fn void QMediaRecorderControl::stop()
Stop recording.
- \since 1.0
*/
/*!
Commits the encoder settings and performs pre-initialization to reduce delays when recording
is started.
- \since 1.0
*/
/*!
\fn bool QMediaRecorderControl::isMuted() const
Returns true if the recorder is muted, and false if it is not.
- \since 1.0
*/
/*!
\fn void QMediaRecorderControl::setMuted(bool muted)
Sets the \a muted state of a media recorder.
- \since 1.0
*/
\fn void QMediaRecorderControl::stateChanged(QMediaRecorder::State state)
Signals that the \a state of a media recorder has changed.
- \since 1.0
*/
/*!
Signals that the \a duration of the recorded media has changed.
This only emitted when there is a discontinuous change in the duration such as being reset to 0.
- \since 1.0
*/
/*!
\fn void QMediaRecorderControl::mutedChanged(bool muted)
Signals that the \a muted state of a media recorder has changed.
- \since 1.0
*/
/*!
\fn void QMediaRecorderControl::error(int error, const QString &errorString)
Signals that an \a error has occurred. The \a errorString describes the error.
- \since 1.0
*/
#include "moc_qmediarecordercontrol.cpp"
\ingroup multimedia-serv
\brief The QMediaStreamsControl class provides a media stream selection control.
- \since 1.0
The QMediaStreamsControl class provides descriptions of the available media streams
and allows individual streams to be activated and deactivated.
Defines the interface name of the QMediaStreamsControl class.
\relates QMediaStreamsControl
- \since 1.0
*/
/*!
\fn QMediaStreamsControl::streamCount()
Returns the number of media streams.
- \since 1.0
*/
/*!
\fn QMediaStreamsControl::streamType(int stream)
Return the type of a media \a stream.
- \since 1.0
*/
/*!
Returns the meta-data value of \a key for a given \a stream.
Useful metadata keya are QtMultimedia::Title, QtMultimedia::Description and QtMultimedia::Language.
- \since 1.0
*/
/*!
\fn QMediaStreamsControl::isActive(int stream)
Returns true if the media \a stream is active.
- \since 1.0
*/
/*!
Setting the active state of a media stream to true will activate it. If any other stream
of the same type was previously active it will be deactivated. Setting the active state fo a
media stream to false will deactivate it.
- \since 1.0
*/
/*!
\fn QMediaStreamsControl::streamsChanged()
The signal is emitted when the available streams list is changed.
- \since 1.0
*/
/*!
\fn QMediaStreamsControl::activeStreamsChanged()
The signal is emitted when the active streams list is changed.
- \since 1.0
*/
#include "moc_qmediastreamscontrol.cpp"
\class QMetaDataReaderControl
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.0
\brief The QMetaDataReaderControl class provides read access to the
Identifies if meta-data is available from a media service.
Returns true if the meta-data is available and false otherwise.
- \since 1.0
*/
/*!
\fn QVariant QMetaDataReaderControl::metaData(QtMultimedia::MetaData key) const
Returns the meta-data for the given \a key.
- \since 1.0
*/
/*!
\fn QMetaDataReaderControl::availableMetaData() const
Returns a list of keys there is meta-data available for.
- \since 1.0
*/
/*!
The valid selection of keys for extended meta-data is determined by the provider and the meaning
and type may differ between providers.
- \since 1.0
*/
/*!
\fn QMetaDataReaderControl::availableExtendedMetaData() const
Returns a list of keys there is extended meta-data available for.
- \since 1.0
*/
\fn void QMetaDataReaderControl::metaDataChanged()
Signal the changes of meta-data.
- \since 1.0
*/
/*!
Signal the availability of meta-data has changed, \a available will
be true if the multimedia object has meta-data.
- \since 1.0
*/
#include "moc_qmetadatareadercontrol.cpp"
\class QMetaDataWriterControl
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.0
\brief The QMetaDataWriterControl class provides write access to the
Identifies if meta-data is available from a media service.
Returns true if the meta-data is available and false otherwise.
- \since 1.0
*/
/*!
Identifies if a media service's meta-data can be edited.
Returns true if the meta-data is writable and false otherwise.
- \since 1.0
*/
/*!
\fn QVariant QMetaDataWriterControl::metaData(QtMultimedia::MetaData key) const
Returns the meta-data for the given \a key.
- \since 1.0
*/
/*!
\fn void QMetaDataWriterControl::setMetaData(QtMultimedia::MetaData key, const QVariant &value)
Sets the \a value of the meta-data element with the given \a key.
- \since 1.0
*/
/*!
The valid selection of keys for extended meta-data is determined by the provider and the meaning
and type may differ between providers.
- \since 1.0
*/
/*!
The valid selection of keys for extended meta-data is determined by the provider and the meaning
and type may differ between providers.
- \since 1.0
*/
/*!
\fn QMetaDataWriterControl::availableExtendedMetaData() const
Returns a list of keys there is extended meta-data available for.
- \since 1.0
*/
\fn void QMetaDataWriterControl::metaDataChanged()
Signal the changes of meta-data.
- \since 1.0
*/
/*!
Signal the availability of meta-data has changed, \a available will
be true if the multimedia object has meta-data.
- \since 1.0
*/
/*!
Signal a change in the writable status of meta-data, \a writable will be
true if meta-data elements can be added or adjusted.
- \since 1.0
*/
#include "moc_qmetadatawritercontrol.cpp"
\class QRadioDataControl
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 5.0
\brief The QRadioDataControl class provides access to the RDS functionality of the
\fn bool QRadioDataControl::isAvailable() const
Returns true if the radio service is ready to use.
- \since 5.0
*/
/*!
\fn QtMultimedia::AvailabilityError QRadioDataControl::availabilityError() const
Returns the error state of the radio service.
- \since 5.0
*/
/*!
\fn QRadioData::Error QRadioDataControl::error() const
Returns the error state of a radio data.
- \since 5.0
*/
/*!
\fn QString QRadioDataControl::errorString() const
Returns a string describing a radio data's error state.
- \since 5.0
*/
/*!
\fn void QRadioDataControl::error(QRadioData::Error error)
Signals that an \a error has occurred.
- \since 5.0
*/
/*!
\fn int QRadioDataControl::stationId()
Returns the current Program Identification
- \since 5.0
*/
/*!
\fn QRadioData::ProgramType QRadioDataControl::programType()
Returns the current Program Type
- \since 5.0
*/
/*!
\fn QString QRadioDataControl::programTypeName()
Returns the current Program Type Name
- \since 5.0
*/
/*!
\fn QString QRadioDataControl::stationName()
Returns the current Program Service
- \since 5.0
*/
/*!
\fn QString QRadioDataControl::radioText()
Returns the current Radio Text
- \since 5.0
*/
/*!
\fn void QRadioDataControl::setAlternativeFrequenciesEnabled(bool enabled)
Sets the Alternative Frequency to \a enabled
- \since 5.0
*/
/*!
\fn bool QRadioDataControl::isAlternativeFrequenciesEnabled()
Returns true if Alternative Frequency is currently enabled
- \since 5.0
*/
/*!
\fn void QRadioDataControl::stationIdChanged(QString stationId)
Signals that the Program Identification \a stationId has changed
- \since 5.0
*/
/*!
\fn void QRadioDataControl::programTypeChanged(QRadioData::ProgramType programType)
Signals that the Program Type \a programType has changed
- \since 5.0
*/
/*!
\fn void QRadioDataControl::programTypeNameChanged(QString programTypeName)
Signals that the Program Type Name \a programTypeName has changed
- \since 5.0
*/
/*!
\fn void QRadioDataControl::stationNameChanged(QString stationName)
Signals that the Program Service \a stationName has changed
- \since 5.0
*/
/*!
\fn void QRadioDataControl::radioTextChanged(QString radioText)
Signals that the Radio Text \a radioText has changed
- \since 5.0
*/
#include "moc_qradiodatacontrol.cpp"
\class QRadioTunerControl
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.0
\brief The QRadioTunerControl class provides access to the radio tuning
\fn bool QRadioTunerControl::isAvailable() const
Returns true if the radio service is ready to use.
- \since 1.0
*/
/*!
\fn QtMultimedia::AvailabilityError QRadioTunerControl::availabilityError() const
Returns the error state of the radio service.
- \since 1.0
*/
/*!
\fn QRadioTuner::State QRadioTunerControl::state() const
Returns the current radio tuner state.
- \since 1.0
*/
/*!
\fn QRadioTuner::Band QRadioTunerControl::band() const
Returns the frequency band a radio tuner is tuned to.
- \since 1.0
*/
/*!
\fn void QRadioTunerControl::bandChanged(QRadioTuner::Band band)
Signals that the frequency \a band a radio tuner is tuned to has changed.
- \since 1.0
*/
/*!
Sets the frequecy \a band a radio tuner is tuned to.
Changing the frequency band will reset the frequency to the minimum frequency of the new band.
- \since 1.0
*/
/*!
Identifies if a frequency \a band is supported.
Returns true if the band is supported, and false if it is not.
- \since 1.0
*/
/*!
\fn int QRadioTunerControl::frequency() const
Returns the frequency a radio tuner is tuned to.
- \since 1.0
*/
/*!
Returns the number of Hertz to increment the frequency by when stepping through frequencies
within a given \a band.
- \since 1.0
*/
/*!
\fn QPair<int,int> QRadioTunerControl::frequencyRange(QRadioTuner::Band band) const
Returns a frequency \a band's minimum and maximum frequency.
- \since 1.0
*/
/*!
\fn void QRadioTunerControl::setFrequency(int frequency)
Sets the \a frequency a radio tuner is tuned to.
- \since 1.0
*/
/*!
Identifies if a radio tuner is receiving a stereo signal.
Returns true if the tuner is receiving a stereo signal, and false if it is not.
- \since 1.0
*/
/*!
Returns a radio tuner's stereo mode.
- \since 1.0
\sa QRadioTuner::StereoMode
*/
Sets a radio tuner's stereo \a mode.
- \since 1.0
\sa QRadioTuner::StereoMode
*/
\fn int QRadioTunerControl::signalStrength() const
Return a radio tuner's current signal strength as a percentage.
- \since 1.0
*/
/*!
\fn int QRadioTunerControl::volume() const
Returns the volume of a radio tuner's audio output as a percentage.
- \since 1.0
*/
/*!
\fn void QRadioTunerControl::setVolume(int volume)
Sets the percentage \a volume of a radio tuner's audio output.
- \since 1.0
*/
/*!
Identifies if a radio tuner's audio output is muted.
Returns true if the audio is muted, and false if it is not.
- \since 1.0
*/
/*!
\fn void QRadioTunerControl::setMuted(bool muted)
Sets the \a muted state of a radio tuner's audio output.
- \since 1.0
*/
/*!
Identifies if a radio tuner is currently scanning for signal.
Returns true if the tuner is scanning, and false if it is not.
- \since 1.0
*/
/*!
\fn void QRadioTunerControl::searchForward()
Starts a forward scan for a signal, starting from the current \l frequency().
- \since 1.0
*/
/*!
\fn void QRadioTunerControl::searchBackward()
Starts a backwards scan for a signal, starting from the current \l frequency().
- \since 1.0
*/
/*!
\fn void QRadioTunerControl::searchAllStations()
Starts a scan through the whole frequency band searching all stations
- \since 5.0
*/
/*!
\fn void QRadioTunerControl::cancelSearch()
Stops scanning for a signal.
- \since 1.0
*/
/*!
\fn void QRadioTunerControl::start()
Activate the radio device.
- \since 1.0
*/
/*!
\fn QRadioTunerControl::stop()
Deactivate the radio device.
- \since 1.0
*/
/*!
\fn QRadioTuner::Error QRadioTunerControl::error() const
Returns the error state of a radio tuner.
- \since 1.0
*/
/*!
\fn QString QRadioTunerControl::errorString() const
Returns a string describing a radio tuner's error state.
- \since 1.0
*/
/*!
\fn void QRadioTunerControl::stateChanged(QRadioTuner::State state)
Signals that the \a state of a radio tuner has changed.
- \since 1.0
*/
\fn void QRadioTunerControl::frequencyChanged(int frequency)
Signals that the \a frequency a radio tuner is tuned to has changed.
- \since 1.0
*/
/*!
\fn void QRadioTunerControl::stereoStatusChanged(bool stereo)
Signals that the \a stereo state of a radio tuner has changed.
- \since 1.0
*/
/*!
\fn void QRadioTunerControl::searchingChanged(bool searching)
Signals that the \a searching state of a radio tuner has changed.
- \since 1.0
*/
/*!
\fn void QRadioTunerControl::signalStrengthChanged(int strength)
Signals that the percentage \a strength of the signal received by a radio tuner has changed.
- \since 1.0
*/
/*!
\fn void QRadioTunerControl::volumeChanged(int volume)
Signals that the percentage \a volume of radio tuner's audio output has changed.
- \since 1.0
*/
/*!
\fn void QRadioTunerControl::mutedChanged(bool muted)
Signals that the \a muted state of a radio tuner's audio output has changed.
- \since 1.0
*/
/*!
\fn void QRadioTunerControl::error(QRadioTuner::Error error)
Signals that an \a error has occurred.
- \since 1.0
*/
/*!
\fn void QRadioTunerControl::stationFound(int frequency)
Signals that new station with \a frequency was found when scanning
- \since 5.0
*/
#include "moc_qradiotunercontrol.cpp"
\brief The QVideoDeviceControl class provides an video device selector media control.
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.0
The QVideoDeviceControl class provides descriptions of the video devices
available on a system and allows one to be selected as the endpoint of a
\fn QVideoDeviceControl::deviceCount() const
Returns the number of available video devices;
- \since 1.0
*/
/*!
\fn QVideoDeviceControl::deviceName(int index) const
Returns the name of the video device at \a index.
- \since 1.0
*/
/*!
\fn QVideoDeviceControl::deviceDescription(int index) const
Returns a description of the video device at \a index.
- \since 1.0
*/
/*!
\fn QVideoDeviceControl::defaultDevice() const
Returns the index of the default video device.
- \since 1.0
*/
/*!
\fn QVideoDeviceControl::selectedDevice() const
Returns the index of the selected video device.
- \since 1.0
*/
/*!
\fn QVideoDeviceControl::setSelectedDevice(int index)
Sets the selected video device \a index.
- \since 1.0
*/
/*!
\fn QVideoDeviceControl::devicesChanged()
Signals that the list of available video devices has changed.
- \since 1.0
*/
/*!
\fn QVideoDeviceControl::selectedDeviceChanged(int index)
Signals that the selected video device \a index has changed.
- \since 1.0
*/
/*!
\fn QVideoDeviceControl::selectedDeviceChanged(const QString &name)
Signals that the selected video device \a name has changed.
- \since 1.0
*/
#include "moc_qvideodevicecontrol.cpp"
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.0
\brief The QVideoEncoderControl class provides access to the settings
of a media service that performs video encoding.
\fn QVideoEncoderControl::supportedVideoCodecs() const
Returns the list of supported video codecs.
- \since 1.0
*/
/*!
\fn QVideoEncoderControl::videoCodecDescription(const QString &codec) const
Returns a description of a video \a codec.
- \since 1.0
*/
/*!
Returns a list of supported encoding options for a video \a codec.
The names and types of the options in the list is system dependent.
- \since 1.0
*/
/*!
\fn QVideoEncoderControl::encodingOption(const QString &codec, const QString &option) const
Returns the value of a video \a codec \a option.
- \since 1.0
*/
/*!
\fn QVideoEncoderControl::setEncodingOption(const QString &codec, const QString &option, const QVariant &value)
Sets the \a value of a \a codec specific \a option.
- \since 1.0
*/
/*!
If the encoder supports arbitrary resolutions within the supported resolutions range,
*\a continuous is set to true, otherwise *\a continuous is set to false.
- \since 1.0
\sa QVideoEncoderSettings::resolution()
*/
If the encoder supports arbitrary frame rates within the supported range,
*\a continuous is set to true, otherwise *\a continuous is set to false.
- \since 1.0
\sa QVideoEncoderSettings::frameRate()
*/
The returned value may be different tha passed to QVideoEncoderControl::setVideoSettings()
if the settings contains the default or undefined parameters.
In this case if the undefined parameters are already resolved, they should be returned.
- \since 1.0
*/
/*!
\fn QVideoEncoderControl::setVideoSettings(const QVideoEncoderSettings &settings)
Sets the selected video encoder \a settings.
- \since 1.0
*/
#include "moc_qvideoencodercontrol.cpp"
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.0
Using the surface() property of QVideoRendererControl a
QAbstractVideoSurface may be set as the video render target of a
\fn QVideoRendererControl::surface() const
Returns the surface a video producer renders to.
- \since 1.0
*/
/*!
\fn QVideoRendererControl::setSurface(QAbstractVideoSurface *surface)
Sets the \a surface a video producer renders to.
- \since 1.0
*/
#include "moc_qvideorenderercontrol.cpp"
\brief The QMediaImageViewer class provides a means of viewing image media.
\inmodule QtMultimedia
\ingroup multimedia
- \since 1.0
QMediaImageViewer is used together with a media display object such as
/*!
\property QMediaImageViewer::state
\brief the playlist control state of a slide show.
- \since 1.0
*/
QMediaImageViewer::State QMediaImageViewer::state() const
\fn QMediaImageViewer::stateChanged(QMediaImageViewer::State state)
Signals that the playlist control \a state of an image viewer has changed.
- \since 1.0
*/
/*!
\property QMediaImageViewer::mediaStatus
\brief the status of the current media.
- \since 1.0
*/
QMediaImageViewer::MediaStatus QMediaImageViewer::mediaStatus() const
\fn QMediaImageViewer::mediaStatusChanged(QMediaImageViewer::MediaStatus status)
Signals the the \a status of the current media has changed.
- \since 1.0
*/
/*!
\property QMediaImageViewer::media
\brief the media an image viewer is presenting.
- \since 1.0
*/
QMediaContent QMediaImageViewer::media() const
/*!
Use \a playlist as the source of images to be displayed in the viewer.
- \since 1.0
*/
void QMediaImageViewer::setPlaylist(QMediaPlaylist *playlist)
{
/*!
Returns the current playlist, or 0 if none.
- \since 1.0
*/
QMediaPlaylist *QMediaImageViewer::playlist() const
{
\fn QMediaImageViewer::mediaChanged(const QMediaContent &media)
Signals that the \a media an image viewer is presenting has changed.
- \since 1.0
*/
/*!
image.
The timeout only applies if the image viewer has a playlist attached and is in the PlayingState.
- \since 1.0
*/
int QMediaImageViewer::timeout() const
The elapsed time only increases while the image viewer is in the PlayingState. If stopped the
elapsed time will be reset to 0.
- \since 1.0
*/
int QMediaImageViewer::elapsedTime() const
in the PlayingState and an image is loaded. The notification interval
is controlled by the QMediaObject::notifyInterval property.
- \since 1.0
\sa timeout, QMediaObject::notifyInterval
*/
Sets a video \a widget as the current video output.
This will unbind any previous video output bound with setVideoOutput().
- \since 1.1
*/
void QMediaImageViewer::setVideoOutput(QVideoWidget *widget)
Sets a video \a item as the current video output.
This will unbind any previous video output bound with setVideoOutput().
- \since 1.1
*/
void QMediaImageViewer::setVideoOutput(QGraphicsVideoItem *item)
If a video output has already been set on the image viewer the new surface
will replace it.
- \since 1.2
*/
void QMediaImageViewer::setVideoOutput(QAbstractVideoSurface *surface)
/*!
\internal
- \since 1.0
*/
bool QMediaImageViewer::bind(QObject *object)
{
/*!
\internal
- \since 1.0
*/
void QMediaImageViewer::unbind(QObject *object)
{
it will resume from the current media.
If no playlist is attached to an image viewer this will do nothing.
- \since 1.0
*/
void QMediaImageViewer::play()
{
The current media and elapsed time are retained. If resumed, the current image will be
displayed for the remainder of the time out period before the next image is loaded.
- \since 1.0
*/
void QMediaImageViewer::pause()
{
The current media is retained, but the elapsed time is discarded. If resumed, the current
image will be displayed for the full time out period before the next image is loaded.
- \since 1.0
*/
void QMediaImageViewer::stop()
{
\reimp
\internal
- \since 1.0
*/
void QMediaImageViewer::timerEvent(QTimerEvent *event)
{
/*!
\class QMediaImageViewerService
- \since 1.0
\internal
*/
/*!
\class QMediaImageViewerControl
\internal
- \since 1.1
*/
QMediaImageViewerControl::QMediaImageViewerControl(QMediaImageViewerService *parent)
: QMediaControl(*new QMediaImageViewerControlPrivate, parent)
}
/*!
- \since 1.1
*/
QMediaImageViewer::MediaStatus QMediaImageViewerControl::mediaStatus() const
{
/*!
\fn QMediaImageViewerControl::mediaStatusChanged(QMediaImageViewer::MediaStatus status);
- \since 1.1
*/
/*!
- \since 1.1
*/
void QMediaImageViewerControl::showMedia(const QMediaContent &media)
{
\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
\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"
\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
/*!
Constructs a media content with \a url providing a reference to the content.
- \since 1.0
*/
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):
/*!
Constructs a media content with \a resource providing a reference to the content.
- \since 1.0
*/
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):
/*!
Constructs a copy of the media content \a other.
- \since 1.0
*/
QMediaContent::QMediaContent(const QMediaContent &other):
/*!
Assigns the value of \a other to this media content.
- \since 1.0
*/
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
/*!
Returns true if \a other is not equivalent to this media content; false otherwise.
- \since 1.0
*/
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
/*!
Returns a QUrl that represents that canonical resource for this media content.
- \since 1.0
*/
QUrl QMediaContent::canonicalUrl() const
/*!
Returns a QNetworkRequest that represents that canonical resource for this media content.
- \since 1.0
*/
QNetworkRequest QMediaContent::canonicalRequest() const
/*!
Returns a QMediaResource that represents that canonical resource for this media content.
- \since 1.0
*/
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
\brief The QMediaPlayer class allows the playing of a media source.
\inmodule QtMultimedia
\ingroup multimedia
- \since 1.0
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):
This is only valid if a stream was passed to setMedia().
- \since 1.0
\sa setMedia()
*/
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)
{
/*!
Returns the current error state.
- \since 1.0
*/
QMediaPlayer::Error QMediaPlayer::error() 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
{
//public Q_SLOTS:
/*!
Start or resume playing the current source.
- \since 1.0
*/
void QMediaPlayer::play()
/*!
Pause playing the current source.
- \since 1.0
*/
void QMediaPlayer::pause()
/*!
Stop playing, and reset the play position to the beginning.
- \since 1.0
*/
void QMediaPlayer::stop()
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)
/*!
\internal
- \since 1.0
*/
bool QMediaPlayer::bind(QObject *obj)
/*!
\internal
- \since 1.0
*/
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,
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)
{
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)
{
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)
{
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)
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.
*/
Signals that the \a status of the current media has changed.
- \since 1.0
\sa mediaStatus()
*/
Signals that the current playing content will be obtained from \a media.
- \since 1.0
\sa media()
*/
\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
By default this property is QMediaPlayer::Stopped
- \since 1.0
\sa mediaStatus(), play(), pause(), stop()
*/
\property QMediaPlayer::error
\brief a string describing the last error condition.
- \since 1.0
\sa error()
*/
information relating to the current media source and to cease all I/O operations related
to that media.
- \since 1.0
\sa QMediaContent
*/
QMediaPlaylist::setCurrentIndex(int) instead of QMediaPlayer::setMedia(),
otherwise the current playlist will be discarded.
- \since 1.0
\sa QMediaContent
*/
By default this property is QMediaPlayer::NoMedia
- \since 1.0
\sa state
*/
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
*/
/*!
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
*/
/*!
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
*/
/*!
\brief the muted state of the current media.
The value will be true if the playback volume is muted; otherwise false.
- \since 1.0
*/
/*!
filled before playback can resume, at which time the MediaStatus will be
BufferedMedia.
- \since 1.0
\sa mediaStatus()
*/
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
*/
/*!
QMediaContent, this property may change over time, the
videoAvailableChanged signal can be used to monitor it's status.
- \since 1.0
\sa QVideoWidget, QMediaContent
*/
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
*/
/*!
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
*/
/*!
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
*/
/*!
\class QMediaPlaylist
\inmodule QtMultimedia
\ingroup multimedia
- \since 1.0
\brief The QMediaPlaylist class provides a list of media content to play.
/*!
Returns the QMediaObject instance that this QMediaPlaylist is bound too,
or 0 otherwise.
- \since 1.0
*/
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)
{
This property defines the order, items in playlist are played.
- \since 1.0
\sa QMediaPlaylist::PlaybackMode
*/
/*!
Returns position of the current media content in the playlist.
- \since 1.0
*/
int QMediaPlaylist::currentIndex() const
{
/*!
Returns the current media content.
- \since 1.0
*/
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
Returns the index of the item, which would be current after calling previous()
\a steps times.
- \since 1.0
\sa QMediaPlaylist::playbackMode
*/
/*!
Returns the number of items in the playlist.
- \since 1.0
\sa isEmpty()
*/
int QMediaPlaylist::mediaCount() const
/*!
Returns true if the playlist contains no items; otherwise returns false.
- \since 1.0
\sa mediaCount()
*/
bool QMediaPlaylist::isEmpty() const
/*!
Returns true if the playlist can be modified; otherwise returns false.
- \since 1.0
\sa mediaCount()
*/
bool QMediaPlaylist::isReadOnly() const
/*!
Returns the media content at \a index in the playlist.
- \since 1.0
*/
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)
{
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)
{
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)
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)
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)
{
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)
{
Remove all the items from the playlist.
Returns true if the operation is successful, otherwise return false.
- \since 1.0
*/
bool QMediaPlaylist::clear()
{
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)
{
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)
{
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)
{
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)
{
/*!
Returns the last error condition.
- \since 1.0
*/
QMediaPlaylist::Error QMediaPlaylist::error() const
{
/*!
Returns the string describing the last error condition.
- \since 1.0
*/
QString QMediaPlaylist::errorString() const
{
/*!
Shuffle items in the playlist.
- \since 1.0
*/
void QMediaPlaylist::shuffle()
{
/*!
Advance to the next media content in playlist.
- \since 1.0
*/
void QMediaPlaylist::next()
{
/*!
Return to the previous media content in playlist.
- \since 1.0
*/
void QMediaPlaylist::previous()
{
/*!
Activate media content from playlist at position \a playlistPosition.
- \since 1.0
*/
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
*/
/*!
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
*/
/*!
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
*/
/*!
\brief The QMediaPlaylistReader class provides an interface for reading a playlist file.
\inmodule QtMultimedia
- \since 1.0
\sa QMediaPlaylistIOPlugin
*/
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
*/
/*!
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
*/
/*!
\brief The QMediaPlaylistWriter class provides an interface for writing a playlist file.
- \since 1.0
\sa QMediaPlaylistIOPlugin
*/
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
*/
/*!
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
*/
/*!
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
*/
/*!
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
*/
/*!
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
*/
/*!
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
*/
/*!
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"
\brief The QMediaPlaylistNavigator class provides navigation for a media playlist.
\inmodule QtMultimedia
\ingroup multimedia
- \since 1.0
\sa QMediaPlaylist, QMediaPlaylistProvider
*/
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)
/*! \property QMediaPlaylistNavigator::playbackMode
Contains the playback mode.
- \since 1.0
*/
QMediaPlaylist::PlaybackMode QMediaPlaylistNavigator::playbackMode() const
{
/*!
Sets the playback \a mode.
- \since 1.0
*/
void QMediaPlaylistNavigator::setPlaybackMode(QMediaPlaylist::PlaybackMode mode)
{
/*!
Returns the playlist being navigated.
- \since 1.0
*/
QMediaPlaylistProvider *QMediaPlaylistNavigator::playlist() const
/*!
Sets the \a playlist to navigate.
- \since 1.0
*/
void QMediaPlaylistNavigator::setPlaylist(QMediaPlaylistProvider *playlist)
{
Contains the media at the current position in the playlist.
- \since 1.0
\sa currentIndex()
*/
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
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
/*!
Returns the media at a \a position in the playlist.
- \since 1.0
*/
QMediaContent QMediaPlaylistNavigator::itemAt(int position) const
{
If no media is current, the property contains -1.
- \since 1.0
\sa nextIndex(), previousIndex()
*/
If the position is beyond the end of the playlist, this value
returned is -1.
- \since 1.0
\sa currentIndex(), previousIndex(), playbackMode()
*/
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
/*!
Advances to the next item in the playlist.
- \since 1.0
\sa previous(), jump(), playbackMode()
*/
void QMediaPlaylistNavigator::next()
/*!
Returns to the previous item in the playlist,
- \since 1.0
\sa next(), jump(), playbackMode()
*/
void QMediaPlaylistNavigator::previous()
/*!
Jumps to a new \a position in the playlist.
- \since 1.0
*/
void QMediaPlaylistNavigator::jump(int position)
{
/*!
\internal
- \since 1.0
*/
void QMediaPlaylistNavigatorPrivate::_q_mediaInserted(int start, int end)
{
/*!
\internal
- \since 1.0
*/
void QMediaPlaylistNavigatorPrivate::_q_mediaRemoved(int start, int end)
{
/*!
\internal
- \since 1.0
*/
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"
\brief The QMediaPlaylistProvider class provides an abstract list of media.
\inmodule QtMultimedia
- \since 1.0
\sa QMediaPlaylist
*/
\fn QMediaPlaylistProvider::mediaCount() const;
Returns the size of playlist.
- \since 1.0
*/
/*!
Returns the media at \a index in the playlist.
If the index is invalid this will return a null media content.
- \since 1.0
*/
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)
{
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)
{
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)
{
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)
{
/*!
Returns true if a playlist is read-only; otherwise returns false.
- \since 1.0
*/
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)
{
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)
{
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)
{
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)
{
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)
{
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)
{
Removes all media from a playlist.
Returns true if the media was removed; and false otherwise.
- \since 1.0
*/
bool QMediaPlaylistProvider::clear()
{
/*!
Shuffles the contents of a playlist.
- \since 1.0
*/
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
*/
/*!
Signals that new media has been inserted into a playlist between the \a start and \a end
positions.
- \since 1.0
*/
/*!
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"
\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
/*!
Constructs a media resource with the given \a mimeType from a \a url.
- \since 1.0
*/
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)
{
/*!
Constructs a copy of a media resource \a other.
- \since 1.0
*/
QMediaResource::QMediaResource(const QMediaResource &other)
: values(other.values)
/*!
Assigns the value of \a other to a media resource.
- \since 1.0
*/
QMediaResource &QMediaResource::operator =(const QMediaResource &other)
{
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
{
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
{
Identifies if a media resource is null.
Returns true if the resource is null, and false otherwise.
- \since 1.0
*/
bool QMediaResource::isNull() const
{
/*!
Returns the URL of a media resource.
- \since 1.0
*/
QUrl QMediaResource::url() const
{
/*!
Returns the network request associated with this media resource.
- \since 1.0
*/
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
{
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
{
/*!
Sets the \a language of a media resource.
- \since 1.0
*/
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
{
/*!
Sets the audio \a codec of a media resource.
- \since 1.0
*/
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
{
/*!
Sets the video \a codec of media resource.
- \since 1.0
*/
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
{
/*!
Sets the \a size in bytes of a media resource.
- \since 1.0
*/
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
{
/*!
Sets the bit \a rate in bits per second of a media resource's video stream.
- \since 1.0
*/
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
{
/*!
Sets the audio \a sampleRate of a media resource.
- \since 1.0
*/
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
{
/*!
Sets the number of audio \a channels in a media resource.
- \since 1.0
*/
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
{
/*!
Sets the bit \a rate in bits per second of a media resource's video stream.
- \since 1.0
*/
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
{
/*!
Sets the \a resolution in pixels of a media resource.
- \since 1.0
*/
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)
{
\class QMediaBindableInterface
\inmodule QtMultimedia
\ingroup multimedia
- \since 1.0
\brief The QMediaBindableInterface class is the base class for objects extending media objects functionality.
\fn QMediaBindableInterface::mediaObject() const;
Return the currently attached media object.
- \since 1.0
*/
Attaches to the media \a object.
Returns true if attached successfully, otherwise returns false.
- \since 1.0
*/
\class QMediaControl
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.0
\brief The QMediaControl class provides a base interface for media service controls.
/*!
Constructs a media control with the given \a parent.
- \since 1.0
*/
QMediaControl::QMediaControl(QObject *parent)
/*!
\internal
- \since 1.0
*/
QMediaControl::QMediaControl(QMediaControlPrivate &dd, QObject *parent)
\inmodule QtMultimedia
\ingroup multimedia
- \since 1.0
QMediaObject derived classes provide access to the functionality of a
QMediaService. Each media object hosts a QMediaService and uses the
/*!
Returns the service availability error state.
- \since 1.0
*/
QtMultimedia::AvailabilityError QMediaObject::availabilityError() const
/*!
Returns true if the service is available for use.
- \since 1.0
*/
bool QMediaObject::isAvailable() const
/*!
Returns the media service that provides the functionality of this multimedia object.
- \since 1.0
*/
QMediaService* QMediaObject::service() const
The object passed must implement the QMediaBindableInterface interface.
- \since 1.0
\sa QMediaBindableInterface
*/
bool QMediaObject::bind(QObject *object)
will be generated if the object was not previously bound to this
object.
- \since 1.0
\sa QMediaBindableInterface
*/
void QMediaObject::unbind(QObject *object)
This class is meant as a base class for multimedia objects so this
constructor is protected.
- \since 1.0
*/
QMediaObject::QMediaObject(QObject *parent, QMediaService *service):
Watch the property \a name. The property's notify signal will be emitted
once every \code notifyInterval milliseconds.
- \since 1.0
\sa notifyInterval
*/
Remove property \a name from the list of properties whose changes are
regularly signaled.
- \since 1.0
\sa notifyInterval
*/
The interval is expressed in milliseconds, the default value is 1000.
- \since 1.0
\sa addPropertyWatch(), removePropertyWatch()
*/
\fn void QMediaObject::notifyIntervalChanged(int milliseconds)
Signal a change in the notify interval period to \a milliseconds.
- \since 1.0
*/
/*!
Returns true if there is meta-data associated with this media object, else false.
- \since 1.0
*/
bool QMediaObject::isMetaDataAvailable() const
\fn QMediaObject::metaDataAvailableChanged(bool available)
Signals that the \a available state of a media object's meta-data has changed.
- \since 1.0
*/
/*!
Returns the value associated with a meta-data \a key.
- \since 1.0
*/
QVariant QMediaObject::metaData(QtMultimedia::MetaData key) const
{
/*!
Returns a list of keys there is meta-data available for.
- \since 1.0
*/
QList<QtMultimedia::MetaData> QMediaObject::availableMetaData() const
{
\fn QMediaObject::metaDataChanged()
Signals that this media object's meta-data has changed.
- \since 1.0
*/
/*!
The naming and type of extended meta-data is not standardized, so the values and meaning
of keys may vary between backends.
- \since 1.0
*/
QVariant QMediaObject::extendedMetaData(const QString &key) const
{
/*!
Returns a list of keys there is extended meta-data available for.
- \since 1.0
*/
QStringList QMediaObject::availableExtendedMetaData() const
{
\fn QMediaObject::availabilityChanged(bool available)
Signal emitted when the availability state has changed to \a available
- \since 1.0
*/
service implementations.
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.0
Media services provide implementations of the functionality promised
Controls must be returned to the service when no longer needed using the
releaseControl() function.
- \since 1.0
*/
/*!
Controls must be returned to the service when no longer needed using the
releaseControl() function.
- \since 1.0
*/
/*!
\fn void QMediaService::releaseControl(QMediaControl *control);
Releases a \a control back to the service.
- \since 1.0
*/
#include "moc_qmediaservice.cpp"
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.0
The QMediaServiceProvider class uses hints to select an appropriate media service.
*/
This type of hint describes a service that is able to play content of a specific MIME \a type
encoded with one or more of the listed \a codecs.
- \since 1.0
*/
QMediaServiceProviderHint::QMediaServiceProviderHint(const QString &type, const QStringList& codecs)
:d(new QMediaServiceProviderHintPrivate(ContentType))
Constructs a Device media service provider hint.
This type of hint describes a media service that utilizes a specific \a device.
- \since 1.0
*/
QMediaServiceProviderHint::QMediaServiceProviderHint(const QByteArray &device)
:d(new QMediaServiceProviderHintPrivate(Device))
Constructs a SupportedFeatures media service provider hint.
This type of hint describes a service which supports a specific set of \a features.
- \since 1.0
*/
QMediaServiceProviderHint::QMediaServiceProviderHint(QMediaServiceProviderHint::Features features)
:d(new QMediaServiceProviderHintPrivate(SupportedFeatures))
/*!
Constructs a copy of the media service provider hint \a other.
- \since 1.0
*/
QMediaServiceProviderHint::QMediaServiceProviderHint(const QMediaServiceProviderHint &other)
:d(other.d)
/*!
Assigns the value \a other to a media service provider hint.
- \since 1.0
*/
QMediaServiceProviderHint& QMediaServiceProviderHint::operator=(const QMediaServiceProviderHint &other)
{
Identifies if \a other is of equal value to a media service provider hint.
Returns true if the hints are equal, and false if they are not.
- \since 1.0
*/
bool QMediaServiceProviderHint::operator == (const QMediaServiceProviderHint &other) const
{
Identifies if \a other is not of equal value to a media service provider hint.
Returns true if the hints are not equal, and false if they are.
- \since 1.0
*/
bool QMediaServiceProviderHint::operator != (const QMediaServiceProviderHint &other) const
{
/*!
Returns true if a media service provider is null.
- \since 1.0
*/
bool QMediaServiceProviderHint::isNull() const
{
/*!
Returns the type of a media service provider hint.
- \since 1.0
*/
QMediaServiceProviderHint::Type QMediaServiceProviderHint::type() const
{
/*!
Returns the mime type of the media a service is expected to be able play.
- \since 1.0
*/
QString QMediaServiceProviderHint::mimeType() const
{
/*!
Returns a list of codes a media service is expected to be able to decode.
- \since 1.0
*/
QStringList QMediaServiceProviderHint::codecs() const
{
/*!
Returns the name of a device a media service is expected to utilize.
- \since 1.0
*/
QByteArray QMediaServiceProviderHint::device() const
{
/*!
Returns a set of features a media service is expected to provide.
- \since 1.0
*/
QMediaServiceProviderHint::Features QMediaServiceProviderHint::features() const
{
\class QMediaServiceProvider
\brief The QMediaServiceProvider class provides an abstract allocator for media services.
- \since 1.0
*/
/*!
The returned service must be released with releaseService when it is
finished with.
- \since 1.0
*/
/*!
\fn QMediaServiceProvider::releaseService(QMediaService *service)
Releases a media \a service requested with requestService().
- \since 1.0
*/
/*!
serviceType service that is able to play media of a specific \a mimeType
that is encoded using the listed \a codecs while adhering to constraints
identified in \a flags.
- \since 1.0
*/
QtMultimedia::SupportEstimate QMediaServiceProvider::hasSupport(const QByteArray &serviceType,
const QString &mimeType,
The resultant list is restricted to MIME types which can be supported given
the constraints in \a flags.
- \since 1.0
*/
QStringList QMediaServiceProvider::supportedMimeTypes(const QByteArray &serviceType, int flags) const
{
/*!
Returns the list of devices related to \a service type.
- \since 1.0
*/
QList<QByteArray> QMediaServiceProvider::devices(const QByteArray &service) const
{
/*!
Returns the description of \a device related to \a serviceType, suitable for use by
an application for display.
- \since 1.0
*/
QString QMediaServiceProvider::deviceDescription(const QByteArray &serviceType, const QByteArray &device)
{
Sets a media service \a provider as the default.
\internal
- \since 1.0
*/
void QMediaServiceProvider::setDefaultServiceProvider(QMediaServiceProvider *provider)
{
\brief The QMediaServiceProviderPlugin class interface provides an interface for QMediaService
plug-ins.
- \since 1.0
A media service provider plug-in may implement one or more of
QMediaServiceSupportedFormatsInterface,
\fn QMediaServiceProviderPlugin::keys() const
Returns a list of keys for media services a plug-in can create.
- \since 1.0
*/
/*!
Constructs a new instance of the QMediaService identified by \a key.
The QMediaService returned must be destroyed with release().
- \since 1.0
*/
/*!
\fn QMediaServiceProviderPlugin::release(QMediaService *service)
Destroys a media \a service constructed with create().
- \since 1.0
*/
\class QMediaServiceSupportedFormatsInterface
\brief The QMediaServiceSupportedFormatsInterface class interface
identifies if a media service plug-in supports a media format.
- \since 1.0
A QMediaServiceProviderPlugin may implement this interface.
*/
Returns the level of support a media service plug-in has for a \a mimeType
and set of \a codecs.
- \since 1.0
*/
/*!
\fn QMediaServiceSupportedFormatsInterface::supportedMimeTypes() const
Returns a list of MIME types supported by the media service plug-in.
- \since 1.0
*/
/*!
\class QMediaServiceSupportedDevicesInterface
\brief The QMediaServiceSupportedDevicesInterface class interface
identifies the devices supported by a media service plug-in.
- \since 1.0
A QMediaServiceProviderPlugin may implement this interface.
*/
\fn QMediaServiceSupportedDevicesInterface::devices(const QByteArray &service) const
Returns a list of devices supported by a plug-in \a service.
- \since 1.0
*/
/*!
\fn QMediaServiceSupportedDevicesInterface::deviceDescription(const QByteArray &service, const QByteArray &device)
Returns a description of a \a device supported by a plug-in \a service.
- \since 1.0
*/
/*!
\class QMediaServiceFeaturesInterface
\brief The QMediaServiceFeaturesInterface class interface identifies
features supported by a media service plug-in.
- \since 1.0
A QMediaServiceProviderPlugin may implement this interface.
*/
\fn QMediaServiceFeaturesInterface::supportedFeatures(const QByteArray &service) const
Returns a set of features supported by a plug-in \a service.
- \since 1.0
*/
#include "moc_qmediaserviceprovider.cpp"
\brief The QMediaTimeInterval class represents a time interval with integer precision.
\inmodule QtMultimedia
\ingroup multimedia
- \since 1.0
An interval is specified by an inclusive start() and end() time. These
must be set in the constructor, as this is an immutable class. The
\fn QMediaTimeInterval::QMediaTimeInterval(qint64 start, qint64 end)
Constructs an interval with the specified \a start and \a end times.
- \since 1.0
*/
QMediaTimeInterval::QMediaTimeInterval(qint64 start, qint64 end)
: s(start)
\fn QMediaTimeInterval::QMediaTimeInterval(const QMediaTimeInterval &other)
Constructs an interval by taking a copy of \a other.
- \since 1.0
*/
QMediaTimeInterval::QMediaTimeInterval(const QMediaTimeInterval &other)
: s(other.s)
Returns the start time of the interval.
- \since 1.0
\sa end()
*/
qint64 QMediaTimeInterval::start() const
Returns the end time of the interval.
- \since 1.0
\sa start()
*/
qint64 QMediaTimeInterval::end() const
Returns true if the time interval contains the specified \a time.
That is, start() <= time <= end().
- \since 1.0
*/
bool QMediaTimeInterval::contains(qint64 time) const
{
Returns true if this time interval is normal.
A normal time interval has start() <= end().
- \since 1.0
\sa normalized()
*/
bool QMediaTimeInterval::isNormal() const
If the start() time of the interval is greater than the end() time,
then the returned interval has the start and end times swapped.
- \since 1.0
*/
QMediaTimeInterval QMediaTimeInterval::normalized() const
{
Returns a copy of this time interval, translated by a value of \a offset.
An interval can be moved forward through time with a positive offset, or backward
through time with a negative offset.
- \since 1.0
*/
QMediaTimeInterval QMediaTimeInterval::translated(qint64 offset) const
{
\relates QMediaTimeRange
Returns true if \a a is exactly equal to \a b.
- \since 1.0
*/
bool operator==(const QMediaTimeInterval &a, const QMediaTimeInterval &b)
{
\relates QMediaTimeRange
Returns true if \a a is not exactly equal to \a b.
- \since 1.0
*/
bool operator!=(const QMediaTimeInterval &a, const QMediaTimeInterval &b)
{
\brief The QMediaTimeRange class represents a set of zero or more disjoint
time intervals.
\ingroup multimedia
- \since 1.0
\reentrant
If the interval is not \l{QMediaTimeInterval::isNormal()}{normal},
the resulting time range will be empty.
- \since 1.0
\sa addInterval()
*/
QMediaTimeRange::QMediaTimeRange(qint64 start, qint64 end)
If \a interval is not \l{QMediaTimeInterval::isNormal()}{normal},
the resulting time range will be empty.
- \since 1.0
\sa addInterval()
*/
QMediaTimeRange::QMediaTimeRange(const QMediaTimeInterval &interval)
\fn QMediaTimeRange::QMediaTimeRange(const QMediaTimeRange &range)
Constructs a time range by copying another time \a range.
- \since 1.0
*/
QMediaTimeRange::QMediaTimeRange(const QMediaTimeRange &range)
: d(range.d)
\fn QMediaTimeRange::operator=(const QMediaTimeRange &other)
Takes a copy of the \a other time range and returns itself.
- \since 1.0
*/
QMediaTimeRange &QMediaTimeRange::operator=(const QMediaTimeRange &other)
{
\fn QMediaTimeRange::operator=(const QMediaTimeInterval &interval)
Sets the time range to a single continuous interval, \a interval.
- \since 1.0
*/
QMediaTimeRange &QMediaTimeRange::operator=(const QMediaTimeInterval &interval)
{
For empty time ranges, this value is equal to zero.
- \since 1.0
\sa latestTime()
*/
qint64 QMediaTimeRange::earliestTime() const
For empty time ranges, this value is equal to zero.
- \since 1.0
\sa earliestTime()
*/
qint64 QMediaTimeRange::latestTime() const
Adds the interval specified by \a start and \a end
to the time range.
- \since 1.0
\sa addInterval()
*/
void QMediaTimeRange::addInterval(qint64 start, qint64 end)
This operation takes \l{linear time}
- \since 1.0
\sa removeInterval()
*/
void QMediaTimeRange::addInterval(const QMediaTimeInterval &interval)
Adds each of the intervals in \a range to this time range.
Equivalent to calling addInterval() for each interval in \a range.
- \since 1.0
*/
void QMediaTimeRange::addTimeRange(const QMediaTimeRange &range)
{
Removes the interval specified by \a start and \a end
from the time range.
- \since 1.0
\sa removeInterval()
*/
void QMediaTimeRange::removeInterval(qint64 start, qint64 end)
This operation takes \l{linear time}
- \since 1.0
\sa addInterval()
*/
void QMediaTimeRange::removeInterval(const QMediaTimeInterval &interval)
Removes each of the intervals in \a range from this time range.
Equivalent to calling removeInterval() for each interval in \a range.
- \since 1.0
*/
void QMediaTimeRange::removeTimeRange(const QMediaTimeRange &range)
{
\fn QMediaTimeRange::operator+=(const QMediaTimeRange &other)
Adds each interval in \a other to the time range and returns the result.
- \since 1.0
*/
QMediaTimeRange& QMediaTimeRange::operator+=(const QMediaTimeRange &other)
{
\fn QMediaTimeRange::operator+=(const QMediaTimeInterval &interval)
Adds the specified \a interval to the time range and returns the result.
- \since 1.0
*/
QMediaTimeRange& QMediaTimeRange::operator+=(const QMediaTimeInterval &interval)
{
\fn QMediaTimeRange::operator-=(const QMediaTimeRange &other)
Removes each interval in \a other from the time range and returns the result.
- \since 1.0
*/
QMediaTimeRange& QMediaTimeRange::operator-=(const QMediaTimeRange &other)
{
\fn QMediaTimeRange::operator-=(const QMediaTimeInterval &interval)
Removes the specified \a interval from the time range and returns the result.
- \since 1.0
*/
QMediaTimeRange& QMediaTimeRange::operator-=(const QMediaTimeInterval &interval)
{
Removes all intervals from the time range.
- \since 1.0
\sa removeInterval()
*/
void QMediaTimeRange::clear()
\fn QMediaTimeRange::intervals() const
Returns the list of intervals covered by this time range.
- \since 1.0
*/
QList<QMediaTimeInterval> QMediaTimeRange::intervals() const
{
Returns true if there are no intervals within the time range.
- \since 1.0
\sa intervals()
*/
bool QMediaTimeRange::isEmpty() const
Returns true if the time range consists of a continuous interval.
That is, there is one or fewer disjoint intervals within the time range.
- \since 1.0
*/
bool QMediaTimeRange::isContinuous() const
{
\fn QMediaTimeRange::contains(qint64 time) const
Returns true if the specified \a time lies within the time range.
- \since 1.0
*/
bool QMediaTimeRange::contains(qint64 time) const
{
\relates QMediaTimeRange
Returns true if all intervals in \a a are present in \a b.
- \since 1.0
*/
bool operator==(const QMediaTimeRange &a, const QMediaTimeRange &b)
{
\relates QMediaTimeRange
Returns true if one or more intervals in \a a are not present in \a b.
- \since 1.0
*/
bool operator!=(const QMediaTimeRange &a, const QMediaTimeRange &b)
{
\fn operator+(const QMediaTimeRange &r1, const QMediaTimeRange &r2)
Returns a time range containing the union between \a r1 and \a r2.
- \since 1.0
*/
QMediaTimeRange operator+(const QMediaTimeRange &r1, const QMediaTimeRange &r2)
{
\fn operator-(const QMediaTimeRange &r1, const QMediaTimeRange &r2)
Returns a time range containing \a r2 subtracted from \a r1.
- \since 1.0
*/
QMediaTimeRange operator-(const QMediaTimeRange &r1, const QMediaTimeRange &r2)
{
\inmodule QtMultimedia
\ingroup multimedia
- \since 5.0
The radio data object will emit signals for any changes in radio data. You can enable or disable
alternative frequency with setAlternativeFrequenciesEnabled().
Constructs a radio data based on a media service allocated by a media service \a provider.
The \a parent is passed to QMediaObject.
- \since 5.0
*/
QRadioData::QRadioData(QObject *parent, QMediaServiceProvider* provider):
/*!
Returns true if the radio data service is ready to use.
- \since 5.0
*/
bool QRadioData::isAvailable() const
{
/*!
Returns the availability error state.
- \since 5.0
*/
QtMultimedia::AvailabilityError QRadioData::availabilityError() const
{
\property QRadioData::stationId
\brief Current Program Identification
- \since 5.0
*/
QString QRadioData::stationId() const
\property QRadioData::programType
\brief Current Program Type
- \since 5.0
*/
QRadioData::ProgramType QRadioData::programType() const
\property QRadioData::programTypeName
\brief Current Program Type Name
- \since 5.0
*/
QString QRadioData::programTypeName() const
\property QRadioData::stationName
\brief Current Program Service
- \since 5.0
*/
QString QRadioData::stationName() const
\property QRadioData::radioText
\brief Current Radio Text
- \since 5.0
*/
QString QRadioData::radioText() const
\property QRadioData::alternativeFrequenciesEnabled
\brief Is Alternative Frequency currently enabled
- \since 5.0
*/
bool QRadioData::isAlternativeFrequenciesEnabled() const
/*!
Returns the error state of a radio data.
- \since 5.0
\sa errorString()
*/
/*!
Returns a description of a radio data's error state.
- \since 5.0
\sa error()
*/
QString QRadioData::errorString() const
\fn void QRadioData::stationIdChanged(QString stationId)
Signals that the Program Identification code has changed to \a stationId
- \since 5.0
*/
/*!
\fn void QRadioData::programTypeChanged(QRadioData::ProgramType programType)
Signals that the Program Type code has changed to \a programType
- \since 5.0
*/
/*!
\fn void QRadioData::programTypeNameChanged(QString programTypeName)
Signals that the Program Type Name has changed to \a programTypeName
- \since 5.0
*/
/*!
\fn void QRadioData::stationNameChanged(int stationName)
Signals that the Program Service has changed to \a stationName
- \since 5.0
*/
/*!
\fn void QRadioData::alternativeFrequenciesEnabledChanged(bool enabled)
Signals that the AF has been enabled or disabled
- \since 5.0
*/
/*!
\fn void QRadioData::error(QRadioData::Error error)
Signals that an \a error occurred.
- \since 5.0
*/
/*!
/*! \fn void QRadioData::stateChanged(QRadioData::State state)
This signal is emitted when the state changes to \a state.
- \since 5.0
*/
#include "moc_qradiodata.cpp"
\inmodule QtMultimedia
\ingroup multimedia
- \since 1.0
You can control the systems analog radio device using this interface, for example:
Constructs a radio tuner based on a media service allocated by a media service \a provider.
The \a parent is passed to QMediaObject.
- \since 1.0
*/
QRadioTuner::QRadioTuner(QObject *parent, QMediaServiceProvider* provider):
/*!
Returns true if the radio tuner service is ready to use.
- \since 1.0
*/
bool QRadioTuner::isAvailable() const
{
/*!
Returns the availability error state.
- \since 1.0
*/
QtMultimedia::AvailabilityError QRadioTuner::availabilityError() const
{
\property QRadioTuner::state
Return the current radio tuner state.
- \since 1.0
\sa QRadioTuner::State
*/
\property QRadioTuner::band
\brief the frequency band a radio tuner is tuned to.
- \since 1.0
\sa QRadioTuner::Band
*/
/*!
\property QRadioTuner::frequency
\brief the frequency in Hertz a radio tuner is tuned to.
- \since 1.0
*/
int QRadioTuner::frequency() const
/*!
Returns the number of Hertz to increment the frequency by when stepping through frequencies
within a given \a band.
- \since 1.0
*/
int QRadioTuner::frequencyStep(QRadioTuner::Band band) const
/*!
Returns a frequency \a band's minimum and maximum frequency.
- \since 1.0
*/
QPair<int,int> QRadioTuner::frequencyRange(QRadioTuner::Band band) const
/*!
\property QRadioTuner::stereo
\brief whether a radio tuner is receiving a stereo signal.
- \since 1.0
*/
bool QRadioTuner::isStereo() const
/*!
\property QRadioTuner::stereoMode
\brief the stereo mode of a radio tuner.
- \since 1.0
*/
QRadioTuner::StereoMode QRadioTuner::stereoMode() const
Identifies if a frequency \a band is supported by a radio tuner.
Returns true if the band is supported, and false if it is not.
- \since 1.0
*/
bool QRadioTuner::isBandSupported(QRadioTuner::Band band) const
/*!
Activate the radio device.
- \since 1.0
*/
void QRadioTuner::start()
/*!
Deactivate the radio device.
- \since 1.0
*/
void QRadioTuner::stop()
/*!
\property QRadioTuner::signalStrength
\brief the strength of the current radio signal as a percentage.
- \since 1.0
*/
int QRadioTuner::signalStrength() const
/*!
\property QRadioTuner::volume
\brief the volume of a radio tuner's audio output as a percentage.
- \since 1.0
*/
/*!
\property QRadioTuner::muted
\brief whether a radio tuner's audio output is muted.
- \since 1.0
*/
bool QRadioTuner::isMuted() const
Sets a radio tuner's frequency \a band.
Changing the band will reset the \l frequency to the new band's minimum frequency.
- \since 1.0
*/
void QRadioTuner::setBand(QRadioTuner::Band band)
If the tuner is set to a frequency outside the current \l band, the band will be changed to
one occupied by the new frequency.
- \since 1.0
*/
void QRadioTuner::setFrequency(int frequency)
\brief whether a radio tuner is currently scanning for a signal.
\sa searchForward(), searchBackward(), cancelSearch()
- \since 1.0
*/
bool QRadioTuner::isSearching() const
/*!
Starts a forward scan for a signal, starting from the current \l frequency.
- \since 1.0
\sa searchBackward(), cancelSearch(), searching
*/
/*!
Starts a backwards scan for a signal, starting from the current \l frequency.
- \since 1.0
\sa searchForward(), cancelSearch(), searching
*/
emitted (false). If \a searchMode is set to SearchGetStationId, searching
waits for station id (PI) on each frequency.
- \since 5.0
\sa searchForward(), searchBackward(), searching
*/
/*!
Stops scanning for a signal.
- \since 1.0
\sa searchForward(), searchBackward(), searching
*/
/*!
Returns the error state of a radio tuner.
- \since 1.0
\sa errorString()
*/
/*!
Returns a description of a radio tuner's error state.
- \since 1.0
\sa error()
*/
\fn void QRadioTuner::bandChanged(QRadioTuner::Band band)
Signals a radio tuner's \a band has changed.
- \since 1.0
*/
/*!
\fn void QRadioTuner::frequencyChanged(int frequency)
Signals that the \a frequency a radio tuner is tuned to has changed.
- \since 1.0
*/
/*!
\fn void QRadioTuner::mutedChanged(bool muted)
Signals that the \a muted state of a radio tuner's audio output has changed.
- \since 1.0
*/
/*!
\fn void QRadioTuner::volumeChanged(int volume)
Signals that the \a volume of a radio tuner's audio output has changed.
- \since 1.0
*/
/*!
\fn void QRadioTuner::searchingChanged(bool searching)
Signals that the \a searching state of a radio tuner has changed.
- \since 1.0
*/
/*!
\fn void QRadioTuner::stereoStatusChanged(bool stereo)
Signals that the \a stereo state of a radio tuner has changed.
- \since 1.0
*/
/*!
\fn void QRadioTuner::signalStrengthChanged(int strength)
Signals that the \a strength of the signal received by a radio tuner has changed.
- \since 1.0
*/
/*!
Signals that a station was found in \a frequency with \a stationId Program
Identification code.
- \since 5.0
*/
/*!
\fn void QRadioTuner::error(QRadioTuner::Error error)
Signals that an \a error occurred.
- \since 1.0
*/
/*!
/*! \fn void QRadioTuner::stateChanged(QRadioTuner::State state)
This signal is emitted when the state changes to \a state.
- \since 1.0
*/
#include "moc_qradiotuner.cpp"
\brief The QAudioCaptureSource class provides an interface to query and select an audio input endpoint.
\inmodule QtMultimedia
\ingroup multimedia
- \since 1.0
QAudioCaptureSource provides access to the audio inputs available on your system.
/*!
Construct a QAudioCaptureSource using the QMediaService from \a provider, with \a parent.
- \since 1.0
*/
QAudioCaptureSource::QAudioCaptureSource(QObject *parent, QMediaServiceProvider *provider):
/*!
Returns the error state of the audio capture service.
- \since 1.0
*/
QtMultimedia::AvailabilityError QAudioCaptureSource::availabilityError() const
/*!
Returns true if the audio capture service is available, otherwise returns false.
- \since 1.0
*/
bool QAudioCaptureSource::isAvailable() const
{
/*!
Returns a list of available audio inputs
- \since 1.0
*/
QList<QString> QAudioCaptureSource::audioInputs() const
/*!
Returns the description of the audio input device with \a name.
- \since 1.0
*/
QString QAudioCaptureSource::audioDescription(const QString& name) const
/*!
Returns the default audio input name.
- \since 1.0
*/
QString QAudioCaptureSource::defaultAudioInput() const
/*!
Returns the active audio input name.
- \since 1.0
*/
QString QAudioCaptureSource::activeAudioInput() const
/*!
Set the active audio input to \a name.
- \since 1.0
*/
void QAudioCaptureSource::setAudioInput(const QString& name)
\fn QAudioCaptureSource::activeAudioInputChanged(const QString& name)
Signal emitted when active audio input changes to \a name.
- \since 1.0
*/
/*!
\fn QAudioCaptureSource::availableAudioInputsChanged()
Signal is emitted when the available audio inputs change.
- \since 1.0
*/
/*!
\internal
- \since 1.0
*/
void QAudioCaptureSource::statusChanged()
{
\inmodule QtMultimedia
\ingroup multimedia
- \since 1.0
A audio encoder settings object is used to specify the audio encoder
settings used by QMediaRecorder. Audio encoder settings are selected by
/*!
Constructs a copy of the audio encoder settings object \a other.
- \since 1.0
*/
QAudioEncoderSettings::QAudioEncoderSettings(const QAudioEncoderSettings& other)
/*!
Assigns the value of \a other to an audio encoder settings object.
- \since 1.0
*/
QAudioEncoderSettings& QAudioEncoderSettings::operator=(const QAudioEncoderSettings &other)
Returns true if the settings objects are of equal value, and false if they
are not of equal value.
- \since 1.0
*/
bool QAudioEncoderSettings::operator==(const QAudioEncoderSettings &other) const
Returns true if the settings objects are not of equal value, and true if
they are of equal value.
- \since 1.0
*/
bool QAudioEncoderSettings::operator!=(const QAudioEncoderSettings &other) const
Identifies if an audio settings object is initialized.
Returns true if the settings object is null, and false if it is not.
- \since 1.0
*/
bool QAudioEncoderSettings::isNull() const
/*!
Returns the audio encoding mode.
- \since 1.0
\sa QtMultimedia::EncodingMode
*/
QtMultimedia::EncodingMode QAudioEncoderSettings::encodingMode() const
The audio codec, channels count and sample rate settings are used in all
the encoding modes.
- \since 1.0
\sa encodingMode(), QtMultimedia::EncodingMode
*/
void QAudioEncoderSettings::setEncodingMode(QtMultimedia::EncodingMode mode)
/*!
Returns the audio codec.
- \since 1.0
*/
QString QAudioEncoderSettings::codec() const
{
/*!
Sets the audio \a codec.
- \since 1.0
*/
void QAudioEncoderSettings::setCodec(const QString& codec)
{
/*!
Returns the bit rate of the compressed audio stream in bits per second.
- \since 1.0
*/
int QAudioEncoderSettings::bitRate() const
{
/*!
Returns the number of audio channels.
- \since 1.0
*/
int QAudioEncoderSettings::channelCount() const
{
A value of -1 indicates the encoder should make an optimal choice based on
what is available from the audio source and the limitations of the codec.
- \since 1.0
*/
void QAudioEncoderSettings::setChannelCount(int channels)
{
/*!
Sets the audio bit \a rate in bits per second.
- \since 1.0
*/
void QAudioEncoderSettings::setBitRate(int rate)
{
/*!
Returns the audio sample rate in Hz.
- \since 1.0
*/
int QAudioEncoderSettings::sampleRate() const
{
A value of -1 indicates the encoder should make an optimal choice based on what is avaialbe
from the audio source and the limitations of the codec.
- \since 1.0
*/
void QAudioEncoderSettings::setSampleRate(int rate)
{
/*!
Returns the audio encoding quality.
- \since 1.0
*/
QtMultimedia::EncodingQuality QAudioEncoderSettings::quality() const
The \a quality settings parameter is only used in the
\l {QtMultimedia::ConstantQualityEncoding}{constant quality} \l{encodingMode()}{encoding mode}.
- \since 1.0
*/
void QAudioEncoderSettings::setQuality(QtMultimedia::EncodingQuality quality)
{
\class QVideoEncoderSettings
\brief The QVideoEncoderSettings class provides a set of video encoder settings.
- \since 1.0
A video encoder settings object is used to specify the video encoder
settings used by QMediaRecorder. Video encoder settings are selected by
/*!
Constructs a copy of the video encoder settings object \a other.
- \since 1.0
*/
QVideoEncoderSettings::QVideoEncoderSettings(const QVideoEncoderSettings& other)
/*!
Assigns the value of \a other to a video encoder settings object.
- \since 1.0
*/
QVideoEncoderSettings &QVideoEncoderSettings::operator=(const QVideoEncoderSettings &other)
{
Returns true if the settings objects are of equal value, and false if they
are not of equal value.
- \since 1.0
*/
bool QVideoEncoderSettings::operator==(const QVideoEncoderSettings &other) const
{
Returns true if the settings objects are not of equal value, and false if
they are of equal value.
- \since 1.0
*/
bool QVideoEncoderSettings::operator!=(const QVideoEncoderSettings &other) const
{
Identifies if a video encoder settings object is uninitalized.
Returns true if the settings are null, and false if they are not.
- \since 1.0
*/
bool QVideoEncoderSettings::isNull() const
{
/*!
Returns the video encoding mode.
- \since 1.0
\sa QtMultimedia::EncodingMode
*/
QtMultimedia::EncodingMode QVideoEncoderSettings::encodingMode() const
The rest of encoding settings are respected regardless of encoding mode.
- \since 1.0
\sa QtMultimedia::EncodingMode
*/
void QVideoEncoderSettings::setEncodingMode(QtMultimedia::EncodingMode mode)
/*!
Returns the video codec.
- \since 1.0
*/
QString QVideoEncoderSettings::codec() const
/*!
Sets the video \a codec.
- \since 1.0
*/
void QVideoEncoderSettings::setCodec(const QString& codec)
{
/*!
Returns bit rate of the encoded video stream in bits per second.
- \since 1.0
*/
int QVideoEncoderSettings::bitRate() const
{
/*!
Sets the bit rate of the encoded video stream to \a value.
- \since 1.0
*/
void QVideoEncoderSettings::setBitRate(int value)
/*!
Returns the video frame rate.
- \since 1.0
*/
qreal QVideoEncoderSettings::frameRate() const
{
A value of 0 indicates the encoder should make an optimal choice based on what is available
from the video source and the limitations of the codec.
- \since 1.0
*/
void QVideoEncoderSettings::setFrameRate(qreal rate)
/*!
Returns the resolution of the encoded video.
- \since 1.0
*/
QSize QVideoEncoderSettings::resolution() const
An empty QSize indicates the encoder should make an optimal choice based on
what is available from the video source and the limitations of the codec.
- \since 1.0
*/
void QVideoEncoderSettings::setResolution(const QSize &resolution)
Sets the \a width and \a height of the resolution of the encoded video.
\overload
- \since 1.0
*/
void QVideoEncoderSettings::setResolution(int width, int height)
/*!
Returns the video encoding quality.
- \since 1.0
*/
QtMultimedia::EncodingQuality QVideoEncoderSettings::quality() const
The \a quality settings parameter is only used in the \l
{QtMultimedia::ConstantQualityEncoding}{constant quality}
\l{encodingMode()}{encoding mode}.
- \since 1.0
*/
void QVideoEncoderSettings::setQuality(QtMultimedia::EncodingQuality quality)
\brief The QImageEncoderSettings class provides a set of image encoder
settings.
- \since 1.0
A image encoder settings object is used to specify the image encoder
settings used by QCameraImageCapture. Image encoder settings are selected
/*!
Constructs a copy of the image encoder settings object \a other.
- \since 1.0
*/
QImageEncoderSettings::QImageEncoderSettings(const QImageEncoderSettings& other)
/*!
Assigns the value of \a other to a image encoder settings object.
- \since 1.0
*/
QImageEncoderSettings &QImageEncoderSettings::operator=(const QImageEncoderSettings &other)
{
Returns true if the settings objects are of equal value, and false if they
are not of equal value.
- \since 1.0
*/
bool QImageEncoderSettings::operator==(const QImageEncoderSettings &other) const
{
Returns true if the settings objects are not of equal value, and false if
they are of equal value.
- \since 1.0
*/
bool QImageEncoderSettings::operator!=(const QImageEncoderSettings &other) const
{
Identifies if a image encoder settings object is uninitalized.
Returns true if the settings are null, and false if they are not.
- \since 1.0
*/
bool QImageEncoderSettings::isNull() const
{
/*!
Returns the image codec.
- \since 1.0
*/
QString QImageEncoderSettings::codec() const
/*!
Sets the image \a codec.
- \since 1.0
*/
void QImageEncoderSettings::setCodec(const QString& codec)
{
/*!
Returns the resolution of the encoded image.
- \since 1.0
*/
QSize QImageEncoderSettings::resolution() const
An empty QSize indicates the encoder should make an optimal choice based on
what is available from the image source and the limitations of the codec.
- \since 1.0
*/
void QImageEncoderSettings::setResolution(const QSize &resolution)
Sets the \a width and \a height of the resolution of the encoded image.
\overload
- \since 1.0
*/
void QImageEncoderSettings::setResolution(int width, int height)
/*!
Returns the image encoding quality.
- \since 1.0
*/
QtMultimedia::EncodingQuality QImageEncoderSettings::quality() const
/*!
Sets the image encoding \a quality.
- \since 1.0
*/
void QImageEncoderSettings::setQuality(QtMultimedia::EncodingQuality quality)
\class QMediaRecorder
\inmodule QtMultimedia
\ingroup multimedia
- \since 1.0
\brief The QMediaRecorder class is used for the recording of media content.
Constructs a media recorder which records the media produced by \a mediaObject.
The \a parent is passed to QMediaObject.
- \since 1.0
*/
QMediaRecorder::QMediaRecorder(QMediaObject *mediaObject, QObject *parent):
/*!
Returns the QMediaObject instance that this QMediaRecorder is bound too,
or 0 otherwise.
- \since 1.0
*/
QMediaObject *QMediaRecorder::mediaObject() const
{
/*!
\internal
- \since 1.0
*/
bool QMediaRecorder::setMediaObject(QMediaObject *object)
{
The \a location can be relative or empty;
in this case the recorder uses the system specific place and file naming scheme.
After recording has stated, QMediaRecorder::outputLocation() returns the actual output location.
- \since 1.0
*/
/*!
Returns true if media recorder service ready to use.
- \since 1.0
*/
bool QMediaRecorder::isAvailable() const
{
/*!
Returns the availability error code.
- \since 1.0
*/
QtMultimedia::AvailabilityError QMediaRecorder::availabilityError() const
{
/*!
Returns the current media recorder state.
- \since 1.0
\sa QMediaRecorder::State
*/
/*!
Returns the current error state.
- \since 1.0
\sa errorString()
*/
/*!
Returns a string describing the current error state.
- \since 1.0
\sa error()
*/
\property QMediaRecorder::duration
\brief the recorded media duration in milliseconds.
- \since 1.0
*/
qint64 QMediaRecorder::duration() const
\property QMediaRecorder::muted
\brief whether a recording audio stream is muted.
- \since 1.0
*/
bool QMediaRecorder::isMuted() const
/*!
Returns a list of MIME types of supported container formats.
- \since 1.0
*/
QStringList QMediaRecorder::supportedContainers() const
{
/*!
Returns a description of a container format \a mimeType.
- \since 1.0
*/
QString QMediaRecorder::containerDescription(const QString &mimeType) const
{
/*!
Returns the MIME type of the selected container format.
- \since 1.0
*/
QString QMediaRecorder::containerMimeType() const
/*!
Returns a list of supported audio codecs.
- \since 1.0
*/
QStringList QMediaRecorder::supportedAudioCodecs() const
{
/*!
Returns a description of an audio \a codec.
- \since 1.0
*/
QString QMediaRecorder::audioCodecDescription(const QString &codec) const
{
If the encoder supports arbitrary sample rates within the supported rates
range, *\a continuous is set to true, otherwise *\a continuous is set to
false.
- \since 1.0
*/
QList<int> QMediaRecorder::supportedAudioSampleRates(const QAudioEncoderSettings &settings, bool *continuous) const
If the encoder supports arbitrary resolutions within the supported range,
*\a continuous is set to true, otherwise *\a continuous is set to false.
- \since 1.0
\sa QVideoEncoderSettings::resolution()
*/
QList<QSize> QMediaRecorder::supportedResolutions(const QVideoEncoderSettings &settings, bool *continuous) const
If the encoder supports arbitrary frame rates within the supported range,
*\a continuous is set to true, otherwise *\a continuous is set to false.
- \since 1.0
\sa QVideoEncoderSettings::frameRate()
*/
QList<qreal> QMediaRecorder::supportedFrameRates(const QVideoEncoderSettings &settings, bool *continuous) const
/*!
Returns a list of supported video codecs.
- \since 1.0
*/
QStringList QMediaRecorder::supportedVideoCodecs() const
{
/*!
Returns a description of a video \a codec.
- \since 1.0
\sa setEncodingSettings()
*/
QString QMediaRecorder::videoCodecDescription(const QString &codec) const
/*!
Returns the audio encoder settings being used.
- \since 1.0
\sa setEncodingSettings()
*/
/*!
Returns the video encoder settings being used.
- \since 1.0
\sa setEncodingSettings()
*/
It's only possible to change settings when the encoder is in the
QMediaEncoder::StoppedState state.
- \since 1.0
\sa audioSettings(), videoSettings(), containerMimeType()
*/
This is an asynchronous call, with signal
stateCahnged(QMediaRecorder::RecordingState) being emitted when recording
started, otherwise the error() signal is emitted.
- \since 1.0
*/
void QMediaRecorder::record()
/*!
Pause recording.
- \since 1.0
*/
void QMediaRecorder::pause()
/*!
Stop recording.
- \since 1.0
*/
void QMediaRecorder::stop()
\fn QMediaRecorder::stateChanged(State state)
Signals that a media recorder's \a state has changed.
- \since 1.0
*/
/*!
\fn QMediaRecorder::durationChanged(qint64 duration)
Signals that the \a duration of the recorded media has changed.
- \since 1.0
*/
/*!
\fn QMediaRecorder::error(QMediaRecorder::Error error)
Signals that an \a error has occurred.
- \since 1.0
*/
/*!
\fn QMediaRecorder::mutedChanged(bool muted)
Signals that the \a muted state has changed. If true the recording is being muted.
- \since 1.0
*/
/*!
\brief whether access to a media object's meta-data is available.
If this is true there is meta-data available, otherwise there is no meta-data available.
- \since 1.0
*/
bool QMediaRecorder::isMetaDataAvailable() const
\fn QMediaRecorder::metaDataAvailableChanged(bool available)
Signals that the \a available state of a media object's meta-data has changed.
- \since 1.0
*/
/*!
\brief whether a media object's meta-data is writable.
If this is true the meta-data is writable, otherwise the meta-data is read-only.
- \since 1.0
*/
bool QMediaRecorder::isMetaDataWritable() const
\fn QMediaRecorder::metaDataWritableChanged(bool writable)
Signals that the \a writable state of a media object's meta-data has changed.
- \since 1.0
*/
/*!
Returns the value associated with a meta-data \a key.
- \since 1.0
*/
QVariant QMediaRecorder::metaData(QtMultimedia::MetaData key) const
{
\note To ensure that meta data is set corretly, it should be set before starting the recording.
Once the recording is stopped, any meta data set will be attached to the next recording.
- \since 1.0
*/
void QMediaRecorder::setMetaData(QtMultimedia::MetaData key, const QVariant &value)
{
/*!
Returns a list of keys there is meta-data available for.
- \since 1.0
*/
QList<QtMultimedia::MetaData> QMediaRecorder::availableMetaData() const
{
\fn QMediaRecorder::metaDataChanged()
Signals that a media object's meta-data has changed.
- \since 1.0
*/
/*!
The naming and type of extended meta-data is not standardized, so the values and meaning
of keys may vary between backends.
- \since 1.0
*/
QVariant QMediaRecorder::extendedMetaData(const QString &key) const
{
The naming and type of extended meta-data is not standardized, so the values and meaning
of keys may vary between backends.
- \since 1.0
*/
void QMediaRecorder::setExtendedMetaData(const QString &key, const QVariant &value)
{
/*!
Returns a list of keys there is extended meta-data available for.
- \since 1.0
*/
QStringList QMediaRecorder::availableExtendedMetaData() const
{
/*!
\class QAbstractVideoBuffer
\brief The QAbstractVideoBuffer class is an abstraction for video data.
- \since 1.0
\inmodule QtMultimedia
The QVideoFrame class makes use of a QAbstractVideoBuffer internally to reference a buffer of
/*!
Returns the type of a video buffer's handle.
- \since 1.0
\sa handle()
*/
QAbstractVideoBuffer::HandleType QAbstractVideoBuffer::handleType() const
Returns the mode a video buffer is mapped in.
- \since 1.0
\sa map()
*/
\note Writing to memory that is mapped as read-only is undefined, and may result in changes
to shared data or crashes.
- \since 1.0
\sa unmap(), mapMode()
*/
If the \l {QAbstractVideoBuffer::MapMode}{MapMode} included the \c QAbstractVideoBuffer::WriteOnly
flag this will write the current content of the mapped memory back to the video frame.
- \since 1.0
\sa map()
*/
The type of the handle is given by handleType() function.
- \since 1.0
\sa handleType()
*/
QVariant QAbstractVideoBuffer::handle() const
/*!
\class QAbstractVideoSurface
\brief The QAbstractVideoSurface class is a base class for video presentation surfaces.
- \since 1.0
\inmodule QtMultimedia
The QAbstractVideoSurface class defines the standard interface that video producers use to
that can be mapped in read-only mode.
Types that are first in the list can be assumed to be faster to render.
- \since 1.0
*/
/*!
Tests a video surface \a format to determine if a surface can accept it.
Returns true if the format is supported by the surface, and false otherwise.
- \since 1.0
*/
bool QAbstractVideoSurface::isFormatSupported(const QVideoSurfaceFormat &format) const
{
If the format is already supported it will be returned unchanged, or if there is no similar
supported format an invalid format will be returned.
- \since 1.0
*/
QVideoSurfaceFormat QAbstractVideoSurface::nearestFormat(const QVideoSurfaceFormat &format) const
{
Signals that the set of formats supported by a video surface has changed.
- \since 1.0
\sa supportedPixelFormats(), isFormatSupported()
*/
/*!
Returns the format of a video surface.
- \since 1.0
*/
QVideoSurfaceFormat QAbstractVideoSurface::surfaceFormat() const
{
Signals that the configured \a format of a video surface has changed.
- \since 1.0
\sa surfaceFormat(), start()
*/
Returns true if the surface was started, and false if an error occurred.
\note You must call the base class implementation of start() at the end of your implementation.
- \since 1.0
\sa isActive(), stop()
*/
bool QAbstractVideoSurface::start(const QVideoSurfaceFormat &format)
Stops a video surface presenting frames and releases any resources acquired in start().
\note You must call the base class implementation of stop() at the start of your implementation.
- \since 1.0
\sa isActive(), start()
*/
void QAbstractVideoSurface::stop()
Indicates whether a video surface has been started.
Returns true if the surface has been started, and false otherwise.
- \since 1.0
*/
bool QAbstractVideoSurface::isActive() const
{
Signals that the \a active state of a video surface has changed.
- \since 1.0
\sa isActive(), start(), stop()
*/
A video surface must be in the started state for present() to succeed, and the format of the
video frame must be compatible with the current video surface format.
- \since 1.0
\sa error()
*/
If a surface fails to start(), or stops unexpectedly this function can be called to discover
what error occurred.
- \since 1.0
*/
QAbstractVideoSurface::Error QAbstractVideoSurface::error() const
This can be called by implementors of this interface to communicate
what the most recent error was.
- \since 1.0
*/
void QAbstractVideoSurface::setError(Error error)
{
can render with optimal quality and/or performance.
The native resolution is not always known and can be changed during playback.
- \since 1.1
*/
QSize QAbstractVideoSurface::nativeResolution() const
{
This function can be called by implementors of this interface to specify
to frame producers what the native resolution of this surface is.
- \since 1.1
*/
void QAbstractVideoSurface::setNativeResolution(const QSize &resolution)
{
\fn QAbstractVideoSurface::nativeResolutionChanged(const QSize &resolution);
Signals the native \a resolution of video surface has changed.
- \since 1.1
*/
#ifndef QT_NO_DEBUG_STREAM
/*!
\reimp
- \since 1.1
*/
QAbstractVideoBuffer::MapMode QMemoryVideoBuffer::mapMode() const
{
/*!
\reimp
- \since 1.1
*/
uchar *QMemoryVideoBuffer::map(MapMode mode, int *numBytes, int *bytesPerLine)
{
/*!
\reimp
- \since 1.1
*/
void QMemoryVideoBuffer::unmap()
{
/*!
\class QVideoFrame
\brief The QVideoFrame class represents a frame of video data.
- \since 1.0
\inmodule QtMultimedia
A QVideoFrame encapsulates the pixel data of a video frame, and information about the frame.
Constructs a video frame from a \a buffer with the given pixel \a format and \a size in pixels.
\note This doesn't increment the reference count of the video buffer.
- \since 1.0
*/
QVideoFrame::QVideoFrame(
QAbstractVideoBuffer *buffer, const QSize &size, PixelFormat format)
The \a bytesPerLine (stride) is the length of each scan line in bytes, and \a bytes is the total
number of bytes that must be allocated for the frame.
- \since 1.0
*/
QVideoFrame::QVideoFrame(int bytes, const QSize &size, int bytesPerLine, PixelFormat format)
: d(new QVideoFramePrivate(size, format))
\note This will construct an invalid video frame if there is no frame type equivalent to the
image format.
- \since 1.0
\sa pixelFormatFromImageFormat()
*/
QVideoFrame::QVideoFrame(const QImage &image)
Constructs a shallow copy of \a other. Since QVideoFrame is
explicitly shared, these two instances will reflect the same frame.
- \since 1.0
*/
QVideoFrame::QVideoFrame(const QVideoFrame &other)
: d(other.d)
Assigns the contents of \a other to this video frame. Since QVideoFrame is
explicitly shared, these two instances will reflect the same frame.
- \since 1.0
*/
QVideoFrame &QVideoFrame::operator =(const QVideoFrame &other)
{
An invalid frame has no video buffer associated with it.
Returns true if the frame is valid, and false if it is not.
- \since 1.0
*/
bool QVideoFrame::isValid() const
{
/*!
Returns the color format of a video frame.
- \since 1.0
*/
QVideoFrame::PixelFormat QVideoFrame::pixelFormat() const
{
/*!
Returns the type of a video frame's handle.
- \since 1.0
*/
QAbstractVideoBuffer::HandleType QVideoFrame::handleType() const
{
/*!
Returns the dimensions of a video frame.
- \since 1.0
*/
QSize QVideoFrame::size() const
{
/*!
Returns the width of a video frame.
- \since 1.0
*/
int QVideoFrame::width() const
{
/*!
Returns the height of a video frame.
- \since 1.0
*/
int QVideoFrame::height() const
{
Returns the field an interlaced video frame belongs to.
If the video is not interlaced this will return WholeFrame.
- \since 1.0
*/
QVideoFrame::FieldType QVideoFrame::fieldType() const
{
/*!
Sets the \a field an interlaced video frame belongs to.
- \since 1.0
*/
void QVideoFrame::setFieldType(QVideoFrame::FieldType field)
{
Returns true if the contents of the video frame are mapped to system memory, and false
otherwise.
- \since 1.0
\sa mapMode(), QAbstractVideoBuffer::MapMode
*/
Depending on the buffer implementation the changes may be persisted, or worse alter a shared
buffer.
- \since 1.0
\sa mapMode(), QAbstractVideoBuffer::MapMode
*/
bool QVideoFrame::isWritable() const
Returns true if the contents of the mapped memory were read from the video frame, and false
otherwise.
- \since 1.0
\sa mapMode(), QAbstractVideoBuffer::MapMode
*/
bool QVideoFrame::isReadable() const
/*!
Returns the mode a video frame was mapped to system memory in.
- \since 1.0
\sa map(), QAbstractVideoBuffer::MapMode
*/
QAbstractVideoBuffer::MapMode QVideoFrame::mapMode() const
Returns true if the frame was mapped to memory in the given \a mode and false otherwise.
- \since 1.0
\sa unmap(), mapMode(), bits()
*/
bool QVideoFrame::map(QAbstractVideoBuffer::MapMode mode)
unmap() should not be called if map() function failed.
- \since 1.0
\sa map()
*/
void QVideoFrame::unmap()
This value is only valid while the frame data is \l {map()}{mapped}.
- \since 1.0
\sa bits(), map(), mappedBytes()
*/
int QVideoFrame::bytesPerLine() const
are only guaranteed to have been persisted when unmap() is called and when the
buffer has been mapped for writing.
- \since 1.0
\sa map(), mappedBytes(), bytesPerLine()
*/
uchar *QVideoFrame::bits()
If the buffer was not mapped with read access, the contents of this
buffer will initially be uninitialized.
- \since 1.0
\sa map(), mappedBytes(), bytesPerLine()
*/
const uchar *QVideoFrame::bits() const
This value is only valid while the frame data is \l {map()}{mapped}.
- \since 1.0
\sa map()
*/
int QVideoFrame::mappedBytes() const
For an OpenGL texture this would be the texture ID.
- \since 1.0
\sa QAbstractVideoBuffer::handle()
*/
QVariant QVideoFrame::handle() const
An invalid time is represented as -1.
- \since 1.0
*/
qint64 QVideoFrame::startTime() const
{
An invalid time is represented as -1.
- \since 1.0
*/
void QVideoFrame::setStartTime(qint64 time)
{
An invalid time is represented as -1.
- \since 1.0
*/
qint64 QVideoFrame::endTime() const
{
An invalid time is represented as -1.
- \since 1.0
*/
void QVideoFrame::setEndTime(qint64 time)
{
\note In general \l QImage does not handle YUV formats.
- \since 1.0
*/
QVideoFrame::PixelFormat QVideoFrame::pixelFormatFromImageFormat(QImage::Format format)
{
\note In general \l QImage does not handle YUV formats.
- \since 1.0
*/
QImage::Format QVideoFrame::imageFormatFromPixelFormat(PixelFormat format)
{
\class QVideoSurfaceFormat
\brief The QVideoSurfaceFormat class specifies the stream format of a video presentation
surface.
- \since 1.0
\inmodule QtMultimedia
A video surface presents a stream of video frames. The surface's format describes the type of
/*!
Contructs a description of stream which receives stream of \a type buffers with given frame
\a size and pixel \a format.
- \since 1.0
*/
QVideoSurfaceFormat::QVideoSurfaceFormat(
const QSize& size, QVideoFrame::PixelFormat format, QAbstractVideoBuffer::HandleType type)
/*!
Constructs a copy of \a other.
- \since 1.0
*/
QVideoSurfaceFormat::QVideoSurfaceFormat(const QVideoSurfaceFormat &other)
: d(other.d)
/*!
Assigns the values of \a other to this object.
- \since 1.0
*/
QVideoSurfaceFormat &QVideoSurfaceFormat::operator =(const QVideoSurfaceFormat &other)
{
Identifies if a video surface format has a valid pixel format and frame size.
Returns true if the format is valid, and false otherwise.
- \since 1.0
*/
bool QVideoSurfaceFormat::isValid() const
{
/*!
Returns true if \a other is the same as this video format, and false if they are different.
- \since 1.0
*/
bool QVideoSurfaceFormat::operator ==(const QVideoSurfaceFormat &other) const
{
/*!
Returns true if \a other is different to this video format, and false if they are the same.
- \since 1.0
*/
bool QVideoSurfaceFormat::operator !=(const QVideoSurfaceFormat &other) const
{
/*!
Returns the pixel format of frames in a video stream.
- \since 1.0
*/
QVideoFrame::PixelFormat QVideoSurfaceFormat::pixelFormat() const
{
provided they can be \l {QAbstractVideoBuffer::map()}{mapped} with the
QAbstractVideoBuffer::ReadOnly flag. If the handleType() is not QAbstractVideoBuffer::NoHandle
then the handle type of the buffer must be the same as that of the surface format.
- \since 1.0
*/
QAbstractVideoBuffer::HandleType QVideoSurfaceFormat::handleType() const
{
Returns the dimensions of frames in a video stream.
\sa frameWidth(), frameHeight()
- \since 1.0
*/
QSize QVideoSurfaceFormat::frameSize() const
{
Returns the width of frames in a video stream.
\sa frameSize(), frameHeight()
- \since 1.0
*/
int QVideoSurfaceFormat::frameWidth() const
{
/*!
Returns the height of frame in a video stream.
- \since 1.0
*/
int QVideoSurfaceFormat::frameHeight() const
{
Sets the size of frames in a video stream to \a size.
This will reset the viewport() to fill the entire frame.
- \since 1.0
*/
void QVideoSurfaceFormat::setFrameSize(const QSize &size)
{
Sets the \a width and \a height of frames in a video stream.
This will reset the viewport() to fill the entire frame.
- \since 1.0
*/
void QVideoSurfaceFormat::setFrameSize(int width, int height)
{
The viewport is the region of a video frame that is actually displayed.
By default the viewport covers an entire frame.
- \since 1.0
*/
QRect QVideoSurfaceFormat::viewport() const
{
/*!
Sets the viewport of a video stream to \a viewport.
- \since 1.0
*/
void QVideoSurfaceFormat::setViewport(const QRect &viewport)
{
/*!
Returns the direction of scan lines.
- \since 1.0
*/
QVideoSurfaceFormat::Direction QVideoSurfaceFormat::scanLineDirection() const
{
/*!
Sets the \a direction of scan lines.
- \since 1.0
*/
void QVideoSurfaceFormat::setScanLineDirection(Direction direction)
{
/*!
Returns the frame rate of a video stream in frames per second.
- \since 1.0
*/
qreal QVideoSurfaceFormat::frameRate() const
{
/*!
Sets the frame \a rate of a video stream in frames per second.
- \since 1.0
*/
void QVideoSurfaceFormat::setFrameRate(qreal rate)
{
/*!
Returns a video stream's pixel aspect ratio.
- \since 1.0
*/
QSize QVideoSurfaceFormat::pixelAspectRatio() const
{
/*!
Sets a video stream's pixel aspect \a ratio.
- \since 1.0
*/
void QVideoSurfaceFormat::setPixelAspectRatio(const QSize &ratio)
{
\overload
Sets the \a horizontal and \a vertical elements of a video stream's pixel aspect ratio.
- \since 1.0
*/
void QVideoSurfaceFormat::setPixelAspectRatio(int horizontal, int vertical)
{
/*!
Returns the Y'CbCr color space of a video stream.
- \since 1.0
*/
QVideoSurfaceFormat::YCbCrColorSpace QVideoSurfaceFormat::yCbCrColorSpace() const
{
/*!
Sets the Y'CbCr color \a space of a video stream.
It is only used with raw YUV frame types.
- \since 1.0
*/
void QVideoSurfaceFormat::setYCbCrColorSpace(QVideoSurfaceFormat::YCbCrColorSpace space)
{
Returns a suggested size in pixels for the video stream.
This is the size of the viewport scaled according to the pixel aspect ratio.
- \since 1.0
*/
QSize QVideoSurfaceFormat::sizeHint() const
{
/*!
Returns a list of video format dynamic property names.
- \since 1.0
*/
QList<QByteArray> QVideoSurfaceFormat::propertyNames() const
{
/*!
Returns the value of the video format's \a name property.
- \since 1.0
*/
QVariant QVideoSurfaceFormat::property(const char *name) const
{
Trying to set a read only property will be ignored.
- \since 1.0
*/
void QVideoSurfaceFormat::setProperty(const char *name, const QVariant &value)
{
\inmodule QtMultimedia
\ingroup camera
- \since 1.1
\snippet doc/src/snippets/multimedia-snippets/camera.cpp Camera
/*!
\reimp
- \since 1.1
*/
QMediaObject *QCameraViewfinder::mediaObject() const
{
/*!
\reimp
- \since 1.1
*/
bool QCameraViewfinder::setMediaObject(QMediaObject *object)
{
/*!
\class QOmapFbVideoSurface
\internal
- \since 1.2
*/
/*!
}
/*!
- \since 1.2
*/
QList<QVideoFrame::PixelFormat> QEglImageTextureSurface::supportedPixelFormats(
QAbstractVideoBuffer::HandleType handleType) const
/*!
- \since 1.2
*/
bool QEglImageTextureSurface::start(const QVideoSurfaceFormat &format)
{
}
/*!
- \since 1.2
*/
void QEglImageTextureSurface::stop()
{
}
/*!
- \since 1.2
*/
bool QEglImageTextureSurface::present(const QVideoFrame &frame)
{
}
/*!
- \since 1.2
*/
int QEglImageTextureSurface::brightness() const
{
}
/*!
- \since 1.2
*/
void QEglImageTextureSurface::setBrightness(int brightness)
{
}
/*!
- \since 1.2
*/
int QEglImageTextureSurface::contrast() const
{
}
/*!
- \since 1.2
*/
void QEglImageTextureSurface::setContrast(int contrast)
{
}
/*!
- \since 1.2
*/
int QEglImageTextureSurface::hue() const
{
}
/*!
- \since 1.2
*/
void QEglImageTextureSurface::setHue(int hue)
{
}
/*!
- \since 1.2
*/
int QEglImageTextureSurface::saturation() const
{
}
/*!
- \since 1.2
*/
void QEglImageTextureSurface::setSaturation(int saturation)
{
}
/*!
- \since 1.2
*/
bool QEglImageTextureSurface::isReady() const
{
}
/*!
- \since 1.2
*/
void QEglImageTextureSurface::setReady(bool ready)
{
}
/*!
- \since 1.2
*/
void QEglImageTextureSurface::paint(QPainter *painter, const QRectF &target, const QRectF &sourceRect)
{
/*!
\fn QOmapFbVideoSurface::frameChanged()
- \since 1.2
*/
/*!
- \since 1.2
*/
const QGLContext *QEglImageTextureSurface::glContext() const
{
}
/*!
- \since 1.2
*/
void QEglImageTextureSurface::setGLContext(QGLContext *context)
{
\inmodule QtMultimedia
\ingroup multimedia
- \since 1.0
Attaching a QGraphicsVideoItem to a QMediaObject allows it to display
the video or image output of that media object. A QGraphicsVideoItem
\property QGraphicsVideoItem::mediaObject
\brief the media object which provides the video displayed by a graphics
item.
- \since 1.0
*/
QMediaObject *QGraphicsVideoItem::mediaObject() const
/*!
\internal
- \since 1.0
*/
bool QGraphicsVideoItem::setMediaObject(QMediaObject *object)
{
/*!
\property QGraphicsVideoItem::aspectRatioMode
\brief how a video is scaled to fit the graphics item's size.
- \since 1.0
*/
Qt::AspectRatioMode QGraphicsVideoItem::aspectRatioMode() const
QGraphicsVideoItem will draw video using the offset for its top left
corner.
- \since 1.0
*/
QPointF QGraphicsVideoItem::offset() const
QGraphicsVideoItem will draw video scaled to fit size according to its
fillMode.
- \since 1.0
*/
QSizeF QGraphicsVideoItem::size() const
/*!
\property QGraphicsVideoItem::nativeSize
\brief the native size of the video.
- \since 1.0
*/
QSizeF QGraphicsVideoItem::nativeSize() const
\fn QGraphicsVideoItem::nativeSizeChanged(const QSizeF &size)
Signals that the native \a size of the video has changed.
- \since 1.0
*/
/*!
\reimp
- \since 1.0
*/
QRectF QGraphicsVideoItem::boundingRect() const
{
/*!
\reimp
- \since 1.0
*/
void QGraphicsVideoItem::paint(
QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
\reimp
\internal
- \since 1.0
*/
QVariant QGraphicsVideoItem::itemChange(GraphicsItemChange change, const QVariant &value)
{
/*!
\internal
- \since 1.0
*/
void QGraphicsVideoItem::timerEvent(QTimerEvent *event)
{
/*!
\class QPainterVideoSurface
- \since 1.0
\internal
*/
}
/*!
- \since 1.0
*/
QList<QVideoFrame::PixelFormat> QPainterVideoSurface::supportedPixelFormats(
QAbstractVideoBuffer::HandleType handleType) const
}
/*!
- \since 1.0
*/
bool QPainterVideoSurface::isFormatSupported(
const QVideoSurfaceFormat &format, QVideoSurfaceFormat *similar) const
}
/*!
- \since 1.0
*/
bool QPainterVideoSurface::start(const QVideoSurfaceFormat &format)
{
}
/*!
- \since 1.0
*/
void QPainterVideoSurface::stop()
{
}
/*!
- \since 1.0
*/
bool QPainterVideoSurface::present(const QVideoFrame &frame)
{
}
/*!
- \since 1.0
*/
int QPainterVideoSurface::brightness() const
{
}
/*!
- \since 1.0
*/
void QPainterVideoSurface::setBrightness(int brightness)
{
}
/*!
- \since 1.0
*/
int QPainterVideoSurface::contrast() const
{
}
/*!
- \since 1.0
*/
void QPainterVideoSurface::setContrast(int contrast)
{
}
/*!
- \since 1.0
*/
int QPainterVideoSurface::hue() const
{
}
/*!
- \since 1.0
*/
void QPainterVideoSurface::setHue(int hue)
{
}
/*!
- \since 1.0
*/
int QPainterVideoSurface::saturation() const
{
}
/*!
- \since 1.0
*/
void QPainterVideoSurface::setSaturation(int saturation)
{
}
/*!
- \since 1.0
*/
bool QPainterVideoSurface::isReady() const
{
}
/*!
- \since 1.0
*/
void QPainterVideoSurface::setReady(bool ready)
{
}
/*!
- \since 1.0
*/
void QPainterVideoSurface::paint(QPainter *painter, const QRectF &target, const QRectF &source)
{
/*!
\fn QPainterVideoSurface::frameChanged()
- \since 1.0
*/
#if !defined(QT_NO_OPENGL) && !defined(QT_OPENGL_ES_1_CL) && !defined(QT_OPENGL_ES_1)
*/
/*!
- \since 1.0
*/
QPainterVideoSurface::ShaderTypes QPainterVideoSurface::supportedShaderTypes() const
{
}
/*!
- \since 1.0
*/
QPainterVideoSurface::ShaderType QPainterVideoSurface::shaderType() const
{
}
/*!
- \since 1.0
*/
void QPainterVideoSurface::setShaderType(ShaderType type)
{
produced by a media object.
\ingroup multimedia
\inmodule QtMultimedia
- \since 1.0
\inmodule QtMultimedia
/*!
\property QVideoWidget::mediaObject
\brief the media object which provides the video displayed by a widget.
- \since 1.0
*/
QMediaObject *QVideoWidget::mediaObject() const
/*!
\internal
- \since 1.0
*/
bool QVideoWidget::setMediaObject(QMediaObject *object)
{
/*!
\property QVideoWidget::aspectRatioMode
\brief how video is scaled with respect to its aspect ratio.
- \since 1.0
*/
Qt::AspectRatioMode QVideoWidget::aspectRatioMode() const
/*!
\property QVideoWidget::fullScreen
\brief whether video display is confined to a window or is fullScreen.
- \since 1.0
*/
void QVideoWidget::setFullScreen(bool fullScreen)
Signals that the \a fullScreen mode of a video widget has changed.
- \since 1.0
\sa fullScreen
*/
\brief an adjustment to the brightness of displayed video.
Valid brightness values range between -100 and 100, the default is 0.
- \since 1.0
*/
int QVideoWidget::brightness() const
Signals that a video widgets's \a brightness adjustment has changed.
- \since 1.0
\sa brightness
*/
Valid contrast values range between -100 and 100, the default is 0.
- \since 1.0
*/
int QVideoWidget::contrast() const
Signals that a video widgets's \a contrast adjustment has changed.
- \since 1.0
\sa contrast
*/
\brief an adjustment to the hue of displayed video.
Valid hue values range between -100 and 100, the default is 0.
- \since 1.0
*/
int QVideoWidget::hue() const
Signals that a video widgets's \a hue has changed.
- \since 1.0
\sa hue
*/
\brief an adjustment to the saturation of displayed video.
Valid saturation values range between -100 and 100, the default is 0.
- \since 1.0
*/
int QVideoWidget::saturation() const
Signals that a video widgets's \a saturation has changed.
- \since 1.0
\sa saturation
*/
/*!
Returns the size hint for the current back end,
if there is one, or else the size hint from QWidget.
- \since 1.0
*/
QSize QVideoWidget::sizeHint() const
{
/*!
Current event \a event.
Returns the value of the baseclass QWidget::event(QEvent *event) function.
- \since 1.0
*/
bool QVideoWidget::event(QEvent *event)
{
/*!
Handles the show \a event.
- \since 1.0
*/
void QVideoWidget::showEvent(QShowEvent *event)
{
/*!
Handles the hide \a event.
- \since 1.0
*/
void QVideoWidget::hideEvent(QHideEvent *event)
{
/*!
Handles the resize \a event.
- \since 1.0
*/
void QVideoWidget::resizeEvent(QResizeEvent *event)
{
/*!
Handles the move \a event.
- \since 1.0
*/
void QVideoWidget::moveEvent(QMoveEvent *event)
{
/*!
Handles the paint \a event.
- \since 1.0
*/
void QVideoWidget::paintEvent(QPaintEvent *event)
{
/*!
\reimp
\internal
- \since 1.1
*/
bool QVideoWidget::winEvent(MSG *message, long *result)
{
\inmodule QtMultimedia
\ingroup multimedia-serv
- \since 1.0
The videoWidget() property of QVideoWidgetControl provides a pointer to a
video widget implemented by the control's media service. This widget is
\fn QVideoWidgetControl::isFullScreen() const
Returns true if the video is shown using the complete screen.
- \since 1.0
*/
/*!
\fn QVideoWidgetControl::setFullScreen(bool fullScreen)
Sets whether a video widget is in \a fullScreen mode.
- \since 1.0
*/
/*!
\fn QVideoWidgetControl::fullScreenChanged(bool fullScreen)
Signals that the \a fullScreen state of a video widget has changed.
- \since 1.0
*/
/*!
\fn QVideoWidgetControl::aspectRatioMode() const
Returns how video is scaled to fit the widget with respect to its aspect ratio.
- \since 1.0
*/
/*!
Sets the aspect ratio \a mode which determines how video is scaled to the fit the widget with
respect to its aspect ratio.
- \since 1.0
*/
/*!
Returns the brightness adjustment applied to a video.
Valid brightness values range between -100 and 100, the default is 0.
- \since 1.0
*/
/*!
Sets a \a brightness adjustment for a video.
Valid brightness values range between -100 and 100, the default is 0.
- \since 1.0
*/
/*!
\fn QVideoWidgetControl::brightnessChanged(int brightness)
Signals that a video widget's \a brightness adjustment has changed.
- \since 1.0
*/
/*!
Returns the contrast adjustment applied to a video.
Valid contrast values range between -100 and 100, the default is 0.
- \since 1.0
*/
/*!
Sets the contrast adjustment for a video widget to \a contrast.
Valid contrast values range between -100 and 100, the default is 0.
- \since 1.0
*/
\fn QVideoWidgetControl::contrastChanged(int contrast)
Signals that a video widget's \a contrast adjustment has changed.
- \since 1.0
*/
/*!
Returns the hue adjustment applied to a video widget.
Value hue values range between -100 and 100, the default is 0.
- \since 1.0
*/
/*!
Sets a \a hue adjustment for a video widget.
Valid hue values range between -100 and 100, the default is 0.
- \since 1.0
*/
\fn QVideoWidgetControl::hueChanged(int hue)
Signals that a video widget's \a hue adjustment has changed.
- \since 1.0
*/
/*!
Returns the saturation adjustment applied to a video widget.
Value saturation values range between -100 and 100, the default is 0.
- \since 1.0
*/
Sets a \a saturation adjustment for a video widget.
Valid saturation values range between -100 and 100, the default is 0.
- \since 1.0
*/
/*!
\fn QVideoWidgetControl::saturationChanged(int saturation)
Signals that a video widget's \a saturation adjustment has changed.
- \since 1.0
*/
/*!
\fn QVideoWidgetControl::videoWidget()
Returns the QWidget.
- \since 1.0
*/
#include "moc_qvideowidgetcontrol.cpp"
\inmodule QtMultimedia
\ingroup multimedia-serv
\brief The QVideoWindowControl class provides a media control for rendering video to a window.
- \since 1.0
The winId() property QVideoWindowControl allows a platform specific window
\fn QVideoWindowControl::winId() const
Returns the ID of the window a video overlay end point renders to.
- \since 1.0
*/
/*!
\fn QVideoWindowControl::setWinId(WId id)
Sets the \a id of the window a video overlay end point renders to.
- \since 1.0
*/
/*!
\fn QVideoWindowControl::displayRect() const
Returns the sub-rect of a window where video is displayed.
- \since 1.0
*/
/*!
\fn QVideoWindowControl::setDisplayRect(const QRect &rect)
Sets the sub-\a rect of a window where video is displayed.
- \since 1.0
*/
/*!
Identifies if a video overlay is a fullScreen overlay.
Returns true if the video overlay is fullScreen, and false otherwise.
- \since 1.0
*/
/*!
\fn QVideoWindowControl::setFullScreen(bool fullScreen)
Sets whether a video overlay is a \a fullScreen overlay.
- \since 1.0
*/
/*!
\fn QVideoWindowControl::fullScreenChanged(bool fullScreen)
Signals that the \a fullScreen state of a video overlay has changed.
- \since 1.0
*/
/*!
\fn QVideoWindowControl::repaint()
Repaints the last frame.
- \since 1.0
*/
/*!
Returns a suggested size for the video display based on the resolution and aspect ratio of the
video.
- \since 1.0
*/
/*!
\fn QVideoWindowControl::nativeSizeChanged()
Signals that the native dimensions of the video have changed.
- \since 1.0
*/
\fn QVideoWindowControl::aspectRatioMode() const
Returns how video is scaled to fit the display region with respect to its aspect ratio.
- \since 1.0
*/
/*!
Sets the aspect ratio \a mode which determines how video is scaled to the fit the display region
with respect to its aspect ratio.
- \since 1.0
*/
/*!
Returns the brightness adjustment applied to a video overlay.
Valid brightness values range between -100 and 100, the default is 0.
- \since 1.0
*/
/*!
Sets a \a brightness adjustment for a video overlay.
Valid brightness values range between -100 and 100, the default is 0.
- \since 1.0
*/
/*!
\fn QVideoWindowControl::brightnessChanged(int brightness)
Signals that a video overlay's \a brightness adjustment has changed.
- \since 1.0
*/
/*!
Returns the contrast adjustment applied to a video overlay.
Valid contrast values range between -100 and 100, the default is 0.
- \since 1.0
*/
/*!
Sets the \a contrast adjustment for a video overlay.
Valid contrast values range between -100 and 100, the default is 0.
- \since 1.0
*/
/*!
\fn QVideoWindowControl::contrastChanged(int contrast)
Signals that a video overlay's \a contrast adjustment has changed.
- \since 1.0
*/
/*!
Returns the hue adjustment applied to a video overlay.
Value hue values range between -100 and 100, the default is 0.
- \since 1.0
*/
/*!
Sets a \a hue adjustment for a video overlay.
Valid hue values range between -100 and 100, the default is 0.
- \since 1.0
*/
/*!
\fn QVideoWindowControl::hueChanged(int hue)
Signals that a video overlay's \a hue adjustment has changed.
- \since 1.0
*/
/*!
Returns the saturation adjustment applied to a video overlay.
Value saturation values range between -100 and 100, the default is 0.
- \since 1.0
*/
/*!
Sets a \a saturation adjustment for a video overlay.
Valid saturation values range between -100 and 100, the default is 0.
- \since 1.0
*/
/*!
\fn QVideoWindowControl::saturationChanged(int saturation)
Signals that a video overlay's \a saturation adjustment has changed.
- \since 1.0
*/
#include "moc_qvideowindowcontrol.cpp"
projects / platform / upstream / qtmultimedia.git / commitdiff