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

2010-08-26T22:58:37Z

62.35.15.174: /* Properties */ clarified possible 'state' values

__FORCETOC__

FM Transmitter is controlled by <code>fmtx-middleware</code> 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.

== API documentation ==

<pre>
Service: com.nokia.FMTx
Interface: com.nokia.FMTx.Device
Object path: /com/nokia/fmtx/default
</pre>

===Properties===

{| class="wikitable"
| version
| Uint32
| Read only
| Version number of <code>fmtx-middleware</code>
|-
| frequency
| Uint32
| Read/write
| Frequency in kHz. Returns <code>DBUS_GERROR_INVALID_ARGS</code> 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 <code>DBUS_GERROR_FAILED</code> 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 <code>DBUS_GERROR_INVALID_ARGS</code> is set text is too long
|}

===Signals===

{| class="wikitable"
| Changed
| None
| Some fmtx property was changed
|-
| Error
| String
| FM transmitter was disabled by one of the following reasons: <ul><li>Device entered offline mode</li><li>USB device was connected (excluding charger)</li><li>Headphones were connected</li><li>TV-Out cable was connected</li></ul>
|}

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

[[Category:Development]]
[[Category:Documentation]]
[[Category:Fremantle]]

Maemo Wiki Mirror - User contributions [en]

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