QVideoProbe Class | Qt Multimedia 5.12.7

Qt 5.12 | Qt Multimedia | C++ Classes | QVideoProbe

Qt 5.12.7 Reference Documentation

# QVideoProbe Class

The QVideoProbe class allows you to monitor video frames being played or recorded. More...

Header: | #include <QVideoProbe>
qmake: | QT += multimedia
Inherits: | QObject

- List of all members, including inherited members
- Obsolete members

## Public Functions

| QVideoProbe(QObject *parent = nullptr)
virtual | ~QVideoProbe()
bool | isActive() const
bool | setSource(QMediaObject *source)
bool | setSource(QMediaRecorder *mediaRecorder)

- 31 public functions inherited from QObject

## Signals

void | flush()
void | videoFrameProbed(const QVideoFrame &frame)

- 2 signals inherited from QObject

## Static Public Members

const QMetaObject | staticMetaObject

- 9 static public members inherited from QObject

### Additional Inherited Members

- 1 property inherited from QObject
- 1 public slot inherited from QObject
- 9 protected functions inherited from QObject

## Detailed Description

The QVideoProbe class allows you to monitor video frames being played or recorded.

      QMediaPlayer *player = new QMediaPlayer();
      QVideoProbe *probe = new QVideoProbe;

      connect(probe, SIGNAL(videoFrameProbed(QVideoFrame)), this, SLOT(processFrame(QVideoFrame)));

      probe->setSource(player); // Returns true, hopefully.

      player->setVideoOutput(myVideoSurface);
      player->setMedia(QUrl::fromLocalFile("observation.mp4"));
      player->play(); // Start receiving frames as they get presented to myVideoSurface

This same approach works with the QCamera object as well, to receive viewfinder or video frames as they are captured.

See also QAudioProbe, QMediaPlayer, and QCamera.

## Member Function Documentation

### QVideoProbe::QVideoProbe(QObject *parent = nullptr)

Creates a new QVideoProbe class with parent. After setting the source to monitor with setSource(), the videoFrameProbed() signal will be emitted when video frames are flowing in the source media object.

### `[virtual]` QVideoProbe::~QVideoProbe()

Destroys this probe and disconnects from any media object.

### `[signal]` void QVideoProbe::flush()

This signal should be emitted when it is required to release all frames. Application must release all outstanding references to video frames.

### bool QVideoProbe::isActive() const

Returns true if this probe is monitoring something, or false otherwise.

The source being monitored does not need to be active.

### bool QVideoProbe::setSource(QMediaObject *source)

Sets the media object to monitor to source.

If source is zero, this probe will be deactivated and this function wil return true.

If the media object does not support monitoring video, this function will return false.

Any previously monitored objects will no longer be monitored. Passing in the same object will be ignored, but monitoring will continue.

### bool QVideoProbe::setSource(QMediaRecorder *mediaRecorder)

Starts monitoring the given mediaRecorder.

If there is no mediaObject associated with mediaRecorder, or if it is zero, this probe will be deactivated and this function wil return true.

If the media recorder instance does not support monitoring video, this function will return false.

Any previously monitored objects will no longer be monitored. Passing in the same object will be ignored, but monitoring will continue.

### `[signal]` void QVideoProbe::videoFrameProbed(const QVideoFrame &frame)

This signal should be emitted when a video frame is processed in the media service.