API: Read Text to Visitors

Allows you to prompt the device to read text strings out loud. Optional parameters allow you to define the desired language and region of the voice used, as well as voice quality, volume, pitch, rate and timing.

Requirements

• Integration of our JavaScript API into your webpage
• Sample code to run within the app and download for integration into your own project is available here.
• Best practices for working with the JavaScript API are available here.
• App Settings
  • Content > JavaScript API > Access JavaScript API = By Import

Triggers via API Functions

Read Text String

This function prompts the device to read the text string that has been passed.

kp_Speech_speak(textToSpeak, speechConfig);
		

Example

This function speaks "Hello world!" with a specific configuration:

function speak() {
    var speechConfig = '{\
        "rate": 0.5,\
        "pitchMultiplier": 1,\
        "volume": 1,\
        "preUtteranceDelay": 0,\
        "postUtteranceDelay": 0,\
        "voice": {\
            "languageCode": "en-US",\
        }\
    }';
    kp_Speech_speak('Hello world', speechConfig);
}

Pause Speaking

This function pauses any speech currently ongoing. The place at which the speech is paused is saved and speech can be resumed from that point by triggering kp_Speech_continue.

kp_Speech_pause();
		

Continue Speaking

This function continues speech that has been paused using kp_Speech_pause.

kp_Speech_continue();
		

Stop Speaking

This function immediately stops any speech currently ongoing. Speech ended using this function cannot be resumed, but instead would need to be restarted from the beginning using a new Read Text String command.

kp_Speech_stop();
		

Check Default Language Code

This function triggers a callback returning the default language code for the device. For example, "en-US".

kp_Speech_requestCurrentLanguageCode(callback);
		

callback(currentLanguageCode);
		

Check Language Code Options

This function triggers a callback containing a list of available language codes.

kp_Speech_requestListOfLanguageCodes(callback);
		

callback(langCodes);
		

Check Voice Library Options

This function triggers a callback returning a list of voice libraries available on the device. Additional voice libraries can be downloaded in iOS/iPadOS Settings under Accessibility > Spoken Content > Voices.

kp_Speech_requestListOfVoiceIdentifiers(callback);
		

callback(voiceIDs);
		

Notifications via API Callbacks

When Speech Starts

This callback is triggered when a speech successfully starts.

kp_Speech_didStartSpeechUtterance(speechString);
		

When Speech Completes

This callback is triggered when a speech successfully finishes.

kp_Speech_didFinishSpeechUtterance(speechString);
		

When Speech Pauses

This callback is triggered when a speech is paused.

kp_Speech_didPauseSpeechUtterance(speechString);
		

When Speech Continues

This callback is triggered when a paused speech is continued.

kp_Speech_didContinueSpeechUtterance(speechString);
		

When Speech Is Stopped

This callback is triggered when a speech is stopped.

kp_Speech_didCancelSpeechUtterance(speechString);