How to configure Read Aloud

This article demonstrates how to configure the various options for Read Aloud in your Immersive Reader application.

Automatically start Read Aloud

The options parameter contains all of the flags that can be used to configure Read Aloud. Set autoplay to true to enable automatically starting Read Aloud after launching the Immersive Reader.

const options = {
    readAloudOptions: {
        autoplay: true
    }
};

ImmersiveReader.launchAsync(YOUR_TOKEN, YOUR_SUBDOMAIN, YOUR_DATA, options);

Note

Due to browser limitations, automatic playback is not supported in Safari.

Configure the voice

Set voice to either male or female. Not all languages support both voices. For more information, see Language support.

const options = {
    readAloudOptions: {
        voice: 'female'
    }
};

Configure playback speed

Set speed to a number between 0.5 (50%) and 2.5 (250%) inclusive. Values outside this range get clamped to either 0.5 or 2.5.

const options = {
    readAloudOptions: {
        speed: 1.5
    }
};

Next step

Explore the Immersive Reader SDK reference