QIviMediaIndexerControlBackendInterface Class

The QIviMediaIndexerControlBackendInterface defines the interface for backends to the QIviMediaIndexerControl feature class. More...

Header: #include <QIviMediaIndexerControlBackendInterface>
qmake: QT += ivimedia
Inherits: QIviFeatureInterface

Public Functions

QIviMediaIndexerControlBackendInterface(QObject *parent = nullptr)
virtual void pause() = 0
virtual void resume() = 0

Reimplemented Public Functions

virtual void initialize() override = 0

Signals

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

Detailed Description

The QIviMediaIndexerControlBackendInterface is the interface used by QIviMediaIndexerControl

The interface is discovered by a QIviMediaIndexerControl object, which connects to it and sets it up.

<example of a fully featured backend>

Member Function Documentation

QIviMediaIndexerControlBackendInterface::QIviMediaIndexerControlBackendInterface(QObject *parent = nullptr)

Constructs a backend interface.

The parent is sent to the QObject constructor.

[signal] void QIviMediaIndexerControlBackendInterface::progressChanged(qreal progress)

This signal is emitted when indexing is currently ongoing and the progress of the operation changed. The progress argument passes the current progress between 0 and 1.

[signal] void QIviMediaIndexerControlBackendInterface::stateChanged(QIviMediaIndexerControl::State state)

This signal is emitted whenever the indexing state changed. The state argument holds the new state of the indexer.

[override pure virtual] void QIviMediaIndexerControlBackendInterface::initialize()

Reimplements: QIviFeatureInterface::initialize().

Initializes the backend. This function is called after a feature connected to the backend. It is expected that this function will use the stateChanged and the progressChanged signals to inform the feature about the current state of the indexing.

See also stateChanged() and progressChanged().

[pure virtual] void QIviMediaIndexerControlBackendInterface::pause()

Pauses the currently ongoing indexing. If currently no indexing is ongoing this call should not perform any actions.

See also resume().

[pure virtual] void QIviMediaIndexerControlBackendInterface::resume()

Resumes the previously paused indexing. If there is nothing to resume this call should not perform any actions.

See also pause().

© 2020 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.