com.dsi.ant.plugins.antplus.pcc.controls

Class AntPlusGenericRemoteControlPcc

java.lang.Object

com.dsi.ant.plugins.antplus.pccbase.AntPluginPcc

com.dsi.ant.plugins.antplus.pccbase.AntPlusCommonPcc

com.dsi.ant.plugins.antplus.pcc.controls.pccbase.AntPlusBaseRemoteControlPcc

com.dsi.ant.plugins.antplus.pcc.controls.AntPlusGenericRemoteControlPcc

public class AntPlusGenericRemoteControlPcc
extends AntPlusBaseRemoteControlPcc

Enables communication between a client and the RemoteControl plugin service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AntPlusGenericRemoteControlPcc.IGenericCommandFinishedReceiver Receiver for the GenericCommandFinished event, which is: Receives the result of a sent generic command.
class	AntPlusGenericRemoteControlPcc.IpcDefines Defines the keys and values used to communicate between the PCC and plugin.

Nested classes/interfaces inherited from class com.dsi.ant.plugins.antplus.pcc.controls.pccbase.AntPlusBaseRemoteControlPcc

AntPlusBaseRemoteControlPcc.ControlDeviceCapabilities, AntPlusBaseRemoteControlPcc.IControlDeviceAvailabilityReceiver, AntPlusBaseRemoteControlPcc.IRemoteControlAsyncScanResultReceiver, AntPlusBaseRemoteControlPcc.RemoteControlAsyncScanController<T extends AntPlusBaseRemoteControlPcc>, AntPlusBaseRemoteControlPcc.RemoteControlAsyncScanResultDeviceInfo

Nested classes/interfaces inherited from class com.dsi.ant.plugins.antplus.pccbase.AntPlusCommonPcc

AntPlusCommonPcc.CommonDataPage, AntPlusCommonPcc.IBatteryStatusReceiver, AntPlusCommonPcc.IManufacturerIdentificationReceiver, AntPlusCommonPcc.IManufacturerSpecificDataReceiver, AntPlusCommonPcc.IProductInformationReceiver, AntPlusCommonPcc.IRequestFinishedReceiver, AntPlusCommonPcc.IRssiReceiver

Nested classes/interfaces inherited from class com.dsi.ant.plugins.antplus.pccbase.AntPluginPcc

AntPluginPcc.IDeviceStateChangeReceiver, AntPluginPcc.IPluginAccessResultReceiver<T extends AntPluginPcc>

Field Summary

Fields inherited from class com.dsi.ant.plugins.antplus.pccbase.AntPluginPcc

PATH_ANTPLUS_PLUGINS_PKG

Method Summary

Methods

Modifier and Type	Method and Description
static PccReleaseHandle<AntPlusGenericRemoteControlPcc>	requestAccessByDeviceNumber(java.util.EnumSet<ControlsMode> requestModes, Context bindToContext, int antDeviceNumber, int searchProximityThreshold, AntPluginPcc.IPluginAccessResultReceiver<AntPlusGenericRemoteControlPcc> resultReceiver, AntPluginPcc.IDeviceStateChangeReceiver stateReceiver) Sends a request to the plugin to access a device and receive a live PCC instance.
void	RequestGenericCommand(AntPlusGenericRemoteControlPcc.IGenericCommandFinishedReceiver genericCommandFinishedReceiver, GenericCommandNumber commandNumber) Commands sent by a remote control to initiate an action on a generic controllable device.
void	RequestGenericCommandSequence(byte[] rawCommandBytes) Burst commands sent by a remote control to initiate an action on a generic controllable device.
static AntPlusBaseRemoteControlPcc.RemoteControlAsyncScanController<AntPlusGenericRemoteControlPcc>	requestRemoteControlAsyncScanController(java.util.EnumSet<ControlsMode> requestModes, Context bindToContext, int searchProximityThreshold, AntPlusBaseRemoteControlPcc.IRemoteControlAsyncScanResultReceiver scanResultReceiver) Sends a request to the plugin to start an asynchronous search for available devices.

Methods inherited from class com.dsi.ant.plugins.antplus.pcc.controls.pccbase.AntPlusBaseRemoteControlPcc

subscribeControlDeviceAvailabilityEvent

Methods inherited from class com.dsi.ant.plugins.antplus.pccbase.AntPlusCommonPcc

requestCommonDataPage, subscribeBatteryStatusEvent, subscribeManufacturerIdentificationEvent, subscribeManufacturerSpecificDataEvent, subscribeProductInformationEvent, subscribeRssiEvent, supportsRssi

Methods inherited from class com.dsi.ant.plugins.antplus.pccbase.AntPluginPcc

getAntDeviceNumber, getCurrentDeviceState, getDeviceName, getInstalledPluginsVersionNumber, getInstalledPluginsVersionString, getMissingDependencyName, getMissingDependencyPackageName, isUserPreferredDeviceForPlugin, isUserRecognizedDevice, releaseAccess, startPluginManagerActivity

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

