Audio

The Audio class allows you to display an audio player for a specific audio file in the chatbot user interface. You must provide either an url or a path or content bytes.

Attributes

str

The name of the audio file to be displayed in the UI. This is shown to users.

ElementDisplay

Determines where the element should be displayed in the UI. Choices are “side” (default), “inline”, or “page”.

str

The remote URL of the audio.

str

The local file path of the audio.

bytes

The file content of the audio in bytes format.

bool

Whether the audio should start playing automatically.

Example

import chainlit as cl


@cl.on_chat_start
async def main():
    elements = [
        cl.Audio(name="example.mp3", path="./example.mp3", display="inline"),
    ]
    await cl.Message(
        content="Here is an audio file",
        elements=elements,
    ).send()

PDF viewer Video

Life Cycle Hooks

Chat

Elements

Ask User

Integrations

Misceallaneous

Input Widgets

Attributes

Example

​Attributes

​Example

Attributes

Example