Documentation

Powered by Algolia

Customizing the Alan button

You can customize the Alan button to fit your application needs and color scheme. To access the Alan button options:

  1. In the Alan Studio, at the top of the code editor, click Embed Code.
  2. Click the Web, iOS or Android tab and use the options below to set up the necessary style and behavior of the Alan button.

You can do the following to customize the Alan button:

You can specify different settings for every environment in the project: Development, Testing or Production, and for each platform or SDK: web, iOS or Android.

Enabling or disabling the Alan button

Use this option to show or hide the Alan button for users of your application.

Default on/visible
Platforms Web/iOS/Android

Enabling or disabling the Speech To Text panel

Use this option to show or hide the 'Speech To Text' panel for users of your application. The 'Speech to Text' panel is active when the user gives voice commands to the application, showing the recognized input, and helps with visual feedback.

Default on/visible
Platforms Web/iOS/Android

Taking screenshots

Use this option to take screenshots of the application with every voice command given by users. Screenshots will be available in the project logs. Taking screenshots is a great way to debug user flows and adjust your voice script accordingly. We have taken extra security measures to ensure that all screenshots are protected and available only to you as the project owner.

Default off
Platforms iOS/Android

Keeping the session active

Use this option to keep the voice session active even when the user puts the application into the background mode. If this option is enabled, the user will be able to continue the conversation with Alan even while actively using other applications.

Default off
Platforms iOS/Android

Changing the button style

By default, the Alan button is blue. If the default color does not fit the color scheme of your site or application, you can easily change it. Click Change Button style and in the Button Style section, choose the needed colors for every Alan button state.

The Alan button has four states:

  • Idle: the default state of the Alan button
  • Listening: this state is applied when Alan waits for a user utterance
  • Processing: this state is applied when Alan is analyzing the user input
  • Speaking Back: this state is applied when Alan speaks back to the user
Default blue
Platforms Web/iOS/Android

Using the wake word

Use this option to allow users to activate the Alan button and a voice session without touching the screen of their mobile devices. All that the user needs to do is say the wake word: "Hey, Alan" or "OK, Alan".

Default off
Platforms iOS/Android

Recording audio

Use this option to record every voice command given by users. Audio recordings will be available in the project logs. Recording audio is a great way to debug user flows and adjust your voice script accordingly. We have taken extra security measures to ensure that all recordings are protected and available only to you as the project owner.

Default off
Platforms Web/iOS/Android

Setting the microphone timeout

Use this option to set the period after which the Alan button is automatically deactivated. This option helps users save on battery/traffic and avoid unwanted commands. Also, the microphone timeout functionality pairs great with using the wake word.

Default 10s
Platforms Web/iOS/Android