librosa.util.example_info#

librosa.util.example_info(key, *, html=False)[source]#

Display licensing and metadata information for the given example recording.

The first time an example is requested, it will be downloaded from the remote repository over HTTPS. All subsequent requests will use a locally cached copy of the recording.

For a list of examples (and their keys), see librosa.util.list_examples.

By default, local files will be cached in the directory given by pooch.os_cache(‘librosa’). You can override this by setting an environment variable LIBROSA_DATA_DIR prior to importing librosa.

Parameters:

keystr: The identifier for the recording (see list_examples)
htmlbool: If True, return the information in HTML format. If False, print the information in plain text format.

Returns:

infostr or None: If html is True, return the HTML formatted string. Otherwise, no return value.