requestRemoteControlAsyncScanController

public static AntPlusBaseRemoteControlPcc.RemoteControlAsyncScanController<AntPlusGenericRemoteControlPcc> requestRemoteControlAsyncScanController(java.util.EnumSet<ControlsMode> requestModes,
                                                                                                                                   Context bindToContext,
                                                                                                                                   int searchProximityThreshold,
                                                                                                                                   AntPlusBaseRemoteControlPcc.IRemoteControlAsyncScanResultReceiver scanResultReceiver)

Sends a request to the plugin to start an asynchronous search for available devices. Using the returned AudioRemoteAsyncScanner you can view available devices (including devices already connected to the plugin by other applications), receive user saved info and preferences for available devices, and eventually request access to a device you desire to connect to.

Note: The scan is started automatically, and must be stopped by your application to avoid resource leaks. (See the controller documentation for more details: AudioRemoteAsyncScanner.

Parameters:

requestModes - The modes that found devices must be capable of in order to be used.

bindToContext - The context to which the plugin will be bound. Used for plugin lifecycle management.

searchProximityThreshold - This value represents the signal strength 'proximity' requirement on finding matches during searching, if a device does not meet the requirements it will not show up in the search at all. The value is a generic signal strength rating from 1-10 where 1 is the strongest (ie: closest) and 10 is the lowest(ie: farthest away). 0 = don't use proximity search.

scanResultReceiver - The receiver to receive the info for available devices and status of the scan.

Returns:

The controller object for the asynchronous controller. Note: The scan is started automatically, and must be stopped by your application to avoid resource leaks. (See the controller documentation for more details: AudioRemoteAsyncScanner.

requestAccessByDeviceNumber

public static PccReleaseHandle<AntPlusGenericRemoteControlPcc> requestAccessByDeviceNumber(java.util.EnumSet<ControlsMode> requestModes,
                                                                           Context bindToContext,
                                                                           int antDeviceNumber,
                                                                           int searchProximityThreshold,
                                                                           AntPluginPcc.IPluginAccessResultReceiver<AntPlusGenericRemoteControlPcc> resultReceiver,
                                                                           AntPluginPcc.IDeviceStateChangeReceiver stateReceiver)

Sends a request to the plugin to access a device and receive a live PCC instance. If the minimum version of the desired plugin is installed, this will start an asynchronous search for a device to connect to and return the result on the provided result receiver.

The plugin will attempt to connect to a device with the provided deviceNumber and return a result when the device is connected or the search fails. The search will timeout after 10s, if you wish to keep searching you can call this method again.

Note: If you set deviceNumber to 0 it will connect to the first available/found device.

Parameters:

requestModes - A set containing the desired ControlsMode that must match the capabilities of found devices in order to connect.

bindToContext - The context to which the plugin will be bound. Used for plugin lifecycle management.

antDeviceNumber - DeviceNumber to attempt to connect to. A deviceNumber of 0 indicates a desire to connect to first available device.

searchProximityThreshold - This value represents the signal strength 'proximity' requirement on finding matches during searching, if a device does not meet the requirements it will not show up in the search at all. The value is a generic signal strength threshold from 1-10 where 1 is the strongest (ie: closest) and 10 is the lowest(ie: farthest away). 0 = don't use proximity search.

resultReceiver - The receiver to receive the results of the request. Possible returns include:

• RequestAccessResult.SUCCESS
• RequestAccessResult.SEARCH_TIMEOUT
• RequestAccessResult.CHANNEL_NOT_AVAILABLE
• RequestAccessResult.BAD_PARAMS
• RequestAccessResult.ADAPTER_NOT_DETECTED
• RequestAccessResult.DEPENDENCY_NOT_INSTALLED
• RequestAccessResult.OTHER_FAILURE

stateReceiver - The receiver to receive the state updates of the accessed device, assuming the request is successful. This receiver will receive notifications of all state changes to the device that occur subsequent to the initial state returned in the result receiver.

Returns:

A release handle for the device. This can be used to guarantee the device is properly shutdown and cleaned up, even before the device is actually received through the result receiver.

RequestGenericCommand

public void RequestGenericCommand(AntPlusGenericRemoteControlPcc.IGenericCommandFinishedReceiver genericCommandFinishedReceiver,
                         GenericCommandNumber commandNumber)

Commands sent by a remote control to initiate an action on a generic controllable device.

Parameters:

volumeIncrement - The percentage amount of volume increase/decrease.

RequestGenericCommandSequence

public void RequestGenericCommandSequence(byte[] rawCommandBytes)

Burst commands sent by a remote control to initiate an action on a generic controllable device.

Parameters:

rawCommandBytes - The raw byte contents of a list of generic commands.