SYVoiceCatalog Class Reference

Manager of voice packages for guided navigation and warnings. Can be used to install, uninstall or select current voice packages on the device. More...

#import <SYVoiceCatalog.h>

Inheritance diagram for SYVoiceCatalog:

Collaboration diagram for SYVoiceCatalog:

Instance Methods
((unavailable("Use +[SYVoiceCatalog sharedVoiceCatalog] instead.")	- __attribute__
	SYAudioManager is singleton, use [SYAudioManager sharedAudioManager] to access singleton instance. More...
(nullable SYTask *)	- getAvailableVoicePackagesWithCompletion:
	Requests collection of available SYVoicePackage. Collection includes installed voice packages and packages available to install from server. There no voice packages installed by default, you have to download them. There are just system supported TTS voices. More...
(nullable SYTask *)	- getInstalledPackagesWithCompletion:
	Gets collection of currently installed voice packages and system voices. More...
(nullable SYTask *)	- installVoicePackage:
	Downloads and installs a SYVoicePackage to the device. Requests installation of SYVoicePackage. More...
(nullable SYTask *)	- uninstallVoicePackage:
	Delete a particular SYVoicePackage from the device. Requests uninstallation of SYVoicePackage. More...
(void)	- setCurrentVoice:
	Sets voice used for voice guided navigation and warnings. More...
(void)	- playSample:
	Play sample of selected voice package. Adds sample to SYAudioManager play queue. To play sample immediately, stop SYAudioManager queue by calling [SYAudioManager stopOutputAndClearQueue]. More...

Class Methods
(nonnull SYVoiceCatalog *)	+ sharedVoiceCatalog
	Returns SYVoiceCatalog singleton instance. More...
((unavailable("Use +[SYVoiceCatalog sharedVoiceCatalog] instead.")	+ __attribute__

Properties
id< SYVoiceCatalogDelegate >	delegate
	Current SYVoiceCatalogDelegate. More...

Detailed Description

Manager of voice packages for guided navigation and warnings. Can be used to install, uninstall or select current voice packages on the device.

Method Documentation

sharedVoiceCatalog

+ (nonnull SYVoiceCatalog*) sharedVoiceCatalog

Returns SYVoiceCatalog singleton instance.

__attribute__ [1/2]

- ((unavailable("Use +[SYVoiceCatalog sharedVoiceCatalog] instead.") __attribute__

SYAudioManager is singleton, use [SYAudioManager sharedAudioManager] to access singleton instance.

__attribute__ [2/2]

+ ((unavailable("Use +[SYVoiceCatalog sharedVoiceCatalog] instead.") __attribute__

getAvailableVoicePackagesWithCompletion:

- (nullable SYTask*) getAvailableVoicePackagesWithCompletion:

(nonnull void(^)(SYTask *_Nonnull, NSArray< SYVoicePackage * > *_Nonnull))

completion

Requests collection of available SYVoicePackage. Collection includes installed voice packages and packages available to install from server. There no voice packages installed by default, you have to download them. There are just system supported TTS voices.

Parameters

completion

Completion block containing NSArray of available voice packages.

Returns

SYTask for requested operation.

getInstalledPackagesWithCompletion:

- (nullable SYTask*) getInstalledPackagesWithCompletion:

(nonnull void(^)(SYTask *_Nonnull, NSArray< SYVoicePackage * > *_Nonnull))

completion

Gets collection of currently installed voice packages and system voices.

Parameters

completion

Completion block containing NSArray of installed voice packages.

Returns

Array of currently installed voice packages and system voices.

installVoicePackage:

- (nullable SYTask*) installVoicePackage:

(nonnull SYVoicePackage *)

package

Downloads and installs a SYVoicePackage to the device. Requests installation of SYVoicePackage.

Parameters

package

Package to be installed.

Returns

SYTask for requested operation.

uninstallVoicePackage:

- (nullable SYTask*) uninstallVoicePackage:

(nonnull SYVoicePackage *)

package

Delete a particular SYVoicePackage from the device. Requests uninstallation of SYVoicePackage.

Parameters

package

Package to be uninstalled.

Returns

SYTask for requested operation.

setCurrentVoice:

- (void) setCurrentVoice:

(nonnull SYVoicePackage *)

voice

Sets voice used for voice guided navigation and warnings.

Parameters

voice

SYVoicePackage to be used.

playSample:

- (void) playSample:

(nonnull SYVoicePackage *)

voice

Play sample of selected voice package. Adds sample to SYAudioManager play queue. To play sample immediately, stop SYAudioManager queue by calling [SYAudioManager stopOutputAndClearQueue].

Parameters

voice

SYVoicePackage to be used.

Property Documentation

delegate

- (id<SYVoiceCatalogDelegate>) delegate

readwritenonatomicassign

Current SYVoiceCatalogDelegate.

---

The documentation for this class was generated from the following file:

• SYVoiceCatalog.h