SpokestackTray

class SpokestackTray(config: TrayConfig, state: TrayState) : Fragment, MotionLayout.TransitionListener, AutoCloseable

A Fragment that exposes the primary functionality of the Spokestack tray.

The tray wraps an instance of the Spokestack library that is used to capture user voice input, convert it to text, display that text, and classify it using an NLU. An application can register a component to listen to tray events, return responses to NLU classifications, and have those responses automatically synthesized via Spokestack TTS to be read to the user.

To include the tray in your Activity's layout.xml:

<!-- nested in the main layout, after other views/sublayouts -->

    <include
         android:id="@+id/tray_fragment"
         layout="@layout/spokestack_tray_fragment"
     />

Then in the Activity itself:

import io.spokestack.tray.*

class MyActivity : AppCompatActivity(), SpokestackTrayListener {

    lateinit var tray: SpokestackTray

    // ...

    override fun onCreate(savedInstanceState: Bundle?) {

        val config = TrayConfig.Builder()
            // credentials from your Spokestack account
            .credentials("spokestack-client-id", "spokestack-secret-key")
            .wakewordModelURL("https://path-to-wakeword-models")
            .nluURL("https://path-to-nlu-files")
            .withListener(this)
            // optional builder customization; see the documentation for more details...
            .build()
        supportFragmentManager.fragmentFactory = SpokestackTrayFactory(config)

        // note that the factory is instantiated and set on the manager BEFORE calling
        // `super.onCreate()`
        super.onCreate(savedInstanceState)
    }

