TrayConfig

class TrayConfig

Data class holding all configuration for the Spokestack Tray.

Types

Builder

data class Builder(orientation: TrayConfig.Orientation, haptic: Boolean, sayGreeting: Boolean, greeting: String, ttsMode: SynthesisRequest.Mode, voice: String, clientId: String?, clientSecret: String?, properties: HashMap<String, Any>, logLevel: Int, wakewordModelURL: String?, nluURL: String?, rasaOssURL: String?, refreshModels: Boolean, editTranscript: (String) -> String?, listener: SpokestackTrayListener?, transcriptEditor: TranscriptEditor?)

A fluent builder interface for creating a tray configuration.

Orientation

enum Orientation : Enum<TrayConfig.Orientation>

A simple enum representing the tray's affinity for a certain side of the screen.

Properties

clientId

val clientId: String

Client ID from your Spokestack account.

clientSecret

val clientSecret: String

Secret key from your Spokestack account.

greeting

val greeting: String

A message to display and/or read via TTS synthesis when the tray opens for the first time.

haptic

val haptic: Boolean

A flag determining whether haptic feedback is sent when the tray opens.

listener

val listener: SpokestackTrayListener?

A listener that will receive events from Spokestack Tray.

logLevel

val logLevel: Int

Level of Spokestack log messages that will be produced and passed to registered listeners.

nluURL

val nluURL: String?

The URL to the directory containing your NLU files.

orientation

val orientation: TrayConfig.Orientation

Determines the initial placement of the microphone button and the opening direction of the tray.

properties

val properties: Map<String, Any>

Configuration properties forwarded to the Spokestack builder.

rasaOssURL

val rasaOssURL: String?

The URL to the Rasa Open Source server.

refreshModels

val refreshModels: Boolean

Whether wakeword and NLU models should be forcibly (re-)downloaded on launch.

sayGreeting

val sayGreeting: Boolean

A flag determining whether the initial greeting message, if set, should be read allowed (it will always be displayed in the message stream).

spokestackBuilder

val spokestackBuilder: Spokestack.Builder

A preconfigured Spokestack builder instance for use with the tray.

transcriptEditor

val transcriptEditor: TranscriptEditor?

Used to edit the transcript before classification and displaying to the user.

ttsMode

val ttsMode: SynthesisRequest.Mode

Synthesis mode for TTS.

voice

val voice: String

Voice to use for TTS synthesis.

wakewordModelURL

val wakewordModelURL: String?

The URL to the directory containing your wakeword models.