ISystemSoundsManager

​

Interface ISystemSoundsManager

interface ISystemSoundsManager

Extends com.amazon.apmf.IStandard Interface for encapsulating System Sounds Manager module

​

Methods

​

disableSystemSounds()

void disableSystemSounds()

Disable system sounds System sound enablement will persist through boot cycles Needs privilege com.amazon.audio.privilege.settings.control

​

Throws

• SecurityError — if there is no permission or package signature validation fails

---

​

enableSystemSounds()

void enableSystemSounds()

Enable system sounds System sound enablement will persist through boot cycles Needs privilege com.amazon.audio.privilege.settings.control

​

Throws

• SecurityError — if there is no permission or package signature validation fails

---

​

areSystemSoundsEnabled()

bool areSystemSoundsEnabled()

Retrieve the status of system sound enablement Depending on platform-specific settings, the default may change. It is recommended during app setup to check if system sounds are enabled by calling this API.

​

Returns

bool return true if system sounds are enabled, false otherwise

---

​

getSystemSoundThemeList()

string[] getSystemSoundThemeList()

Get all the supported system sound themes by the platform. Each sound theme will contain a predefined set of sound tones that will be played using the playSystemSound API. The list here will correspond with the acceptable sound themes to be used in setSystemSoundTheme API.

​

Returns

string[] returns a list of System Sound Themes supported by the platform.

​

Throws

• OutOfMemoryError — if failed to allocate memory

---

​

setSystemSoundTheme()

void setSystemSoundTheme(string systemSoundTheme)

Set theme to specified System Sound Theme

​

Parameters

systemSoundTheme

string — Required character string to specify the sound theme name Upon success playSystemSound may play a different set of tones. getSystemSoundThemeList can be called prior to using this API to determine what system sound themes are supported by the system. Note, once set the system sound theme will persist through boot cycles. Needs privilege com.amazon.audio.privilege.settings.control

​

Throws

• SecurityError — if there is no permission or package signature validation fails

---

​

getSystemSoundTheme()

string getSystemSoundTheme()

Retrieve the current System Sound Theme

​

Returns

string character string indicating current system sound theme.

​

Throws

• OutOfMemoryError — if failed to allocate memory,

---

​

playSystemSound()

void playSystemSound(SystemSound* systemSoundType)

Plays specified system sound

​

Parameters

systemSoundType

SystemSound* — Required sound to be played

​

Throws

• InvalidArgumentError — if the system sound is not supported by the active system sound theme InvalidOperationError if the system sounds are disabled

---