Documentation

Powered by Algolia

Customization

You can customize Alan Button to fit your app's needs and color scheme. All options are available from the Embed Code screen in your project. You can access Embed Code screen by clicking on this button:

Alan Button options:

  1. Alan Button global visibility
  2. "Speech to text" panel visibility
  3. Screenshots (iOS/Android)
  4. Keep session active while app is in the background (iOS/Android)
  5. Visual style
  6. Wakeword (iOS/Android)
  7. Audio recording
  8. Microphone timeout

You can have different settings for each environment in your project (Development/Testing/Production) and platform/SDK (Web/iOS/Android).

Alan Button global visibility

Default on/visible
Platforms Web/iOS/Android

This option will enable/disable Alan Button for users of your app.

"Speech To Text" panel visibility

Default on/visible
Platforms Web/iOS/Android

This option will enable/disable the "Speech To Text" panel for users of your app. This panel is active when the user is giving voice commands to the app, showing the recognized input, and helps with visual feedback.

Screenshots

Default off
Platforms iOS/Android

This option will allow you to take screenshots of the app with every voice command of your users. Screenshots will be available in the project logs. Such screenshots are a great way to debug user flows and adjust your voice script accordingly. We've taken extra security measures to ensure that all screenshots are protected and available only to you as the project owner.

Keep session active while app is in the background

Default off
Platforms iOS/Android

This option (if enabled) will keep the voice session active even when the user puts the app into the background mode. So the user will be able to continue the conversation with Alan even while actively using other apps.

Visual style

Default blue
Platforms Web/iOS/Android

By default, the Alan Button is blue, but if the default color doesn't fit the color scheme of your site or app - you can easily change it in Alan Studio.

In the "Button Style" choose the needed colors for each of Alan Button's states.

The Alan Button has four states:

  • Idle: the default state of the Alan Button
  • Listening: this state is applied when Alan waits for the user's speech
  • Processing: this state is applied when Alan is analyzing the user's input
  • Speaking Back: this state is applied when Alan speaks back to the user

Wakeword

Default off
Platforms iOS/Android

This option will allow your users to activate Alan Button and voice session without touching the screen of their mobile devices. All that he needs to do is say "Hey, Alan" or "OK, Alan".

Audio recording

Default off
Platforms Web/iOS/Android

This option will allow you to record every voice command of your users. Audio recordings will be available in the project logs. Such recordings are a great way to debug user flows and adjust your voice script accordingly. We've taken extra security measures to ensure that all recordings are protected and available only to you as the project owner.

Microphone timeout

Default 10s
Platforms Web/iOS/Android

This option will allow you to control the period of inactivity after which Alan Button will be automatically deactivated. It is needed to save on battery/traffic and to avoid unwanted commands. Also, such functionality pairs great with Wakeword activation.