FM Transmitter D-Bus api

com.nokia.FMTx — FMTx interface

Object path: /com/nokia/fmtx/default

Signal interface: com.nokia.FMTx.Device

Methods







Signals


Changed ()
Error ('s'	error message)







Implemented Interfaces


com.nokia.FMTx implements
    org.freedesktop.DBus.Properties
    







Properties


version 	('u'	version	readonly)
frequency	('u'	frequency read/write)
freq_max	('u' 	maximum frequency	readonly)
freq_min	('u' 	minimum frequency	readonly)
freq_step	('u' 	frequency step	readonly)
state		('s' 	state	read/write)
startable	('s'	message about can the transmitter be enabled at the monent	readonly)
rds_ps		('s'	rds station name	read/write)
rds_text	('s'	rds text	read/write)







Description









Signal Details





The Changed signal


Changed ()





            This signal is emitted when any property of com.nokia.FMTx is changed
          












The Error signal


Error ('s'	message)





            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

          










message:


            
			Error message
            
          











Property Details








The version property


version (readonly 'u'	version)





            Version number of fmtx-middleware
          










version:


            
			Version number of fmtx-middleware
            
          












The frequency property


frequency (read/write 'u'	frequency)





            Frequency in kHz. Returns DBUS_GERROR_INVALID_ARGS error, if frequency is
not allowed.
          










frequency:


            
			frequency in kHz
            
          












The freq_max property


freq_max (readonly 'u'	maximum frequency)





            Returns maximum allowed frequency in kHz.
          










maximum frequency:


            
			maximum frequency in kHz
            
          












The freq_min property


freq_min (readonly 'u'	minimum frequency)





            Returns minimum allowed frequency in kHz.
          










minimum frequency:


            
			minimum frequency in kHz
            
          












The freq_step property


freq_step (readonly 'u'	step frequency)





            Returns the minimum step between frequencies is kHz.
          










step frequency:


            
			Minimum step between frequencies in kHz.
            
          












The state property


state (read/write 's'	state)





            Sets/returns the state of the transmitter. 
          










state:


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

            
          		












The startable property


startable (readonly 's'	message)





            Returns message about can the transmitter be enabled at current time. 
          










message:


            
			
Possible messages are:
true
Device is in offline mode
Headphones are connected
Usb device is connected

            
          		












The rds_ps property


rds_ps (read/write 's'	name)





            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.
          










name:


            RDS Station name.
            
          












The rds_text property


rds_text (read/write 's'	text)





            Get/Set RDS text (displayed alternating with station name. Maximum length is 
64 characters. Returns DBUS_GERROR_INVALID_ARGS is set text is too long.
          










text:


            RDS message text.