SpeechMgr

SpeechMgr¶

Methods

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

SpeechMgr.setLanguageAndVoice¶

Syntax

void setLanguageAndVoice(java.util.Locale, java.lang.String)

+(void)setLanguageAndVoice:(NSLocale*)

Parameters

locale - The Locale for which to set CoPilot.

voiceName - The voice name for which to set CoPilot.

Return Value

void

Sample Code

// Set CoPilot's language to English and the voice to John
String strVoicePerson = "John";
SpeechMgr.setLanguageAndVoice(Locale.ENGLISH, "John", strVoicePerson);
System.out.println("Completed.");

NSArray* languages = [SpeechMgr getLanguages];
NSLocale* locale = (NSLocale*) languages[0];
LanguageInfo* info = [SpeechMgr getLanguageInfo:locale];
VoiceInfo* voice = (SpeechVoiceInfo*) [info voices][0];
[SpeechMgr setLanguageAndVoice:locale withVoice:[voice voiceName]];

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

SpeechMgr.getLanguages¶

Syntax

List<Locale> getLanguages()

+(NSArray) getLanguages

Parameters

None.

Return Value

List; A list of all java Locales supported by CoPilot

Sample Code

// Get a list of all languages supported by CoPilot
List<Locale> supportedLanguages = SpeechMgr.getLanguages();
System.out.println("Supporting languages are as follow");
for (Locale locale : supportedLanguages) {
  System.out.println(locale.getDefault().toString());
}

NSArray * ret = [SpeechMgr getLanguages];

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

SpeechMgr.getCurrentLanguage¶

Syntax

Locale getCurrentLanguage()

+(NSLocale*) getCurrentLanguage

Return Value

Locale - a Java locale object

Sample Code

// Get CoPilot's current language
Locale currentLanguage = SpeechMgr.getCurrentLanguage();
System.out.println(currentLanguage.getDefault().toString());

NSLocale * locale = [SpeechMgr getCurrentLanguage];

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

Related APIs

• SpeechMgr.setLanguageAndVoice()
• SpeechMgr.getLanguages()
• SpeechMgr.getCurrentVoice()
• SpeechMgr.getLanguageInfo()

SpeechMgr.getCurrentVoice¶

Syntax

VoiceInfo getCurrentVoice()

+(SpeechVoiceInfo*) getCurrentVoice

Return Value

VoiceInfo; contains various info about a CoPilot-supported voice

Sample Code

// Get CoPilot's current voice
VoiceInfo currentVoice = SpeechMgr.getCurrentVoice();
System.out.println("Voice Name " + currentVoice.getVoiceName());
System.out.println("Voice storage: " + currentVoice.getVoiceStorage());
System.out.println("Voice : " + (currentVoice.getIsTTSVoice() ? "TTS": " not TTS"));
//to print all information in one shot
System.out.println("Voice info: " + currentVoice.toString());

[SpeechMgr getCurrentVoice];

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

Related APIs

• SpeechMgr.setLanguageAndVoice()
• SpeechMgr.getLanguages()
• SpeechMgr.getCurrentLanguage()
• SpeechMgr.getLanguageInfo()

SpeechMgr.getLanguageInfo¶

Syntax

LanguageInfo getLanguageInfo(java.util.Locale)

+(SpeechLanguageInfo*) getLanguageInfo:(NSLocale*)

Parameters

locale-- a locale object of the language query.

Return Value

LanguageInfo; contains info about a CoPilot language

Sample Code

// Get information about the CoPilot language for the US English Locale
Locale enUsLocale = new Locale("en_US");
LanguageInfo enUsLanguageInfo = SpeechMgr.getLanguageInfo(enUsLocale);

LanguageInfo * info = [SpeechMgr getLanguageInfo:[SpeechMgr getCurrentLanguage]];

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

Related APIs

• SpeechMgr.setLanguageAndVoice()
• SpeechMgr.getLanguages()
• SpeechMgr.getCurrentLanguage()
• SpeechMgr.getCurrentVoice()

LanguageInfo¶

Methods

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

VoiceInfo¶

Methods

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

VoiceStorage¶

Values

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

SpeechMgr.playSpeechSample¶

Syntax

void playSpeechSample(int delay)

+(void) playSpeechSample:(int)

Parameters

delay - The delay in milliseconds to wait before playing the sample

Sample Code

int milliSecDelay = 1000;
// Play a speech sample after 1 second
SpeechMgr.playSpeechSample(milliSecDelay);
System.out.println("Speech will play after " + milliSecDelay);

[SpeechMgr playSpeechSample:1];

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

SpeechMgr.playTTSMessage¶

Syntax

void playTTSMessage(java.lang.String, int, boolean, boolean)

+(void) playTTSMessage:(NSString*) (int) (bool) (bool)

Parameters

message - The message to be played via the TTS player.

delay - The amount of time, in milliseconds, to wait before playing the message.

currMsgOverride - If true, the current message will stop, and this message will play.

muteOverride - If true, this message will play regardless of whether or not CoPilot is in a muted state.

Sample Code

// Play a test TTS message after 1 second
// Overriding the current message
// But not overriding the mute state
String messageStr = "Hello. Test message";
int milliSecDelay = 1000;
boolean currMsgOverride = true;
boolean muteOverride = false;
SpeechMgr.playTTSMessage(messageStr, milliSecDelay, currMsgOverride, muteOverride);

[SpeechMgr playTTSMessage:@"Welcome To Copilot" withDelay:0 currMessageOverride:true muteOverride:true];

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

SpeechMgr.cancelVoiceMessage¶

Syntax

void cancelVoiceMessage()

