QRadioTuner

PyQt5.QtMultimedia.QRadioTuner

Inherits from QMediaObject.

Description

The QRadioTuner class provides an interface to the systems analog radio device.

You can control the systems analog radio device using this interface, for example:

#     radio = new QRadioTuner;
#     connect(radio, SIGNAL(frequencyChanged(int)), this, SLOT(freqChanged(int)));
#     if (radio->isBandSupported(QRadioTuner::FM)) {
#         radio->setBand(QRadioTuner::FM);
#         radio->setFrequency(yourRadioStationFrequency);
#         radio->setVolume(100);
#         radio->start();
#     }

The radio object will emit signals for any changes in state such as: bandChanged, frequencyChanged, stereoStatusChanged, searchingChanged, signalStrengthChanged, volumeChanged, mutedChanged.

You can change between the frequency bands using setBand() however it is recommended that you check to make sure the band is available first using isBandSupported().

See also

QRadioData, Radio Overview.

Enums

Band

Enumerates radio frequency bands.

Member	Value	Description
AM	0	520 to 1610 kHz, 9 or 10kHz channel spacing, extended 1610 to 1710 kHz
FM	1	87.5 to 108.0 MHz, except Japan 76-90 MHz
FM2	4	range not defined, used when area supports more than one FM range.
LW	3	148.5 to 283.5 kHz, 9kHz channel spacing (Europe, Africa, Asia)
SW	2	1.711 to 30.0 MHz, divided into 15 bands. 5kHz channel spacing

---

Error

Enumerates radio tuner error conditions.

Member	Value	Description
NoError	0	No errors have occurred.
OpenError	2	Unable to open radio device.
OutOfRangeError	3	An attempt to set a frequency or band that is not supported by radio device.
ResourceError	1	There is no radio service available.

---

SearchMode

Enumerates how the radio tuner should search for stations.

Member	Value	Description
SearchFast	0	Use only signal strength when searching.
SearchGetStationId	1	After finding a strong signal, wait for the RDS station id (PI) before continuing.

---

State

Enumerates radio tuner states.

Member	Value	Description
ActiveState	0	The tuner is started and active.
StoppedState	1	The tuner device is stopped.

---

StereoMode

Enumerates radio tuner policy for receiving stereo signals.

Member	Value	Description
Auto	2	Uses the stereo mode matching the station.
ForceMono	1	Provide mono mode, converting if required.
ForceStereo	0	Provide stereo mode, converting if required.

Methods

__init__(parent: QObject = None)

Constructs a radio tuner based on a media service allocated by the default media service provider.

The parent is passed to QMediaObject.

---

availability() → AvailabilityStatus

TODO

---

band() → Band

See also

setBand().

---

cancelSearch()

Stops scanning for a signal.

See also

searchForward(), searchBackward(), searching.

---

error() → Error

Returns the error state of a radio tuner.

See also

errorString().

---

errorString() → str

Returns a description of a radio tuner’s error state.

See also

error.

---

frequency() → int

See also

setFrequency().

---

frequencyRange(Band) → Tuple[int, int]

Returns a frequency band’s minimum and maximum frequency.

---

frequencyStep(Band) → int

Returns the number of Hertz to increment the frequency by when stepping through frequencies within a given band.

---

isAntennaConnected() → bool

TODO

---

isBandSupported(Band) → bool

Identifies if a frequency band is supported by a radio tuner.

Returns true if the band is supported, and false if it is not.

---

isMuted() → bool

TODO

---

isSearching() → bool

TODO

---

isStereo() → bool

TODO

---

radioData() → QRadioData

TODO

---

searchAllStations(searchMode: SearchMode = SearchFast)

Search all stations in current band

Emits stationFound(int, QString) for every found station. After searching is completed, searchingChanged(bool) is emitted (false). If searchMode is set to SearchGetStationId, searching waits for station id (PI) on each frequency.

See also

searchForward(), searchBackward(), searching.

---

searchBackward()

Starts a backwards scan for a signal, starting from the current frequency().

See also

searchForward(), cancelSearch(), searching.

---

searchForward()

Starts a forward scan for a signal, starting from the current frequency().

See also

searchBackward(), cancelSearch(), searching.

---

setBand(Band)

Sets a radio tuner’s frequency band.

Changing the band will reset the frequency() to the new band’s minimum frequency.

See also

band().

---

setFrequency(int)

Sets a radio tuner’s frequency.

If the tuner is set to a frequency outside the current band(), the band will be changed to one occupied by the new frequency.

See also

frequency().

---

setMuted(bool)

See also

isMuted().

---

setStereoMode(StereoMode)

See also

stereoMode().

---

setVolume(int)

See also

volume().

---

signalStrength() → int

TODO

---

start()

Activate the radio device.

---

state() → State

TODO

---

stereoMode() → StereoMode

See also

setStereoMode().

---

stop()

Deactivate the radio device.

---

volume() → int

See also

setVolume().

Signals

antennaConnectedChanged(bool)

TODO

---

bandChanged(Band)

TODO

---

error()

Returns the error state of a radio tuner.

See also

errorString().

---

error(Error)

Returns the error state of a radio tuner.

See also

errorString().

---

frequencyChanged(int)

TODO

---

mutedChanged(bool)

TODO

---

searchingChanged(bool)

TODO

---

signalStrengthChanged(int)

TODO

---

stateChanged(State)

TODO

---

stationFound(int, str)

TODO

---

stereoStatusChanged(bool)

TODO

---

volumeChanged(int)

TODO