IProfileManager

​

Interface IProfileManager

interface IProfileManager

Extends com.amazon.apmf.IStandard IProfileManager is an interface that allows management of speak profiles. It offers methods to retrieve all available profiles and a specific profile by its identifier. The profiles are collections of speech parameters that tailor the use for specific sectors of a software system.

​

Methods

​

getSpeakProfileIds()

SpeakProfileId[] getSpeakProfileIds()

Retrieves all available speak profile identifiers. A speak profile represents a predefined configuration for speech synthesis optimized for a particular use case. This method returns a collection of all supported profile identifiers that are available.

​

Returns

SpeakProfileId[] A collection of SpeakProfileId instances, with each instance uniquely identifying a different supported speak profile.

---

​

getSpeakProfiles()

ISpeakProfile*[] getSpeakProfiles()

Retrieves all available speak profiles.

​

Returns

ISpeakProfile*[] A collection of all available ISpeakProfile instances.

---

​

getSpeakProfileById()

ISpeakProfile* getSpeakProfileById(SpeakProfileId* profileId)

Fetches a particular speak profile using its identifier.

​

Parameters

profileId

SpeakProfileId* — Required The identifier of the speak profile to be retrieved.

​

Returns

ISpeakProfile* An instance of ISpeakProfile that matches the provided identifier.

​

Throws

• ProfileNotAvailableError — if the profile with the corresponding profileId is currently not available.

---

​

addSpeakProfileChangeListener()

com.amazon.apmf.ISubscription* addSpeakProfileChangeListener(ISpeakProfileChangeListener* listener)

Registers a listener to receive notifications about profile changes.

​

Parameters

listener

ISpeakProfileChangeListener* — Required The ISpeakProfileChangeListener to register.

​

Returns

com.amazon.apmf.ISubscription* The ISubscription instance to be used to unsubscribe to the listener.

---