Skip to main content

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.

Properties

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

audioFile

Details of the recorded audio.

Type object
Mutability Read-only
Object Properties

contentType

The MIME type.

Type string
Mutability Read-only

data

The base64 encoded data of the audio.

Type string
Mutability Read-only

name

The name of the audio file.

Type string
Mutability Read-only

size

The size of the item in bytes.

Type number
Mutability Read-only

type

The file type.

Type string
Format MIME Type
Mutability Read-only
Examples
"audio/ogg"


audioURL

The base64-encoded URL of the audio.

Type string
Format Data URL
Mutability Read-only
Examples
"data:audio/ogg;base64,SGVsbG8gV29ybGQ="

disabled

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

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Interaction > Disabled
MethodsetDisabled()
Default
false
Examples
true

hidden

Whether this object is hidden from view.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Appearance > Hidden
MethodsetHidden()
Default
false
Examples
true

id

The unique identifier (name).

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector
Default
microphone1
Examples
query1
button1

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Appearance > Advanced > Show on desktop
Default
false
Examples
true

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Appearance > Advanced > Show on mobile
Default
true
Examples
true

label

The text label to display.

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector > Content > Add-ons > Label > Label
Default
null
Examples
"Label"

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Appearance > Advanced > Maintain space when hidden
Default
false
Examples
true

margin

The amount of margin to render outside.

Type string
Format Plain Text
Mutability
ControlUsage
Retool UI Inspector > Spacing > Margin
Allowed Values
ValueUI OptionDescription
4px 8pxNormal

Normal margin.

0None

No margin.

Default
4px 8px
Examples
4px 8px

recording

Whether the audio is recording.

Type boolean
Mutability Read-only

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type boolean
Format True/False
Mutability
ControlUsage
Retool UI Inspector > Appearance > Advanced > Always show in edit mode
Default
false
Examples
true

stopLabel

The label for the Stop button.

Type string
Mutability Read-only

style

Custom style options.

Type object
Mutability
ControlUsage
Retool UI Inspector > Appearance > style

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

microphone.reset()

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

Definition
microphone.reset()
Examples

Reset microphone.

microphone.reset();

microphone.scrollIntoView()

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

Definition
microphone.scrollIntoView(options)
Parameters

options

The scroll options.

Type object
Object Properties

behavior

The scroll behavior.

Type string
Allowed Values
ValueDescription
auto

Scroll immediately to the specified position.

smooth

Scroll gradually to the specified position.


block

The scroll position relative to the component.

Type string
Allowed Values
ValueDescription
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.



Examples

Scroll the minimum amount to immediately bring microphone into view.

microphone.scrollIntoView({behavior: 'auto', block: 'nearest'});

Events

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

EventDescription
ChangeThe value is changed.