Show API reference for

st.column_config.AudioColumn

Configure an audio column in st.dataframe or st.data_editor.

The cell values need to be one of:

  • A URL to fetch the audio from. This can also be a relative URL of an audio file deployed via static file serving. Note that you can NOT use an arbitrary local audio file if it is not available through a public URL.
  • A data URL containing a Base64 encoded audio like data:audio/mp3;base64,//uQ....

Audio columns are not editable at the moment. This command needs to be used in the column_config parameter of st.dataframe or st.data_editor.

Function signature[source]

st.column_config.AudioColumn(label=None, *, width=None, help=None, pinned=None, alignment=None)

Parameters

label (str or None)

The label shown at the top of the column. If this is None (default), the column name is used.

width ("small", "medium", "large", int, or None)

The display width of the column. If this is None (default), the column will be sized to fit the cell contents. Otherwise, this can be one of the following:

  • "small": 75px wide
  • "medium": 200px wide
  • "large": 400px wide
  • An integer specifying the width in pixels

If the total width of all columns is less than the width of the dataframe, the remaining space will be distributed evenly among all columns.

help (str or None)

A tooltip that gets displayed when hovering over the column label. If this is None (default), no tooltip is displayed.

The tooltip can optionally contain GitHub-flavored Markdown, including the Markdown directives described in the body parameter of st.markdown.

pinned (bool or None)

Whether the column is pinned. A pinned column will stay visible on the left side no matter where the user scrolls. If this is None (default), Streamlit will decide: index columns are pinned, and data columns are not pinned.

alignment ("left", "center", "right", or None)

The horizontal alignment of cell content. If this is None (default), audio icons are center-aligned.

Examples

Python
import pandas as pd
import streamlit as st

data_df = pd.DataFrame(
    {
        "audio": [
            "https://example.com/audio1.mp3",
            "https://example.com/audio2.mp3",
            "https://example.com/audio3.mp3",
        ],
    }
)

st.dataframe(
    data_df,
    column_config={
        "audio": st.column_config.AudioColumn("Preview Audio"),
    },
)
arrow_backPrevious: Image columnarrow_forwardNext: Video column
forum

Still have questions?

Our forums are full of helpful information and Streamlit experts.