QIviMediaIndexerControl Class

Provides an interface to control the media indexer. More...

Header: #include <QIviMediaIndexerControl>
qmake: QT += ivimedia
Instantiated By: MediaIndexerControl
Inherits: QIviAbstractFeature

Public Types

enum State { Idle, Active, Paused, Error }

Properties

  • progress : const qreal
  • state : const QIviMediaIndexerControl::State

Public Functions

QIviMediaIndexerControl(QObject *parent = nullptr)
qreal progress() const
QIviMediaIndexerControl::State state() const

Public Slots

void pause()
void resume()

Signals

void progressChanged(qreal progress)
void stateChanged(QIviMediaIndexerControl::State state)

Reimplemented Protected Functions

virtual void clearServiceObject() override
virtual void connectToServiceObject(QIviServiceObject *serviceObject) override

Detailed Description

The QIviMediaIndexerControl controls the media indexer. It provides a way to temporarily pause the indexing and resume it, as well as to inquire about the current state and progress of the indexing operation.

The QIviMediaIndexerControl expects a single backend to be available. It is recommended to use it with discoveryMode set to QIviAbstractFeature::AutoDiscovery.

Member Type Documentation

enum QIviMediaIndexerControl::State

ConstantValueDescription
QIviMediaIndexerControl::Idle0The indexer is currently idle and is waiting for new files to be indexed.
QIviMediaIndexerControl::Active1The indexer is currently busy with indexing.
QIviMediaIndexerControl::Paused2The indexer is paused, due to a call to pause().
QIviMediaIndexerControl::Error3An error has occurred during the indexing operation.

Property Documentation

progress : const qreal

Holds the progress of the indexing operation.

The value is between 0 and 1.

Access functions:

qreal progress() const

Notifier signal:

void progressChanged(qreal progress)

state : const QIviMediaIndexerControl::State

Holds the current state of the indexer.

Access functions:

QIviMediaIndexerControl::State state() const

Notifier signal:

void stateChanged(QIviMediaIndexerControl::State state)

Member Function Documentation

QIviMediaIndexerControl::QIviMediaIndexerControl(QObject *parent = nullptr)

Constructs a QIviMediaIndexerControl.

The parent argument is passed on to the QIviAbstractFeature base class.

[slot] void QIviMediaIndexerControl::pause()

Pauses the currently ongoing indexing operation.

See also resume() and state.

[slot] void QIviMediaIndexerControl::resume()

Resumes from the Paused state and resumes the indexing operation.

See also pause() and state.

[override virtual protected] void QIviMediaIndexerControl::clearServiceObject()

Reimplements: QIviAbstractFeature::clearServiceObject().

[override virtual protected] void QIviMediaIndexerControl::connectToServiceObject(QIviServiceObject *serviceObject)

Reimplements: QIviAbstractFeature::connectToServiceObject(QIviServiceObject *serviceObject).