Editing Documentation/Maemo 5 Developer Guide/Using Multimedia Components/FM Transmitter API Usage
Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 1: | Line 1: | ||
__FORCETOC__ | __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 == | == API documentation == | ||
| - | + | <pre> | |
| - | : | + | Service: com.nokia.FMTx |
| - | + | Interface: com.nokia.FMTx.Device | |
| - | : | + | Object path: /com/nokia/fmtx/default |
| - | + | </pre> | |
| - | : | + | |
===Properties=== | ===Properties=== | ||
{| class="wikitable" | {| class="wikitable" | ||
| - | | | + | | version |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| Uint32 | | Uint32 | ||
| Read only | | Read only | ||
| Version number of <code>fmtx-middleware</code> | | Version number of <code>fmtx-middleware</code> | ||
|- | |- | ||
| - | | | + | | frequency |
| Uint32 | | Uint32 | ||
| Read/write | | Read/write | ||
| Frequency in kHz. Returns <code>DBUS_GERROR_INVALID_ARGS</code> error, if frequency is not allowed | | Frequency in kHz. Returns <code>DBUS_GERROR_INVALID_ARGS</code> error, if frequency is not allowed | ||
|- | |- | ||
| - | | | + | | freq_max |
| Uint32 | | Uint32 | ||
| Read only | | Read only | ||
| Returns maximum allowed frequency in kHz | | Returns maximum allowed frequency in kHz | ||
|- | |- | ||
| - | | | + | | freq_step |
| Uint32 | | Uint32 | ||
| Read only | | Read only | ||
| Returns the minimum step between frequencies in kHz | | Returns the minimum step between frequencies in kHz | ||
|- | |- | ||
| - | | | + | | state |
| String | | String | ||
| Read/write | | Read/write | ||
| Line 53: | Line 46: | ||
May return <code>DBUS_GERROR_FAILED</code> if transmitter can’t be enabled | May return <code>DBUS_GERROR_FAILED</code> if transmitter can’t be enabled | ||
|- | |- | ||
| - | | | + | | startable |
| String | | String | ||
| Read only | | 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 | | 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 | | String | ||
| Read/write | | 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 | | 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 | | String | ||
| Read/write | | 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 | + | | 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 |
|} | |} | ||
| Line 72: | Line 65: | ||
{| class="wikitable" | {| class="wikitable" | ||
| - | | | + | | Changed |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| None | | None | ||
| Some fmtx property was changed | | Some fmtx property was changed | ||
|- | |- | ||
| - | | | + | | Error |
| String | | 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> | | 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 | + | Properties are manipulated with <code>org.freedesktop.DBus.Properties</code> interface. For more information see D-Bus documentation. |
[[Category:Development]] | [[Category:Development]] | ||
[[Category:Documentation]] | [[Category:Documentation]] | ||
[[Category:Fremantle]] | [[Category:Fremantle]] | ||
Learn more about Contributing to the wiki.