QIviAmFmTunerBackendInterface Class

The QIviAmFmTunerBackendInterface defines the interface for backends to the QIviAmFmTuner feature class. More...

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

Public Functions

QIviAmFmTunerBackendInterface(QObject *parent = nullptr)
virtual void seekDown() = 0
virtual void seekUp() = 0
virtual void setBand(QIviAmFmTuner::Band band) = 0
virtual void setFrequency(int frequency) = 0
virtual void startScan() = 0
virtual void stepDown() = 0
virtual void stepUp() = 0
virtual void stopScan() = 0

Signals

void bandChanged(QIviAmFmTuner::Band band)
void frequencyChanged(int frequency)
void maximumFrequencyChanged(int maximumFrequency)
void minimumFrequencyChanged(int minimumFrequency)
void scanStatusChanged(bool scanRunning)
void stationChanged(const QIviAmFmTunerStation &station)
void stepSizeChanged(int stepSize)

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 1 public variable inherited from QObject
  • 10 static public members inherited from QObject
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

The QIviAmFmTunerBackendInterface defines the interface for backends to the QIviAmFmTuner feature class.

The QIviAmFmTunerBackendInterface is the interface used by QIviAmFmTuner

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

<example of a fully featured backend>

Member Function Documentation

QIviAmFmTunerBackendInterface::QIviAmFmTunerBackendInterface(QObject *parent = nullptr)

Constructs a backend interface.

The parent is sent to the QObject constructor.

[signal] void QIviAmFmTunerBackendInterface::bandChanged(QIviAmFmTuner::Band band)

Emitted when the current band changed. The new value is passed as band.

See also minimumFrequencyChanged(), maximumFrequencyChanged(), and stepSizeChanged().

[signal] void QIviAmFmTunerBackendInterface::frequencyChanged(int frequency)

Emitted when the current frequency changed. The new value is passed as frequency.

[signal] void QIviAmFmTunerBackendInterface::maximumFrequencyChanged(int maximumFrequency)

Emitted when the maximum frequency of the current band changed. The new value is passed as maximumFrequency. This is usually caused by a switching the band.

See also bandChanged(), minimumFrequencyChanged(), and stepSizeChanged().

[signal] void QIviAmFmTunerBackendInterface::minimumFrequencyChanged(int minimumFrequency)

Emitted when the minimum frequency of the current band changed. The new value is passed as minimumFrequency. This is usually caused by a switching the band.

See also bandChanged(), maximumFrequencyChanged(), and stepSizeChanged().

[signal] void QIviAmFmTunerBackendInterface::scanStatusChanged(bool scanRunning)

Emitted when the status of the station scan has changed. This signal should be emitted as a result of a call to startScan() or stopScan() and informs about the current status using the scanRunning argument.

See also startScan() and stopScan().

[pure virtual] void QIviAmFmTunerBackendInterface::seekDown()

Seeks the next available Station in downwards direction and tunes it.

If the beginning of the band where hit without finding a station, the search will be continued from the end of the band.

See also frequencyChanged and stationChanged.

[pure virtual] void QIviAmFmTunerBackendInterface::seekUp()

Seeks the next available Station in upwards direction and tunes it.

If the end of the band where hit without finding a station, the search will be continued from the beginning of the band.

See also frequencyChanged and stationChanged.

[pure virtual] void QIviAmFmTunerBackendInterface::setBand(QIviAmFmTuner::Band band)

Changes the band to the new value passed as band.

This method is expected to emit a bandChanged() signal when the internal state changes due to this function call

[pure virtual] void QIviAmFmTunerBackendInterface::setFrequency(int frequency)

Changes the frequency to the new value passed as frequency.

This method is expected to emit a frequencyChanged() signal when the internal state changes due to this function call

[pure virtual] void QIviAmFmTunerBackendInterface::startScan()

Starts a scan through all available stations. The scan will seek to the next available station and will stay there for some seconds until it seeks to the next station. It is expected that this function will inform about the current state of the backend by emitting the scanStatusChanged() signal.

See also stopScan() and scanStatusChanged().

[signal] void QIviAmFmTunerBackendInterface::stationChanged(const QIviAmFmTunerStation &station)

Emitted when the current station changed. The new station is passed as station.

[pure virtual] void QIviAmFmTunerBackendInterface::stepDown()

Decreases the frequency by the current bands step size.

See also frequencyChanged and stationChanged.

[signal] void QIviAmFmTunerBackendInterface::stepSizeChanged(int stepSize)

Emitted when the frequency step size of the current band changed. The new value is passed as stepSize. This is usually caused by a switching the band.

See also bandChanged(), minimumFrequencyChanged(), and maximumFrequencyChanged().

[pure virtual] void QIviAmFmTunerBackendInterface::stepUp()

Increases the frequency by the current bands step size.

See also frequencyChanged and stationChanged.

[pure virtual] void QIviAmFmTunerBackendInterface::stopScan()

Stops the currently active scan. If no scan is active, this method does nothing. It is expected that this function will inform about the current state of the backend by emitting the scanStatusChanged() signal.

See also startScan() and scanStatusChanged().

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