HERE Android SDK Developer's Guide

VoiceSkin

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

Class Summary

public final class VoiceSkin

extends java.lang.Object

Defines a voice skin used for guidance.

[For complete information, see the section Class Details]

Nested Class Summary

Table 1. Nested Classes in VoiceSkin
Nested Classes

public static final enumeration VoiceSkin.OutputType

Voice Skin Output Types

Method Summary

Table 2. Methods in VoiceSkin
Methods

public boolean delete ()

Delete the voice skin from the device

public String getDescription ()

Get the human readable description of the voice skin.

public String getGender ()

Gets the gender of the voice skin: "f" female, "m" male.

public long getId ()

Get the voice skin identifier.

public String getLanguage ()

Get the human readable language name of the voice skin.

public String getLanguageCode ()

Returns language code in BCP-47 format: language-COUNTRY

public String getMarcCode ()

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

public OutputType getOutputType ()

Get the voice skin output voice type.

public String getQuality ()

Get the text description of the voice skin quality

public String getSpeaker ()

Get the speaker of the voice skin.

public String getVersion ()

Get the version number string of the voice skin.

Class Details

Defines a voice skin used for guidance.

Method Details

public boolean delete ()

Delete the voice skin from the device

Returns:

true if deletion was successful, false otherwise

public String getDescription ()

Get the human readable description of the voice skin.

Returns:

The description, e.g. "English Female".

public String getGender ()

Gets the gender of the voice skin: "f" female, "m" male.

Note: if the voice skin is a TTS voice skin, 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:

"f" if female, "m" if male.

public long getId ()

Get the voice skin identifier.

Returns:

The voice skin identifier.

public String getLanguage ()

Get the human readable language name of the voice skin.

Returns:

The language name, e.g. "English".

public String getLanguageCode ()

Returns language code in BCP-47 format: language-COUNTRY

Returns:

language code in BCP-47 format

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 OutputType getOutputType ()

Get the voice skin output voice type.

Returns:

The voice skin output voice type.

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 String getSpeaker ()

Get the speaker of the voice skin.

Returns:

The name of the speaker.

public String getVersion ()

Get the version number string of the voice skin.

Returns:

The version number, e.g. "0.2.0.0".