Openmokast.org DBus Interface Specification

org.openmokast.Receiver.Control

Description

The Receiver Control interface is used to control the broadcasting receiver.

Namespace

org.openmokast.Receiver.Control

Methods

Signals

Errors

None

Methods

Tune ( uu ) -> b

Description: Tune the given frequency.

Parameters

u: frequency

The frequency in KHz.

u: mode

The DAB mode.

Returns

b: ret

True if command was accepted.

Scan ( uu ) -> b

Description: Tuning the first available frequency starting at the given frequency and band.

Parameters

u: frequency

The frequency in KHz.

u: band

The DAB band: 1=Band-III, 2=L-Band, 3=Canada-L-Band(default), 4=Korea-Band-III.

Returns

b: ret

True if command was accepted.

ScanAll ( u ) -> aub

Description: Create a list of the available frequencies at the given band.

Parameters

u: band

The DAB band: 1=Band-III, 2=L-Band, 3=Canada-L-Band(default), 4=Korea-Band-III.

Returns

au: frequency_array_ret

An array containing the available frequencies.

b: ret

True if command was accepted.

GetFrequency ( ) -> ub

Description: Returns the frequency that is currently tuned or 0 if nothing is tuned.

Returns

u: frequency_ret

The currently tuned frequency or 0 of not tuned.

b: ret

True if command succeeded.

GetStatus ( ) -> sb

Description: Returns the status of the receiver.

Returns

s: status_ret

A protocol dependent string containing the current status of the receiver.

b: ret

True if command succeeded.

IsDecoding ( uu ) -> b

Description: Returns the status of a component decoding.

Parameters

u: service_id

The service identifier.

u: component_id

The component identifier.

Returns

b: ret

True if the selected component is currently decoded.

StartDecoding ( uu ) -> sb

Description: Starts the decoding of a component.

Parameters

u: service_id

The service identifier.

u: component_id

The component identifier.

Returns

s: uri_ret

The URI of the newly started component.

b: ret

True if the command succeeded. False if the component doesn't exist or if it cannot be decoded.

StopDecoding ( uu ) -> b

Description: Stops the decoding of a component.

Parameters

u: service_id

The service identifier.

u: component_id

The component identifier.

Returns

b: ret

True if the command succeeded. False if the component doesn't exist.

GetEnsemble ( ) -> usb

Description: Get information about the tuned ensemble.

Returns

u: id_ret

The identifier of the tuned ensemble or 0 if no ensemble found.

s: label_ret

The name of the tuned ensemble.

b: ret

True if command succeeded.

GetServiceArray ( ) -> auasb

Description: Get information about the available services.

Returns

au: id_array_ret

Array containing a list of service identifiers for the current ensemble.

as: label_array_ret

Array containing a list of service labels for the current ensemble. The array size is the same than the array of identifiers

b: ret

True if command succeeded.

GetComponentArray ( u ) -> auasb

Description: Get information about the components inside a service.

Parameters

u: service_id

The service identifier.

Returns

au: id_array_ret

Array containing a list of component identifiers for the current service. The first element in the list is the main component.

as: label_array_ret

Array containing a list of component labels for the current service. The array size is the same than the array of identifiers

b: ret

True if command succeeded.

GetTransportMode ( uu ) -> ub

Description: Get information about the transport mode for a component.

Parameters

u: service_id

The service identifier.

u: component_id

The component identifier.

Returns

u: transport_mode_ret

The identifier of the transport mode for the component. The possible values are: 0 for AUDIO STREAM, 1 for DATA STREAM, 2 for FIDC SERVICE and 3 for DATA PACKET SERVICE.

b: ret

True if component exists.

GetDataComponentType ( uu ) -> ub

Description: Get information about the type of a data component.

Parameters

u: service_id

The service identifier.

u: component_id

The component identifier.

Returns

u: data_component_type_ret

The DSCTy (Data Service Component Type). The possible values are defined in TS 101 756, table 2.

b: ret

True if component exists.

GetUserApplicationType ( uu ) -> ub

Description: Get information about the User Application (UA) type for a component.

Parameters

u: service_id

The service identifier.

u: component_id

The component identifier.

Returns

u: ua_type_ret

The User Application type as defined in Table 16 of ETSI TS 101 756.

b: ret

True if component exists.

GetReceiverCapabilities ( )

Description: TO BE DEFINED - Get information about the receiver such as the number of subchannels that can be decoded at the same time.

GetAvailableReceivers ( )

Description: TO BE DEFINED - Get the available receivers from the platform.

SelectReceiver ( )

Description: TO BE DEFINED - Select the active receiver.

SelectOutputType ( )

Description: TO BE DEFINED - Select the output format for the data of a decoded component.

Signals

ensemble_updated_notify ( s )

Description: Emitted when the current ensemble is updated with new information.

Parameters

s: update_str

A protocol dependent string that identifies what was updated.

status_updated_notify ( s )

Description: Emitted when the current status of the receiver is updated with new information.

Parameters

s: update_str

A receiver dependent string that contains the status of the receiver.

| Specified 2008 by Jean-Michel Bouffard for the openmokast.org project. | For more information: jean-michel (dot) bouffard (at) crc (dot) ca