Introducing Gradio Clients
WatchIntroducing Gradio Clients
WatchNew to Gradio? Start here: Getting Started
See the Release History
gradio.Audio(···)
type
): a str
filepath, or tuple
of (sample rate in Hz, audio data as numpy array). If the latter, the audio data is a 16-bit int
array whose values range from -32768 to 32767 and shape of the audio data array is (samples,) for mono audio or (samples, channels) for multi-channel audio.def predict(
value: str | tuple[int, np.ndarray] | None
)
...
str
or pathlib.Path
filepath or URL to an audio file, or a bytes
object (recommended for streaming), or a tuple
of (sample rate in Hz, audio data as numpy array). Note: if audio is supplied as a numpy array, the audio will be normalized by its peak value to avoid distortion or clipping in the resulting audio.def predict(···) -> str | Path | bytes | tuple[int, np.ndarray] | None
...
return value
Class | Interface String Shortcut | Initialization |
---|---|---|
| "audio" | Uses default values |
| "microphone" | Uses sources=["microphone"] |
Event listeners allow you to respond to user interactions with the UI components you've defined in a Gradio Blocks app. When a user interacts with an element, such as changing a slider value or uploading an image, a function is called.
The Audio component supports the following event listeners. Each event listener takes the same parameters, which are listed in the Event Parameters table below.
Listener | Description |
---|---|
| This listener is triggered when the user streams the Audio. |
| Triggered when the value of the Audio changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See |
| This listener is triggered when the user clears the Audio using the X button for the component. |
| This listener is triggered when the user plays the media in the Audio. |
| This listener is triggered when the media in the Audio stops for any reason. |
| This listener is triggered when the user reaches the end of the media playing in the Audio. |
| This listener is triggered when the media in the Audio stops for any reason. |
| This listener is triggered when the user starts recording with the Audio. |
| This listener is triggered when the user pauses recording with the Audio. |
| This listener is triggered when the user stops recording with the Audio. |
| This listener is triggered when the user uploads a file into the Audio. |
| This listener is triggered when the user changes the value of the Audio. |
gradio.WaveformOptions(···)
waveform_options
parameter of gr.Audio
.