HERE Android SDK Developer's Guide

VoicePackage

The class VoicePackage is a member of com.here.android.mpa.guidance .

Class Summary

public final class VoicePackage

extends java.lang.Object

Return information about downloaded voice packages.

[For complete information, see the section Class Details]

Nested Class Summary

Table 1. Nested Classes in VoicePackage
Nested Classes

public static final enumeration VoicePackage.Gender

Gender for a VoicePackage .

public static final enumeration VoicePackage.TravelMode

Travel Mode of voice package.

Method Summary

Table 2. Methods in VoicePackage
Methods

public String getBCP47Code ()

Get the international BCP-47 code describing the language of the voice skin (see http://tools.ietf.org/rfc/bcp/bcp47.txt).

public float getContentSize ()

Size of the package after unzipping to the device

public Hashtable getCustomAttributes ()

Gets the custom attributes from the Voice package.

public float getDownloadSize ()

Size of the download required for this package

public Gender getGender ()

Gets the gender of the voice skin.

public long getId ()

Get the package identifier.

public String getLocalizedGender ()

Gets the localized description of the gender for this voice skin.

public String getLocalizedLanguage ()

Get the localized description of the language of this voice skin.

public String getLocalizedQuality ()

Get the localized description of the voice skin quality

public String getLocalizedType ()

Get the localized description for the type of voice package.

public String getMarcCode ()

Get the international MARC code describing the language of the voice skin (see http://www.loc.gov/marc/languages).

public String getName ()

Get the package name.

public String getQuality ()

Get the text description of the voice skin quality

public TravelMode getTravelMode ()

Get the VoicePackage.TravelMode of voice package.

public String getVersion ()

Get the package version.

public boolean isLocal ()

Check if the voice is locally installed.

public boolean isTts ()

Get voice TextToSpeech capability.

public boolean isTtsLanguageAvailable ()

Gets whether this voice package language is supported by this TTS engine.

Class Details

Return information about downloaded voice packages. Used in VoiceCatalog.

Method Details

public String getBCP47Code ()

Get the international BCP-47 code describing the language of the voice skin (see http://tools.ietf.org/rfc/bcp/bcp47.txt).

Returns:

The BCP-47 code, e.g. "en".

public float getContentSize ()

Size of the package after unzipping to the device

Returns:

float, number of megabytes

public Hashtable getCustomAttributes ()

Gets the custom attributes from the Voice package.

Returns:

a hashtable containing key values pairs representing the Attributes

public float getDownloadSize ()

Size of the download required for this package

Returns:

float, number of megabytes

public Gender getGender ()

Gets the gender of the voice skin.

Note: if the voice package is a TTS package, then the gender is only a suggestion. The current Android TTS engine does not support switching voice genders. Clients that use third-party engines that support genders may use this API as a suggestion.

Returns:

The VoicePackage.Gender of the voice skin.

public long getId ()

Get the package identifier.

Returns:

Package identifier.

public String getLocalizedGender ()

Gets the localized description of the gender for this voice skin.

Note: if the voice package is a TTS package, then the gender is only a suggestion. The current Android TTS engine does not support switching voice genders. Clients that use third-party engines that support genders may use this API as a suggestion.

Returns:

A localized String representing the gender of the voice skin.

public String getLocalizedLanguage ()

Get the localized description of the language of this voice skin.

Returns:

A localized String representing the language of this voice skin.

public String getLocalizedQuality ()

Get the localized description of the voice skin quality

Returns:

localized description of the voice skin quality, this field can be empty if no quality information is available.

public String getLocalizedType ()

Get the localized description for the type of voice package.

Returns:

A localized String representing the type of the voice package.

public String getMarcCode ()

Get the international MARC code describing the language of the voice skin (see http://www.loc.gov/marc/languages).

Returns:

The MARC code, e.g. "eng".

public String getName ()

Get the package name.

Returns:

Package name.

public String getQuality ()

Get the text description of the voice skin quality

Returns:

text description of the voice skin quality, this field can be empty if no quality information is available.

public TravelMode getTravelMode ()

Get the VoicePackage.TravelMode of voice package.

Returns:

The VoicePackage.TravelMode of voice package.

public String getVersion ()

Get the package version.

Returns:

Package version.

public boolean isLocal ()

Check if the voice is locally installed.

Returns:

True if locally installed. False otherwise.

public boolean isTts ()

Get voice TextToSpeech capability.

Returns:

True if the voice is TTS capable.

public boolean isTtsLanguageAvailable ()

Gets whether this voice package language is supported by this TTS engine.

Returns:

true if the currently installed TextToSpeech engine supports the language of this voice package, false otherwise.

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.