QMediaStreamsControl Class

The QMediaStreamsControl class provides a media stream selection control. More...

Header: #include <QMediaStreamsControl>
qmake: QT += multimedia
Inherits: QMediaControl

Public Types

enum StreamType { AudioStream, VideoStream, SubPictureStream, UnknownStream, DataStream }

Public Functions

virtual ~QMediaStreamsControl()
virtual bool isActive(int stream) = 0
virtual QVariant metaData(int stream, const QString &key) = 0
virtual void setActive(int stream, bool state) = 0
virtual int streamCount() = 0
virtual StreamType streamType(int stream) = 0
  • 32 public functions inherited from QObject


Protected Functions

QMediaStreamsControl(QObject *parent = Q_NULLPTR)
  • 9 protected functions inherited from QObject


Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 11 static public members inherited from QObject

Detailed Description

The QMediaStreamsControl class provides a media stream selection control.

The QMediaStreamsControl class provides descriptions of the available media streams and allows individual streams to be activated and deactivated.

The interface name of QMediaStreamsControl is org.qt-project.qt.mediastreamscontrol/5.0 as defined in QMediaStreamsControl_iid.

See also QMediaService::requestControl().

Member Type Documentation

enum QMediaStreamsControl::StreamType

Media stream type.

QMediaStreamsControl::AudioStream2Audio stream.
QMediaStreamsControl::VideoStream1Video stream.
QMediaStreamsControl::SubPictureStream3Subpicture or teletext stream.
QMediaStreamsControl::UnknownStream0The stream type is unknown.

Member Function Documentation

[protected] QMediaStreamsControl::QMediaStreamsControl(QObject *parent = Q_NULLPTR)

Constructs a new media streams control with the given parent.

[virtual] QMediaStreamsControl::~QMediaStreamsControl()

Destroys a media streams control.

[signal] void QMediaStreamsControl::activeStreamsChanged()

The signal is emitted when the active streams list is changed.

[pure virtual] bool QMediaStreamsControl::isActive(int stream)

Returns true if the media stream is active.

[pure virtual] QVariant QMediaStreamsControl::metaData(int stream, const QString &key)

Returns the meta-data value of key for a given stream.

Useful metadata keys are QMediaMetaData::Title, QMediaMetaData::Description and QMediaMetaData::Language.

[pure virtual] void QMediaStreamsControl::setActive(int stream, bool state)

Sets the active state of a media stream.

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.

See also isActive().

[pure virtual] int QMediaStreamsControl::streamCount()

Returns the number of media streams.

[pure virtual] StreamType QMediaStreamsControl::streamType(int stream)

Return the type of a media stream.

[signal] void QMediaStreamsControl::streamsChanged()

The signal is emitted when the available streams list is changed.

Macro Documentation



Defines the interface name of the QMediaStreamsControl class.

© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.