Package: android.hardware.broadcastradio@1.1

ITuner

interface ITuner extends @1.0::ITuner

Methods

getProgramInformation_1_1

getProgramInformation_1_1 ()
generates (Result result, ProgramInfo info)

Retrieve current station information.

Details
Generates
result
OK if scan successfully started NOT_INITIALIZED if another error occurs
info
Current program information.

startBackgroundScan

startBackgroundScan ()
generates (ProgramListResult result)

Initiates a background scan to update internally cached program list.

HAL client may not need to initiate the scan explicitly with this call, ie.HAL implementation MAY perform the scan on boot.It's a common practice in devices with two physical tuners with background scanning.

Device must call backgroundScanComplete if the result is OK, even if the scan fails later(it must pass proper result through the callback). Otherwise, backgroundScanComplete must not be called as a result of this certain attempt.It may still be called as a response to another call to startBackgroundScan, former or latter.

Device may utilize an already running(but not finished)scan for subsequent calls to startBackgroundScan, issuing a single backgroundScanComplete callback.

Details
Generates
result
OK if the scan was properly scheduled(this does not mean it successfully finished). TEMPORARILY_UNAVAILABLE if the background scan is temporarily unavailable, ie.due to ongoing foreground playback in single-tuner device.NOT_INITIALIZED other error, ie.HW failure.

getProgramList

getProgramList (string filter)
generates (ProgramListResult result, vec<ProgramInfo> programList)

Retrieve station list.

This call does not trigger actual scan, but operates on the list cached internally at the driver level.

Details
Parameters
filter
vendor-specific filter for the stations to be retrieved.An empty string MUST result in full list.Client application MUST verify vendor/product name before setting this parameter to anything else.
Generates
result
OK if the list was successfully retrieved.NOT_READY if the scan is in progress.NOT_STARTED if the scan has not been started, client may call startBackgroundScan to fix this.NOT_INITIALIZED if any other error occurs.
programList
List of stations available for user.