Skip to content

GiovanniSalmeri/yellow-sound

Repository files navigation

Sound 0.9.1

Embed audio tracks.

Screenshot

How to install an extension

Download ZIP file and copy it into your system/extensions folder. Learn more about extensions.

How to embed audio tracks

Create a [sound] shortcut.

The following argument are available, the second argument is optional:

Source = audio source, supported audio sources
Label = description of the audio, wrap multiple words into quotes, supported placeholders; it is ignored for third-party services

All media files are located in the media folder. The media/sounds folder is the place to store your audio files. You can also create additional folders and organise files as you like.

The following audio sources are supported:

name of an audio track (MP3, OPUS, OGG, FLAC, M4A, WAV) in the media/sounds folder
name of a playlist (M3U, PLS) in the media/sounds folder
url of an audio track (MP3, OPUS, OGG, FLAC, M4A, WAV)
url of a playlist (M3U, PLS)
url of an Internet radio (MP3)
id and instance of a Funkwhale track or playlist or album, written respectively as track=id@instance, playlist=id@instance, album=id@instance
id of a Anghami song or playlist, written respectively as song=id and playlist=id
id of a Idagio album
id of a Mixcloud track
id of a SoundCloud track
id of a Spotify track or playlist or album, written respectively as track=id, playlist=id, album=id

The id is the last part of the link with which the track is accessed. In some services you must look for the "embed code" in order to find it.

You should know that third-party providers collect personal data and use cookies.

The following placeholders for titles are supported:

@artist, @composer, @performer, @album, @work, @title, @subtitle, @disc, @track, @date, @genre, @radio

The values assigned to placeholders come from metadata, which are normally present in audio files. If necessary, you can fix them with programs known as "tag editors" (sometimes included in audio players) or with an online service.

If you want an image to be shown in the custom player, place it in the same folder as the audio file or playlist, with the name of the latter (e.g. my_song.jpg) or cover (e.g. cover.jpg).

How to make a playlist

Create a text file with the extension m3u, e.g. my_playlist.m3u. Write the filename of each track in a line, for example:

song_1.mp3
song_2.mp3
song_3.mp3

You can also use relative paths and URLs.

Examples

Embedding an audio track, different tracks:

[sound my_song.mp3]
[sound violin/ciaccona.flac]
[sound album=2214@funkwhale.it]
[sound track=3VM35337X7Ro1tesUHnZ95]

Embedding a playlist:

[sound my_playlist.m3u]

Embedding an Internet radio:

[sound https://icestreaming.rai.it/5.mp3]

Embedding an audio track, custom label:

[sound my_song.mp3 "@title by @artist (performed in @date)"]

Settings

The following settings can be configured in file system/extensions/yellow-system.ini:

SoundLocation = location for audio tracks
SoundDefaultTitle = default title for tracks
SoundDefaultTitleRadio = default title for radios
SoundComposerAsArtist = treat the composer (instead of the performer) as the artist, 1 or 0
SoundFileNamePattern = pattern for scanning file names, when metadata are missing
SoundShowDownloadLink = show download link, 1 or 0

Use Perpage if you want to ovverride these settings for a single page.

Acknowledgements

This extension uses various sources for the audio tracks. Thank you for the services.

Developer

Giovanni Salmeri. Get help.