HERE iOS SDK Developer's Guide

NMAVoiceCatalog

Class Summary

class NMAVoiceCatalog

Derived from: NSObject

Used to manage voice packages for guided navigation.

Include: NMAKit.framework/headers/NMAVoiceCatalog.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAVoiceCatalog

[For complete information, see the section Class Details]

See also:

NMAVoiceCatalogDelegate

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] BOOL  busy

YES if the voice catalog is currently busy, NO otherwise

[readable, writable, weak] id< NMAVoiceCatalogDelegate delegate

[readable, strong] NSArray *  installedVoicePackages

Array of installed NMAVoicePackage objects currently on the device

[readable, strong] NSDate *  lastUpdate

The date when the NMAVoiceCatalog was last updated

[readable, strong] NSArray *  voicePackages

Array of NMAVoicePackage objects, representing the catalog of NMAVoicePackage objects available from the server.

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(void) cancel

Cancels the current voice catalog update or voice package installation.

-(BOOL) installVoicePackage:( NMAVoicePackage *) package

Downloads and installs a NMAVoicePackage to the device.

-(BOOL) uninstallVoicePackage:( NMAVoicePackage *) package

Delete a particular NMAVoicePackage from the device

-(BOOL) updateVoiceCatalog

Update the voice catalog by downloading data from the server.

-( NMAVoicePackage *) voicePackageWithId:(NSUInteger) packageId

Class Method Summary

Table 3. Class Methods
Class Methods

+( NMAVoiceCatalog *) sharedVoiceCatalog

Returns the NMAVoiceCatalog singleton instance

Class Details

Used to manage voice packages for guided navigation.

The voice catalog can be used to manage or access the voice packages currently installed on the device. It can also be used to install new voice packages.

This class returns nil if access to this operation is denied. Contact your HERE representative for more information.

See also:

NMAVoiceCatalogDelegate

Public Property Details

[readable, assign] BOOL busy

YES if the voice catalog is currently busy, NO otherwise.

Note:

The voice catalog can only perform one operation at a time.

[readable, writable, weak] id< NMAVoiceCatalogDelegatedelegate

The voice catalog delegate

[readable, strong] NSArray * installedVoicePackages

Array of installed NMAVoicePackage objects currently on the device.

Note:

There will be one voice packages installed by default, which is English US.

[readable, strong] NSDate * lastUpdate

The date when the NMAVoiceCatalog was last updated.

nil if the voice catalog has not been downloaded yet

[readable, strong] NSArray * voicePackages

Array of NMAVoicePackage objects, representing the catalog of NMAVoicePackage objects available from the server.

The catalog may be updated by calling updateVoiceCatalog

Note:

If the voice catalog has not been downloaded yet this property will only contain the default pre-installed packages (see installedVoicePackages)

Instance Method Details

-(void) cancel

Cancels the current voice catalog update or voice package installation.

If there are no outstanding requests this method does nothing.

If there is an outstanding request then the request will be completed (delegate method called) with an error code of NMAVoiceCatalogErrorCancelled

-(BOOL) installVoicePackage:( NMAVoicePackage *) package

Downloads and installs a NMAVoicePackage to the device.

Uninstalls the voice package if already installed before downloading the updated version.

Parameters:

  • package

    Package to be downloaded/updated

Returns:

YES if the request was successfully issued (see [ NMAVoiceCatalogDelegate voiceCatalog:didInstallPackage:withError:] for the result of the update). NO if the request failed to be issued (no NMAVoiceCatalogDelegate methods will be called)

-(BOOL) uninstallVoicePackage:( NMAVoicePackage *) package

Delete a particular NMAVoicePackage from the device.

Parameters:

  • package

    Package to be uninstalled.

Returns:

NO if not installed or if the package is non-removable

-(BOOL) updateVoiceCatalog

Update the voice catalog by downloading data from the server.

On a successful update the voicePackages, installedVoicePackages and lastUpdate properties will be modified.

Returns:

YES if the request was successfully issued (see [ NMAVoiceCatalogDelegate voiceCatalog:didUpdateWithError:] for the result of the update). NO if the request failed to be issued (no NMAVoiceCatalogDelegate methods will be called)

-( NMAVoicePackage *) voicePackageWithId:(NSUInteger) packageId

Get a voice package instance

Parameters:

  • packageId

    the identifier of the package

Returns:

NMAVoicePackage instance if found, nil otherwise

Class Method Details

+( NMAVoiceCatalog *) sharedVoiceCatalog

Returns the NMAVoiceCatalog singleton instance.

Note:

Use this method to obtain a NMAVoiceCatalog instance. Do not call init directly.

Returns:

shared NMAVoiceCatalog instance

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.