HERE iOS SDK Developer's Guide

NMAVoicePackage

Class Summary

class NMAVoicePackage

Derived from: NSObject

Return information about voice packages.

Include: NMAKit.framework/headers/NMAVoicePackage.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAVoicePackage

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NSDictionary< NSString *, NSString * > *  customAttributes

The custom attributes of this voice package, nil if not available

[readable, assign] float  downloadSize

[readable, assign] NMAVoiceGender   gender

Gender of the voice package

[readable, assign] float  installationSize

[readable, assign] BOOL  installed

Check if the voice package is installed

[readable, assign] NSString *  language

Language of the installed voice package in English, nil if the voice package is not installed

[readable, assign] NSString *  languageCode

The BCP-47 language code representing the language of the package, nil if voice package is not available or BCP-47 language tag could not be found

[readable, assign] NSString *  localizedGender

The localized description of the gender for this voice package, nil if it is not available

[readable, assign] NSString *  localizedLanguage

Language of the voice package localized to the package locale, nil if it is not available

[readable, assign] NSString *  localizedQuality

The localized description of the quality for this voice package, nil if it is not available

[readable, assign] NSString *  localizedType

The localized description of the type of this voice package, nil if it is not available

[readable, assign] NSString *  marcCode

The international MARC code describing the language of the voice package (see http://www

[readable, assign] NSString *  name

Name of the voice package localized to the package locale, nil if not available

[readable, assign] NSUInteger  packageId

Id of the voice package

[readable, assign] NSString *  quality

[readable, assign] BOOL  removable

Indicates whether the voice package can be uninstalled

[readable, assign] BOOL  tts

Check if the voice package is a Text-to-Speech voice package

[readable, assign] BOOL  ttsLanguageAvailable

Indicates whether this voice package is supported by AVSpeechSynthesizer

[readable, assign] BOOL  updateAvailable

Check if the voice package needs to be updated

[readable, assign] NSString *  version

The voice package version

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull instancetype) init

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull instancetype) new

Class Details

Return information about voice packages. Used in NMAVoiceCatalog.

Public Property Details

[readable, assign] NSDictionary< NSString *, NSString * > * customAttributes

The custom attributes of this voice package, nil if not available.

[readable, assign] float downloadSize

Size of the package after download to device, in number of megabytes

Returns -1 if the package is not available for download

[readable, assign] NMAVoiceGender  gender

Gender of the voice package.

[readable, assign] float installationSize

Size of the package after unzipping to device, in number of megabytes

[readable, assign] BOOL installed

Check if the voice package is installed. YES if installed; NO otherwise.

[readable, assign] NSString * language

Language of the installed voice package in English, nil if the voice package is not installed.

[readable, assign] NSString * languageCode

The BCP-47 language code representing the language of the package, nil if voice package is not available or BCP-47 language tag could not be found.

[readable, assign] NSString * localizedGender

The localized description of the gender for this voice package, nil if it is not available.

[readable, assign] NSString * localizedLanguage

Language of the voice package localized to the package locale, nil if it is not available.

[readable, assign] NSString * localizedQuality

The localized description of the quality for this voice package, nil if it is not available.

[readable, assign] NSString * localizedType

The localized description of the type of this voice package, nil if it is not available.

[readable, assign] NSString * marcCode

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

[readable, assign] NSString * name

Name of the voice package localized to the package locale, nil if not available.

[readable, assign] NSUInteger packageId

Id of the voice package.

[readable, assign] NSString * quality

Indicate the quality of the voice if it is available; nil if voice quality is not available

[readable, assign] BOOL removable

Indicates whether the voice package can be uninstalled. YES if can be uninstalled; NO otherwise

[readable, assign] BOOL tts

Check if the voice package is a Text-to-Speech voice package.

Note:

If this property returns YES you are advised to check whether to TTS language is supported on the current device. See ttsLanguageAvailable.

[readable, assign] BOOL ttsLanguageAvailable

Indicates whether this voice package is supported by AVSpeechSynthesizer.

AVSpeechSynthesizer support can differ between devices and iOS versions so, if this package is a TTS package, it is advisable to check this property before downloading the package.

[readable, assign] BOOL updateAvailable

Check if the voice package needs to be updated. YES if the installed voice package and the voice package from the server in the voice catalog have different versions; NO otherwise

[readable, assign] NSString * version

The voice package version.

Instance Method Details

-(nonnull instancetype) init

Instances of this class should not be initialized directly

Class Method Details

+(nonnull instancetype) new

Instances of this class should not be initialized directly