Documentation/Maemo 5 Developer Guide/Using Multimedia Components/FM Transmitter API Usage


The FM Transmitter is controlled by fmtx-middleware program via D-Bus API. API includes functions to enable transmitter, change transmitting frequency and station name. Please note that available frequencies may vary by sales region and FM Transmitter may be disabled in certain sales regions. Transmitter is also disabled when external devices are connected to Maemo device, excluding charger and Bluetooth devices. When FM Transmitter is enabled, fmtx-middleware will route audio automatically to the transmitter and enforce proper transmission power allowed in sales region. Fmtx-middleware will emit beeping tone when no other audio is being transmitter to comply with legislature. API documentation is in the fmtx-middleware-doc package.

Contents

[edit] API documentation

Service
com.nokia.FMTx
Interface
com.nokia.FMTx.Device
Object path
/com/nokia/fmtx/default

[edit] Properties

D-Bus properties
Name Type Flags Description
version Uint32 Read only Version number of fmtx-middleware
frequency Uint32 Read/write Frequency in kHz. Returns DBUS_GERROR_INVALID_ARGS error, if frequency is not allowed
freq_max Uint32 Read only Returns maximum allowed frequency in kHz
freq_step Uint32 Read only Returns the minimum step between frequencies in kHz
state String Read/write Returns the state of the transmitter. States are:
  • enabled – Transmitter is currently enabled
  • disabled – Transmitter is currently disabled
  • error – Internal error while initializing the transmitter, transmitter can’t be enabled.
  • n/a – Transmitter is permanently disabled in this device.

State can be set to enabled or disabled. May return DBUS_GERROR_FAILED if transmitter can’t be enabled

startable String Read only Returns message about can the transmitter be enabled at current time. Messages are: true Device is in offline mode Headphones are connected USB device is connected
rds_ps String Read/write Get/Set RDS Station name (displayed on rds capable radios). To avoid problems with some radios, use text which length is dividable by 8. Pad with spaces if necessary
rds_text String Read/write Get/Set RDS text (displayed alternating with station name. Maximum length is 64 characters. Returns DBUS_GERROR_INVALID_ARGS is set if the text is too long

[edit] Signals

D-Bus signals
Name Type Description
Changed None Some fmtx property was changed
Error String FM transmitter was disabled by one of the following reasons:
  • Device entered offline mode
  • USB device was connected (excluding charger)
  • Headphones were connected
  • TV-Out cable was connected

Properties are manipulated with org.freedesktop.DBus.Properties interface. For more information see D-Bus documentation.

Retrieved from "http://bugs.maemo.org/Documentation/Maemo_5_Developer_Guide/Using_Multimedia_Components/FM_Transmitter_API_Usage"