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

Class AntPlusAudioControllableDevicePcc

java.lang.Object

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

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

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

public class AntPlusAudioControllableDevicePcc
extends AntPlusBaseControllableDevicePcc

Enables communication between a client and the audio link of the AntPlusControllableDevice plugin service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AntPlusAudioControllableDevicePcc.IAudioCommandReceiver Receiver for the AudioCommand event, which is: Commands sent by a remote control to initiate an action on an audio device.
static class	AntPlusAudioControllableDevicePcc.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.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<AntPlusAudioControllableDevicePcc>	requestAccess(Context bindToContext, AntPluginPcc.IPluginAccessResultReceiver<AntPlusAudioControllableDevicePcc> resultReceiver, AntPluginPcc.IDeviceStateChangeReceiver stateReceiver, AntPlusAudioControllableDevicePcc.IAudioCommandReceiver audioCommandReceiver, AudioDeviceCapabilities capabilities, int channelDeviceNumber) Send a request to access the plugin to receive audio commands and gain control of audio status updates.
void	updateAudioStatus(int volume, int totalTrackTime, int currentTrackTime, AudioDeviceState audioState, AudioRepeatState repeatState, AudioShuffleState shuffleState) Update the status of the audio device

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

requestAccess

public static PccReleaseHandle<AntPlusAudioControllableDevicePcc> requestAccess(Context bindToContext,
                                                                AntPluginPcc.IPluginAccessResultReceiver<AntPlusAudioControllableDevicePcc> resultReceiver,
                                                                AntPluginPcc.IDeviceStateChangeReceiver stateReceiver,
                                                                AntPlusAudioControllableDevicePcc.IAudioCommandReceiver audioCommandReceiver,
                                                                AudioDeviceCapabilities capabilities,
                                                                int channelDeviceNumber)

Send a request to access the plugin to receive audio commands and gain control of audio status updates. Only one client is allowed access to this mode at a time.

Parameters:

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

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

• RequestAccessResult#SUCCESS
• RequestAccessResult#DEVICE_ALREADY_IN_USE
• RequestAccessResult#USER_CANCELLED
• 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, if 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.

audioCommandReceiver - Receiver to receive audio events

capabilities - An instance of AudioDeviceCapabilities used to indicate the capabilities of the audio device (e.g., support for custom shuffle or repeat mode). Capabilities cannot be changed after initialization.

channelDeviceNumber - Two-byte device number in the ANT channel ID to use when opening the controls channel. This number is used for pairing with remotes and should be as unique as possible. Set to zero to let the plugin generate the device ID (RECOMMENDED) based on the ANDROID_ID. This number cannot be changed after initialization.

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.

updateAudioStatus

public void updateAudioStatus(int volume,
                     int totalTrackTime,
                     int currentTrackTime,
                     AudioDeviceState audioState,
                     AudioRepeatState repeatState,
                     AudioShuffleState shuffleState)

Update the status of the audio device

Parameters:

volume - Current volume setting, given as a percentage.

totalTrackTime - Total time of the current track, in seconds

currentTrackTime - Current number of seconds into the current track

audioState - Current AudioDeviceState of the music player

repeatState - Current AudioRepeatState of the music player

shuffleState - Current AudioShuffleState of the music player