The Microphone component for Retool Apps

A button to record audio.

Recordings are Base64-encoded in WebM format, and audio playback displays a progress bar and elapsed time.

Settings

Microphone includes the following configurable options when building apps in the IDE.

DisabledEvent handlersHiddenSuffix iconPrefix iconShow on desktopShow on mobileLabelMaintain space when hiddenMarginAlways show in edit modeStylesVariant

Properties

All properties for Microphone with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

audioFile

object

Details of the recorded audio.

Properties

contentType

string

The MIME type.

data

string

The base64 encoded data of the audio.

name

string

The name of the audio file.

size

number

The size of the item in bytes.

type

enum

The file type.

Values

__FILE_OBJECT_AS_JSON__

A JSON object with base64-encoded data.

audioURL

string

The base64-encoded URL of the audio.

disabled

boolean

Whether input, interaction, selection, or triggering is disabled.

events

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event

enum

The event type.

Values

change	A user changes the value.
click	A user clicks or taps the component.
submit	A user submits the value.
focus	A user selects the input field.
blur	A user deselects the input field.
scan	A user scans a barcode.
open	A user opens the component.
close	A user closes the component.
true	A user sets the value to true.
false	A user sets the value to false.
select	A user selects a value.
clear	A user clears the value.
upload	A user uploads a file.
parse	An uploaded file is parsed.
inputValueChange	A user changes the value of the input field.

method

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

type

enum

The type of action to perform.

Values

datasource	Control query.
widget	Control component.
script	Run script.
state	Set variable.
localStorage	Set localStorage.
util	Perform utility action (e.g., Open URL or Confetti).

hidden

boolean

Whether the component is visible.

iconAfter

enum

The suffix icon to display.

Values

You can select an icon or dynamically set one with a valid icon key.

iconBefore

enum

The prefix icon to display.

Values

You can select an icon or dynamically set one with a valid icon key.

id

string

The unique identifier.

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

label

string

The text label to display.

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

pluginType

string

The plugin type.

recording

boolean

Whether the audio is recording.

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

stopLabel

string

The label for the Stop button.

style

object

Custom style options in use. Not all style options may be available for all components.

styleVariant

enum

The button variant to use.

Values

solid	Solid background color.
outline	Button outline only.

Methods

JavaScript API methods for interacting with Microphone. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

reset

Reset all child inputs to default values or clears them if no default values are set.

microphone.reset()

scrollIntoView

Scrolls the canvas or parent container so that the selected component appears in the visible area.

microphone.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

block

enum

The scroll position relative to the component.

Values

nearest	Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.
start	Scrolls to position the component at the top of the visible area.
center	Scrolls to position the component in the middle of the visible area.
end	Scrolls to position the component at the bottom of the visible area.

Events

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.

change

The value is changed.