+(void) cancelVoiceMessage

Sample Code

// Cancel the currently playing voice message
SpeechMgr.cancelVoiceMessage();
System.out.println("Voice Message is canceled.");

[SpeechMgr cancelVoiceMessage];

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

SpeechMgr.setVolume¶

Syntax

void setVolume(double gain)

+(void)setVolume:(double)

Parameters

gain - The percentage of the maximum volume to be set to. (0 to 1).

Sample Code

double gain = .50;
// Set CoPilot's volume to 50%
SpeechMgr.setVolume(gain);
System.out.println("Volume is increased by " + gain * 100 + "%");

[SpeechMgr setVolume:.5];

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

SpeechMgr.getVolume¶

Syntax

getVolume()

+(double) getVolume

Return Value

Returns the current volume, given as a percentage of the CoPilot Media Stream's maximum volume (0 to 1).

If CoPilot has not been started, returns -1.

Sample Code

// Print CoPilot's current volume level
double volumeLevel = SpeechMgr.getVolume();
System.out.println("Current volume level: " +
String.valueOf(volumeLevel));

NSLog([NSString stringWithFormat:@"Current Volume: %f", [SpeechMgr getVolume]]);

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

Related APIs

SpeechMgr.setVolume() SpeechMgr.isMuted() SpeechMgr.setMuteState()

SpeechMgr.isMuted¶

Syntax

boolean isMuted()

+(bool) isMuted

Return Value

Boolean representing whether or not CoPilot is muted.

Sample Code

// Print whether or not CoPilot is muted
boolean isCopilotMuted = SpeechMgr.isMuted();
if (isCopilotMuted)
  System.out.println("CoPilot is muted");
else
  System.out.println("CoPilot is NOT muted");

NSLog([NSString stringWithFormat:@"Is Muted: %@", ([SpeechMgr isMuted]) ? @"Muted" : @"Not Muted"]);

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

Related APIs

SpeechMgr.setVolume() SpeechMgr.getVolume() SpeechMgr.setMuteState()

SpeechMgr.setMuteState¶

Syntax

void setMuteState(boolean)

+(void) setMuteState:(bool)

Parameters

bMute - Whether or not to mute CoPilot.

Sample Code

// Mute CoPilot
SpeechMgr.setMuteState(true);
// Un-Mute CoPilot
SpeechMgr.setMuteState(false);

[SpeechMgr setMuteState:true];

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

Related APIs

SpeechMgr.setVolume() SpeechMgr.getVolume() SpeechMgr.isMuted()

SpeechMgr.setAudioStream¶

Syntax

void setAudioStream(AudioStream)

Parameters

audioStream – Enum value for the new stream.

Sample Code

// Set CoPilot to music playback stream
SpeechMgr.setAudioStream(STREAM\_MUSIC);
System.out.println("AudioStream is set to STREAM_MUSIC");

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

SpeechMgr.setSpeechRate¶

Syntax

Void setSpeechRate:(double)

Parameters

Double - The speech rate multiplier desired

Sample Code

// Set iOS TTS engines speech rate
[SpeechMgr setSpeechRate:.5];

SpeechMgr.downloadVoice¶

Syntax

VoiceDownloadResult downloadVoice(VoiceInfo voiceInfo)

+(enum VoiceDownloadResult)downloadVoice:(VoiceInfo*)voiceInfo

Parameters

VoiceInfo – The voice to download.

Return Value

VoiceDownloadResult – The result of the voice download request.

Sample Code

// Download any available voice that hasn't yet been downloaded
// Generate a list of all voices that need to be downloaded
List<Locale> supportedLanguages = SpeechMgr.getLanguages();
ArrayList<LanguageInfo> languageInfoList = new
ArrayList<LanguageInfo>();
for (Locale loc : supportedLanguages)
  languageInfoList.add(SpeechMgr.getLanguageInfo(loc));
ArrayList<VoiceInfo> voicesNeedingDownload = new ArrayList<VoiceInfo>();
for (LanguageInfo langInfo : languageInfoList){
  for (VoiceInfo voiceInfo : langInfo.getVoices())  {
    // If the voice storage is NEED_DOWNLOADING, we want to add it to the list
    if (voiceInfo.getVoiceStorage() == VoiceInfo.VoiceStorage.NEED_DOWNLOADING)
      voicesNeedingDownload.add(voiceInfo);
  }
}
// For each voice that needs downloading
for (VoiceInfo vi : voicesNeedingDownload){
  // Download the voice
  SpeechMgr.VoiceDownloadResult dlResult = SpeechMgr.downloadVoice(voiceNeedingDownload);
}

NSArray* languages = [SpeechMgr getLanguages];
for (id langElement in languages)
{
  LanguageInfo* info = [SpeechMgr getLanguageInfo:langElement ];
  for (id voiceElement in info.voices)
  {
    VoiceInfo* voice = voiceElement;
    if (!voice.isTTSVoice)
    {
    if (voice.voiceStorage == NOT_DOWNLOADED)
      {
        VoiceDownloadResult result = [SpeechMgr downloadVoice:voice]; // Should return VOICE_DOWNLOAD_QUEUED_SUCCESSFULLY
      }
    }
  }
}

Related APIs

SpeechMgr.VoiceDownloadStatus SpeechMgr.VoiceDownloadResult

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

VoiceDownloadStatus¶

Values

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

VoiceDownloadResult¶

Values

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

SoundType¶

Values

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.

AudioStream¶

Values

Hooks and Callbacks

Hooks and Callbacks related to Speech can be found below. For further details on these Hooks or Callbacks please refer to the Hooks and Callbacks section of this document.