    override fun onStart() {
        // set the value of the lateinit `tray` var
        tray = SpokestackTray.getInstance(config)
        super.onStart()
    }

Constructors

SpokestackTray

fun SpokestackTray(config: TrayConfig, state: TrayState)

Types

SpokestackListener

inner class SpokestackListener : SpokestackAdapter

Functions

audioEnabled

fun audioEnabled(): Boolean

callStartTransitionListener

open fun callStartTransitionListener()

clear

fun clear()

Clear the tray's internal conversation history, making the next time it opens act like the first without resetting any user modifications like muting TTS or changing the tray size.

close

open override fun close()

Release resources associated with the Tray and the underlying Spokestack instance.

dump

open fun dump(@NonNull() p0: String, @Nullable() p1: FileDescriptor?, @NonNull() p2: PrintWriter, @Nullable() p3: Array<String>?)

equals

operator override fun equals(@Nullable() other: Any?): Boolean

findFragmentByWho

open fun findFragmentByWho(@NonNull() p0: String): Fragment?

getActivity

fun getActivity(): FragmentActivity?

getAllowEnterTransitionOverlap

open fun getAllowEnterTransitionOverlap(): Boolean

getAllowReturnTransitionOverlap

open fun getAllowReturnTransitionOverlap(): Boolean

getAnimatingAway

open fun getAnimatingAway(): View

getAnimator

open fun getAnimator(): Animator

getArguments

fun getArguments(): Bundle?

getChildFragmentManager

fun getChildFragmentManager(): FragmentManager

getContext

open fun getContext(): Context?

getDefaultViewModelProviderFactory

open override fun getDefaultViewModelProviderFactory(): ViewModelProvider.Factory

getEnterTransition

open fun getEnterTransition(): Any?

getEnterTransitionCallback

open fun getEnterTransitionCallback(): SharedElementCallback

getExitTransition

open fun getExitTransition(): Any?

getExitTransitionCallback

open fun getExitTransitionCallback(): SharedElementCallback

getFragmentManager

fun getFragmentManager(): FragmentManager?

getHost

fun getHost(): Any?

getId

fun getId(): Int

getLayoutInflater

fun getLayoutInflater(): LayoutInflater

open fun getLayoutInflater(@Nullable() p0: Bundle?): LayoutInflater

getLifecycle

open override fun getLifecycle(): Lifecycle

getLoaderManager

open fun getLoaderManager(): LoaderManager

getNextAnim

open fun getNextAnim(): Int

getNextTransition

open fun getNextTransition(): Int

getParentFragment

fun getParentFragment(): Fragment?

getParentFragmentManager

fun getParentFragmentManager(): FragmentManager

getReenterTransition

open fun getReenterTransition(): Any?

getResources

fun getResources(): Resources

getRetainInstance

fun getRetainInstance(): Boolean

getReturnTransition

open fun getReturnTransition(): Any?

getSavedStateRegistry

override fun getSavedStateRegistry(): SavedStateRegistry

getSharedElementEnterTransition

open fun getSharedElementEnterTransition(): Any?

getSharedElementReturnTransition

open fun getSharedElementReturnTransition(): Any?

getState

fun getState(): TrayState

Get a copy of the tray's current internal state.

getStateAfterAnimating

open fun getStateAfterAnimating(): Int

getString

fun getString(@StringRes() p0: Int): String

fun getString(@StringRes() p0: Int, @Nullable() vararg p1: Any): String

getTag

fun getTag(): String?

getTargetFragment

fun getTargetFragment(): Fragment?

getTargetRequestCode

fun getTargetRequestCode(): Int

getText

fun getText(@StringRes() p0: Int): CharSequence

getUserVisibleHint

open fun getUserVisibleHint(): Boolean

getView

open fun getView(): View?

getViewLifecycleOwner

open fun getViewLifecycleOwner(): LifecycleOwner

getViewLifecycleOwnerLiveData

open fun getViewLifecycleOwnerLiveData(): LiveData<LifecycleOwner>

getViewModelStore

open override fun getViewModelStore(): ViewModelStore

hashCode

override fun hashCode(): Int

hasOptionsMenu

fun hasOptionsMenu(): Boolean

initState

open fun initState()

isAdded

fun isAdded(): Boolean

isDetached

fun isDetached(): Boolean

isHidden

fun isHidden(): Boolean

isHideReplaced

open fun isHideReplaced(): Boolean

isInBackStack

fun isInBackStack(): Boolean

isInLayout

fun isInLayout(): Boolean

isMenuVisible

fun isMenuVisible(): Boolean

isOpen

fun isOpen(): Boolean

isPostponed

open fun isPostponed(): Boolean

isRemoving

fun isRemoving(): Boolean

isRemovingParent

fun isRemovingParent(): Boolean

isResumed

fun isResumed(): Boolean

isStateSaved

fun isStateSaved(): Boolean

isVisible

fun isVisible(): Boolean

loadState

fun loadState(savedState: TrayState)

Load the tray's internal state from a saved version.

noteStateNotSaved

open fun noteStateNotSaved()

onActivityCreated

open fun onActivityCreated(@Nullable() p0: Bundle?)

onActivityResult

open fun onActivityResult(p0: Int, p1: Int, @Nullable() p2: Intent?)

onAttach

open fun onAttach(@NonNull() p0: Activity)

open fun onAttach(@NonNull() p0: Context)

onAttachFragment

open fun onAttachFragment(@NonNull() p0: Fragment)

onConfigurationChanged

open override fun onConfigurationChanged(@NonNull() p0: Configuration)

onContextItemSelected

open fun onContextItemSelected(@NonNull() p0: MenuItem): Boolean

onCreate

open override fun onCreate(savedInstanceState: Bundle?)

onCreateAnimation

open fun onCreateAnimation(p0: Int, p1: Boolean, p2: Int): Animation?

onCreateAnimator

open fun onCreateAnimator(p0: Int, p1: Boolean, p2: Int): Animator?

onCreateContextMenu

open override fun onCreateContextMenu(@NonNull() p0: ContextMenu, @NonNull() p1: View, @Nullable() p2: ContextMenu.ContextMenuInfo?)

onCreateOptionsMenu

open fun onCreateOptionsMenu(@NonNull() p0: Menu, @NonNull() p1: MenuInflater)

onCreateView

open override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View

onDestroy

open fun onDestroy()

onDestroyOptionsMenu

open fun onDestroyOptionsMenu()

onDestroyView

open override fun onDestroyView()

onDetach

open override fun onDetach()

onGetLayoutInflater

open fun onGetLayoutInflater(@Nullable() p0: Bundle?): LayoutInflater

onHiddenChanged

open fun onHiddenChanged(p0: Boolean)

onInflate

open fun onInflate(@NonNull() p0: Activity, @NonNull() p1: AttributeSet, @Nullable() p2: Bundle?)

open fun onInflate(@NonNull() p0: Context, @NonNull() p1: AttributeSet, @Nullable() p2: Bundle?)

onLowMemory

open override fun onLowMemory()

onMultiWindowModeChanged

open fun onMultiWindowModeChanged(p0: Boolean)

onOptionsItemSelected

open fun onOptionsItemSelected(@NonNull() p0: MenuItem): Boolean

onOptionsMenuClosed

open fun onOptionsMenuClosed(@NonNull() p0: Menu)

onPause

open override fun onPause()

onPictureInPictureModeChanged

open fun onPictureInPictureModeChanged(p0: Boolean)

onPrepareOptionsMenu

open fun onPrepareOptionsMenu(@NonNull() p0: Menu)

onPrimaryNavigationFragmentChanged

open fun onPrimaryNavigationFragmentChanged(p0: Boolean)

onRequestPermissionsResult

open override fun onRequestPermissionsResult(requestCode: Int, permissions: Array<out String>, grantResults: IntArray)

onResume

open override fun onResume()

onSaveInstanceState

open fun onSaveInstanceState(@NonNull() p0: Bundle)

onStart

open fun onStart()

onStop

open fun onStop()

onTransitionChange

open override fun onTransitionChange(p0: MotionLayout?, startId: Int, endId: Int, progress: Float)

onTransitionCompleted

open override fun onTransitionCompleted(layout: MotionLayout?, state: Int)

onTransitionStarted

open override fun onTransitionStarted(p0: MotionLayout?, startId: Int, endId: Int)

onTransitionTrigger

open override fun onTransitionTrigger(p0: MotionLayout?, trigger: Int, pos: Boolean, prog: Float)

onViewCreated

open fun onViewCreated(@NonNull() p0: View, @Nullable() p1: Bundle?)

onViewStateRestored

open fun onViewStateRestored(@Nullable() p0: Bundle?)

performActivityCreated

open fun performActivityCreated(p0: Bundle)

performAttach

open fun performAttach()

performConfigurationChanged

open fun performConfigurationChanged(@NonNull() p0: Configuration)

performContextItemSelected

open fun performContextItemSelected(@NonNull() p0: MenuItem): Boolean

performCreate

open fun performCreate(p0: Bundle)

performCreateOptionsMenu

open fun performCreateOptionsMenu(@NonNull() p0: Menu, @NonNull() p1: MenuInflater): Boolean

performCreateView

open fun performCreateView(@NonNull() p0: LayoutInflater, @Nullable() p1: ViewGroup?, @Nullable() p2: Bundle?)

performDestroy

open fun performDestroy()

performDestroyView

open fun performDestroyView()

performDetach

open fun performDetach()

performGetLayoutInflater

open fun performGetLayoutInflater(@Nullable() p0: Bundle?): LayoutInflater

performLowMemory

open fun performLowMemory()

performMultiWindowModeChanged

open fun performMultiWindowModeChanged(p0: Boolean)

performOptionsItemSelected

open fun performOptionsItemSelected(@NonNull() p0: MenuItem): Boolean

performOptionsMenuClosed

open fun performOptionsMenuClosed(@NonNull() p0: Menu)

performPause

open fun performPause()

performPictureInPictureModeChanged

open fun performPictureInPictureModeChanged(p0: Boolean)

performPrepareOptionsMenu

open fun performPrepareOptionsMenu(@NonNull() p0: Menu): Boolean

performPrimaryNavigationFragmentChanged

open fun performPrimaryNavigationFragmentChanged()

performResume

open fun performResume()

performSaveInstanceState

open fun performSaveInstanceState(p0: Bundle)

performStart

open fun performStart()

performStop

open fun performStop()

postponeEnterTransition

open fun postponeEnterTransition()

fun postponeEnterTransition(p0: Long, @NonNull() p1: TimeUnit)

registerForContextMenu

open fun registerForContextMenu(@NonNull() p0: View)

requestPermissions

fun requestPermissions(@NonNull() p0: Array<String>, p1: Int)

requireActivity

fun requireActivity(): FragmentActivity

requireArguments

fun requireArguments(): Bundle

requireContext

fun requireContext(): Context

requireFragmentManager

fun requireFragmentManager(): FragmentManager

requireHost

fun requireHost(): Any

requireParentFragment

fun requireParentFragment(): Fragment

requireView

fun requireView(): View

restoreChildFragmentState

open fun restoreChildFragmentState(@Nullable() p0: Bundle?)

restoreViewState

fun restoreViewState(p0: Bundle)

say

fun say(prompt: Prompt)

Submits text to the tray to be synthesized.

setAllowEnterTransitionOverlap

open fun setAllowEnterTransitionOverlap(p0: Boolean)

setAllowReturnTransitionOverlap

open fun setAllowReturnTransitionOverlap(p0: Boolean)

setAnimatingAway

open fun setAnimatingAway(p0: View)

setAnimator

open fun setAnimator(p0: Animator)

setArguments

open fun setArguments(@Nullable() p0: Bundle?)

setEnterSharedElementCallback

open fun setEnterSharedElementCallback(@Nullable() p0: SharedElementCallback?)

setEnterTransition

open fun setEnterTransition(@Nullable() p0: Any?)

setExitSharedElementCallback

open fun setExitSharedElementCallback(@Nullable() p0: SharedElementCallback?)

setExitTransition

open fun setExitTransition(@Nullable() p0: Any?)

setHasOptionsMenu

open fun setHasOptionsMenu(p0: Boolean)

setHideReplaced

open fun setHideReplaced(p0: Boolean)

setInitialSavedState

open fun setInitialSavedState(@Nullable() p0: Fragment.SavedState?)

setMenuVisibility

open fun setMenuVisibility(p0: Boolean)

setNextAnim

open fun setNextAnim(p0: Int)

setNextTransition

open fun setNextTransition(p0: Int)

setOnStartEnterTransitionListener

open fun setOnStartEnterTransitionListener(p0: Fragment.OnStartEnterTransitionListener)

setOpen

fun setOpen(open: Boolean, listen: Boolean = open)

Opens or closes the tray UI, optionally listening on open.

setReenterTransition

open fun setReenterTransition(@Nullable() p0: Any?)

setRetainInstance

open fun setRetainInstance(p0: Boolean)

setReturnTransition

open fun setReturnTransition(@Nullable() p0: Any?)

setSharedElementEnterTransition

open fun setSharedElementEnterTransition(@Nullable() p0: Any?)

setSharedElementReturnTransition

open fun setSharedElementReturnTransition(@Nullable() p0: Any?)

setStateAfterAnimating

open fun setStateAfterAnimating(p0: Int)

setTargetFragment

open fun setTargetFragment(@Nullable() p0: Fragment?, p1: Int)

setUserVisibleHint

open fun setUserVisibleHint(p0: Boolean)

shouldShowRequestPermissionRationale

open fun shouldShowRequestPermissionRationale(@NonNull() p0: String): Boolean

spokestack

fun spokestack(): Spokestack

start

fun start()

Explicitly start the underlying Spokestack instance and its speech pipeline.

startActivity

open fun startActivity(p0: Intent)

open fun startActivity(p0: Intent, @Nullable() p1: Bundle?)

startActivityForResult

open fun startActivityForResult(p0: Intent, p1: Int)

open fun startActivityForResult(p0: Intent, p1: Int, @Nullable() p2: Bundle?)

startIntentSenderForResult

open fun startIntentSenderForResult(p0: IntentSender, p1: Int, @Nullable() p2: Intent?, p3: Int, p4: Int, p5: Int, @Nullable() p6: Bundle?)

startPostponedEnterTransition

open fun startPostponedEnterTransition()

stop

fun stop()

Release resources associated with the Tray and the underlying Spokestack instance.

toString

open override fun toString(): String

unregisterForContextMenu

open fun unregisterForContextMenu(@NonNull() p0: View)

Properties

listener

var listener: SpokestackTrayListener?

mAdded

val mAdded: Boolean

mAnimationInfo

val mAnimationInfo: Fragment.AnimationInfo

mArguments

val mArguments: Bundle

mBackStackNesting

val mBackStackNesting: Int

mChildFragmentManager

val mChildFragmentManager: FragmentManager

mContainer

val mContainer: ViewGroup

mContainerId

val mContainerId: Int

mDeferStart

val mDeferStart: Boolean

mDetached

val mDetached: Boolean

mFragmentId

val mFragmentId: Int

mFragmentManager

val mFragmentManager: FragmentManager

mFromLayout

val mFromLayout: Boolean

mHasMenu

val mHasMenu: Boolean

mHidden

val mHidden: Boolean

mHiddenChanged

val mHiddenChanged: Boolean

mHost

val mHost: FragmentHostCallback<*>

mInLayout

val mInLayout: Boolean

mIsCreated

val mIsCreated: Boolean

mIsNewlyAdded

val mIsNewlyAdded: Boolean

mLayoutInflater

val mLayoutInflater: LayoutInflater

mLifecycleRegistry

val mLifecycleRegistry: LifecycleRegistry

mMaxState

val mMaxState: Lifecycle.State

mMenuVisible

val mMenuVisible: Boolean

mParentFragment

val mParentFragment: Fragment

mPerformedCreateView

val mPerformedCreateView: Boolean

mPostponedAlpha

val mPostponedAlpha: Float

mPostponedDurationRunnable

val mPostponedDurationRunnable: Runnable

mRemoving

val mRemoving: Boolean

mRestored

val mRestored: Boolean

mRetainInstance

val mRetainInstance: Boolean

mRetainInstanceChangedWhileDetached

val mRetainInstanceChangedWhileDetached: Boolean

mSavedFragmentState

val mSavedFragmentState: Bundle

mSavedStateRegistryController

val mSavedStateRegistryController: SavedStateRegistryController

mSavedUserVisibleHint

val mSavedUserVisibleHint: Boolean?

mSavedViewState

val mSavedViewState: SparseArray<Parcelable>

mState

val mState: Int

mTag

val mTag: String

mTarget

val mTarget: Fragment

mTargetRequestCode

val mTargetRequestCode: Int

mTargetWho

val mTargetWho: String

mUserVisibleHint

val mUserVisibleHint: Boolean

mView

val mView: View

mViewLifecycleOwner

val mViewLifecycleOwner: FragmentViewLifecycleOwner?

mViewLifecycleOwnerLiveData

val mViewLifecycleOwnerLiveData: MutableLiveData<LifecycleOwner>

mWho

val mWho: String