IAudioSinkPlayerSettings

​

Interface IAudioSinkPlayerSettings

interface IAudioSinkPlayerSettings

Extends com.amazon.apmf.IStandard The Audio Sink player settings.

​

Methods

​

setRepeatMode()

void setRepeatMode(PlayerSettingsRepeat* mode)

Sets the repeat mode. This is a blocking call and returns after we get an accept from the target, or a timeout. Privilege: com.amazon.bluetooth.privilege.audio_sink

​

Parameters

mode

PlayerSettingsRepeat* — Required The repeat mode selection as per PlayerSettingsRepeat.

​

Throws

• BluetoothAudioNotConnected — if there is no audio connection.

---

​

setShuffleMode()

void setShuffleMode(PlayerSettingsShuffle* mode)

Sets the shuffle mode. This is a blocking call and returns after an accept from the target or a timeout is received. Privilege: com.amazon.bluetooth.privilege.audio_sink

​

Parameters

mode

PlayerSettingsShuffle* — Required The shuffle mode selection as per PlayerSettingsShuffle.

​

Throws

• BluetoothAudioNotConnected — if there is no audio connection.

---

​

setScanMode()

void setScanMode(PlayerSettingsScan* mode)

Sets the scan mode. This is a blocking call and returns after an accept from the target or a timeout is received. Privilege: com.amazon.bluetooth.privilege.audio_sink

​

Parameters

mode

PlayerSettingsScan* — Required The scan mode selection as per the PlayerSettingsScan.

​

Throws

• BluetoothAudioNotConnected — if there is no audio connection.

---

​

getRepeatMode()

PlayerSettingsRepeat getRepeatMode()

Retrieves the current repeat mode setting. This information is retrieved from the data cached in the Bluetooth service. This is a synchronous call across IPC to the Bluetooth service. Privilege: com.amazon.bluetooth.privilege.audio_sink

​

Returns

PlayerSettingsRepeat Returns PlayerSettingsRepeat.

​

Throws

• BluetoothAudioNotConnected — if there is no audio connection.

---

​

getShuffleMode()

PlayerSettingsShuffle getShuffleMode()

Retrieves the current shuffle mode setting. This information is retrieved from the data cached in the Bluetooth service. This is a synchronous call across IPC to the Bluetooth service. Privilege: com.amazon.bluetooth.privilege.audio_sink

​

Returns

PlayerSettingsShuffle Returns PlayerSettingsShuffle.

​

Throws

• BluetoothAudioNotConnected — if there is no audio connection.

---

​

getScanMode()

PlayerSettingsScan getScanMode()

Retrieves the current scan mode setting. This information is retrieved from the data cached in the Bluetooth service. This is a synchronous call across IPC to the Bluetooth service. Privilege: com.amazon.bluetooth.privilege.audio_sink

​

Returns

PlayerSettingsScan Returns PlayerSettingsScan.

​

Throws

• BluetoothAudioNotConnected — if there is no audio connection.

---

​

enableEqualizer()

void enableEqualizer()

Turns on the equalizer. Privilege: com.amazon.bluetooth.privilege.audio_sink This is a blocking call and returns after an accept from the target or a timeout is received.

​

Throws

• BluetoothAudioNotConnected — if there is no audio connection.

---

​

disableEqualizer()

void disableEqualizer()

Turns off the equalizer. This is a blocking call and returns after an accept from the target or a timeout is received. Privilege: com.amazon.bluetooth.privilege.audio_sink

​

Throws

• BluetoothAudioNotConnected — if there is no audio connection.

---

​

isEqualizerEnabled()

bool isEqualizerEnabled()

Retrieves the current equalizer mode (on/off). This information is retrieved from the data cached in the Bluetooth service. This is a synchronous call across IPC to the Bluetooth service. Privilege: com.amazon.bluetooth.privilege.audio_sink

​

Returns

bool Returns true, if equalizer is enabled, otherwise false.

​

Throws

• BluetoothAudioNotConnected — if there is no audio connection.

---