AmFmTuner QML Type

Provides a interface to control the AM/FM tuner. More...

Import Statement: import QtIvi.Media 1.0
Instantiates: QIviAmFmTuner
Inherits:

AbstractFeature

Properties

Signals

Methods

Detailed Description

The AmFmTuner provides the methods to control a AM/FM tuner.

Property Documentation

band : enumeration

The current band of the tuner.

Available values are:

ConstantDescription
AMBandThe AM Band is based on the Amplitude Modulation technique and can range from 520 to 1610 kHz (1710 kHz). The step size is usually between 9 or 10 kHz.
FMBandThe FM Band is based on the Frequency Modulation technique and can range from 87.5 to 108.0 MHz. The step size is usually 100 kHz.

discoveryMode : enumeration

Holds the mode that is used for the autoDiscovery

Available values are:

ConstantDescription
NoAutoDiscoveryNo auto discovery is done and the ServiceObject needs to be set manually.
AutoDiscoveryTries to find a production backend with a matching interface and falls back to a simulation backend if not found.
LoadOnlyProductionBackendsOnly tries to load a production backend with a matching interface.
LoadOnlySimulationBackendsOnly tries to load a simulation backend with a matching interface.

If necessary, auto discovery is started once the feature creation is completed.

Note: If you change this property after the feature is instantiated, make sure to call startAutoDiscovery() to search for a new service object.


discoveryResult : enumeration

The result of the last autoDiscovery

Available values are:

ConstantDescription
NoResultIndicates that no auto discovery was started because the feature has already assigned a valid ServiceObject.
ErrorWhileLoadingAn error has happened while searching for a backend with a matching interface.
ProductionBackendLoadedA production backend was loaded, as a result of auto discovery.
SimulationBackendLoadedA simulation backend was loaded, as a result of auto discovery.s

frequency : int

The current frequency of the tuner.


isInitialized : bool

Indicates whether the feature has been initialized with all the values from the backend.

The property is true once the backend sends the QIviFeatureInterface::initializationDone signal to indicate that all values have now been initialized with values from the backend.

See also isValid and QIviFeatureInterface::initializationDone.


isValid : bool

Indicates whether the feature is ready for use.

The property is true if the feature is ready to be used, otherwise false. Not being ready usually indicates that no suitable service object could be found, or that automatic discovery has not been triggered.

The backend still might not have sent all properties yet and is not fully initialized. Use isInitialized instead to know when the feature holds all correct values.

See also QIviServiceObject, discoveryMode, and isInitialized.


maximumFrequency : int

The maximum frequency of the current band.


minimumFrequency : int

The minimum frequency of the current band.


scanRunning : bool

true while a scan is in progress, false otherwise.

See also startScan(), stopScan(), scanStarted(), and scanStopped().


serviceObject : ServiceObject

Sets the service object for the feature.

As Features only expose the front API facing the developer, a service object implementing the actual function is required. This is usually retrieved through the auto discovery mechanism.

The setter for this property returns false if the QIviServiceObject is already set to this particular instance or the QIviServiceObject isn't accepted by the feature.

See also discoveryMode.


station : AmFmTunerStation

The currently tuned station.


stepSize : int

The frequency step size of the current band.

See also stepUp() and stepDown().


Signal Documentation

scanStarted()

A new scan has started and is now running.

See also startScan, stopScan, scanRunning, and scanStopped.


scanStopped()

The currently active scan has stopped.

See also startScan, stopScan, scanRunning, and scanStarted.


Method Documentation

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.


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.


enumeration startAutoDiscovery()

Performs an automatic discovery attempt.

The feature tries to locate a single ServiceObject that implements the required interface.

If no ServiceObject is found, the feature remains invalid. If more than one ServiceObject is found, the first instance is used.

This function returns either the type of the backend that was loaded; or an error.

If the discoveryMode is set to QIviAbstractFeature::NoAutoDiscovery, this function does nothing and returns QIviAbstractFeature::NoResult.

Return values are:

ConstantDescription
NoResultIndicates that no auto discovery was started because the feature already has a valid ServiceObject assigned.
ErrorWhileLoadingIndicates an error has occurred while searching for a backend with a matching interface.
ProductionBackendLoadedA production backend was loaded, as a result of auto discovery.
SimulationBackendLoadedA simulation backend was loaded, as a result of auto discovery.

See also Dynamic Backend System and QIviServiceManager.


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.

See also stopScan, scanRunning, scanStarted, and scanStopped.


stepDown()

Decreases the frequency by the current bands step size.


stepUp()

Increases the frequency by the current bands step size.


stopScan()

Stops the currently active scan. If no scan is active, this method does nothing.

See also startScan, scanRunning, scanStarted, and scanStopped.


tune(station)

Tunes to the provided station.


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