SpeechMgr (CPIK Libraries)

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

+(void)setLanguageAndVoice:(NSLocale*)

// 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]];

List<Locale> getLanguages()

+(NSArray) getLanguages

// 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];

Locale getCurrentLanguage()

+(NSLocale*) getCurrentLanguage

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

NSLocale * locale = [SpeechMgr getCurrentLanguage];

VoiceInfo getCurrentVoice()

+(SpeechVoiceInfo*) getCurrentVoice

// 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];

LanguageInfo getLanguageInfo(java.util.Locale)

+(SpeechLanguageInfo*) getLanguageInfo:(NSLocale*)

// 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]];

void playSpeechSample(int delay)

+(void) playSpeechSample:(int)

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

[SpeechMgr playSpeechSample:1];

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

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

// 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];

void cancelVoiceMessage()

+(void) cancelVoiceMessage

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

[SpeechMgr cancelVoiceMessage];

void setVolume(double gain)

+(void)setVolume:(double)

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

[SpeechMgr setVolume:.5];

getVolume()

+(double) getVolume

// 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]]);

boolean isMuted()

+(bool) isMuted

// 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"]);

void setMuteState(boolean)

+(void) setMuteState:(bool)

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

[SpeechMgr setMuteState:true];

void setAudioStream(AudioStream)

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

Void setSpeechRate:(double)

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

VoiceDownloadResult downloadVoice(VoiceInfo voiceInfo)

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

// 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
      }
    }
  }
}