Interface VoiceArgs

Configuration arguments of a microphone open request.

exports
interface

VoiceArgs

Hierarchy

  • VoiceArgs

Index

Properties

Properties

Optional onClosed

onClosed: undefined | (() => void)

Optional callback function that will be called when the microphone closes at the end of a successful request.

param

Function to call on microphone close

Optional onError

onError: undefined | ((error: MicrophoneOpenedError) => void)

Optional callback function that will be called if the microphone request is unsuccessful due to an error. This includes cases where the request was denied because the microphone was already opened.

param

Function to call on request error

Optional onOpened

onOpened: undefined | (() => void)

Optional callback function that will be called when the microphone opens if the request is successful.

param

Function to call on microphone open

2019, Amazon.com, Inc. or its affiliates. All Rights Reserved.