Character Vault
Any Concept / Any System
Compendium
Your System Come To Life
Roll20 for Android
Streamlined for your Tablet
Roll20 for iPad
Streamlined for your Tablet

Personal tools

Difference between revisions of "Jukebox"

From Roll20 Wiki

Jump to: navigation, search
m (Playlists Options)
m
 
(38 intermediate revisions by 10 users not shown)
Line 1: Line 1:
[[File:JukeboxTab.png|framed|right|The Jukebox]]
+
{{revdate}}{{HCbox|{{hc|articles/360039178714-Jukebox Here}} }} {{cleanup}}{{clear}}
The Jukebox is the fourth tab of the Sidebar. This feature allows the GM to accesses the sounds and music from [http://tabletopaudio.com/ Tabletop Audio], [http://incompetech.com/ Incompetech], [https://battlebards.com/ BattleBards], and [http://fanburst.com/ Fanburst].
+
{{SidebarNav}}
 +
[[File:JukeboxTab2.png|framed|right|The Jukebox]]
 +
The {{Jukebox}} is the fourth tab of the [[Sidebar]].
 +
 
 +
This feature allows the GM to accesses the sounds and music from [http://tabletopaudio.com/ Tabletop Audio], [http://incompetech.com/ Incompetech], [https://battlebards.com/ BattleBards], [https://wiki.roll20.net/Jukebox#My_Audio_Using_Your_Own_Music.2FSounds My Audio], or to upload & play their own files.
  
 
== Finding and Adding Audio Tracks to the Jukebox ==
 
== Finding and Adding Audio Tracks to the Jukebox ==
[[File:Track Select Window.png|framed|right|The Jukebox Track Selection Window]]
+
[[File:JukeboxManageAudio.jpg|framed|left|Click on the '''Manage Audio''' button to open the Audio Manager]]
[[File:JukeboxAddMenu.png|framed|left|Click on the '''+ Add''' button to select between adding Tracks or Playlists]]
+
[[File:ManageTracks.jpg|framed|right|Find, upload, rename, and delete tracks]]
From the Jukebox, click the '''+Add''' button, then select '''Track''' from the revealed sub-menu to open a popup window with tabs for audio source options. There are tabs for the current four sources of audio we have available through Roll20: Tabletop Audio, BattleBards, Incompetech, Fanburst.
+
From the Jukebox, click the '''Manage Audio''' button to open a popup window to manage your audio.
 +
[[File:ManageAudio.png|framed|left|The Manage Audio dialog box has two tabs: Playlists and Tracks.]]
 +
The Manage Audio dialog box has two tabs: Playlists and Tracks. Click Tracks to manage individual audio tracks.
 +
 
 +
There are tabs for the current four sources of audio we have available through Roll20: My Audio, Tabletop Audio, BattleBards, Incompetech.
  
 
Regardless of what audio tab you're searching under, you can always preview individual tracks by pressing the '''Play''' button.
 
Regardless of what audio tab you're searching under, you can always preview individual tracks by pressing the '''Play''' button.
 
<div style="clear: left"></div>
 
<div style="clear: left"></div>
 +
=== My Audio Using Your Own Music/Sounds ===
 +
 +
Roll20 supports uploading and streaming of your own audio files with the My Audio section in the Jukebox. Audio files uploaded count towards your storage quota. The system allows uploads of up to 20MB. The Roll20 system processes your audio to optimize streaming and storage.
 +
 +
==== Supported Audio Files ====
 +
 +
My Audio supports {{c|.mp3}}, {{c|.ogg}}, and {{c|.flac}} file types. Only upload audio files that you have the rights to use. Please [[Best Practices for Files on Roll20|keep in mind best practices for audio files]] when creating or choosing files.
 +
 +
The {{button|Add New Empty Playlist|white}} button will allow you to create a folder that can store and play tracks that you upload.
 +
 +
==== How to Upload Music and Sound Files ====
 +
 +
From the My Audio tab, drag files to the box marked with dashed line, and "Drop media files here to upload." A square will appear to represent the file as it's being processed. Once complete, the file will show up in the list of files.
 +
 +
Once there, you can click:
 +
* The title of the track to edit the track title and open the track edit tools
 +
* The track title, then trash can icon to delete the track
 +
* The Add To dropdown to add the track to a playlist or to the game
 +
* The play icon to preview the track
 +
* The Add button to add tags to the track for easier searching
 +
 
=== Tabletop Audio ===
 
=== Tabletop Audio ===
 
[http://tabletopaudio.com/ Tabletop Audio] is a site created to provide 10-minute-long background audio tracks for RPG gaming sessions. Roll20 has teamed up with Tabletop Audio to incorporate their library of audio and music into the Roll20 Jukebox.
 
[http://tabletopaudio.com/ Tabletop Audio] is a site created to provide 10-minute-long background audio tracks for RPG gaming sessions. Roll20 has teamed up with Tabletop Audio to incorporate their library of audio and music into the Roll20 Jukebox.
  
 
From the Tabletop Audio tab, use the '''Search For:''' drop-down menu to filter the Tabletop Audio tracks available. You can narrow down your search by genre (Fantasy, Sci-Fi, Historical, Modern, Nature, Horror, and Music are the currently available genre options).
 
From the Tabletop Audio tab, use the '''Search For:''' drop-down menu to filter the Tabletop Audio tracks available. You can narrow down your search by genre (Fantasy, Sci-Fi, Historical, Modern, Nature, Horror, and Music are the currently available genre options).
 +
 +
{{mbox | text = '''Note:''' TabletopAudio content is licensed under a [https://creativecommons.org/licenses/by-nc-nd/4.0/ Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License]..}}
 +
 +
 +
TabletopAudio content can be used in podcasts and videos with attribution, if the channel is non-profit. For content producers monetizing their content, [http://tabletopaudio.com/about.html TabletopAudio requests you contact him] to discuss a licensing arrangement, if your channel is making significant money.
  
 
=== BattleBards ===
 
=== BattleBards ===
Line 20: Line 54:
  
 
=== Incompetech ===
 
=== Incompetech ===
[http://incompetech.com/ Incompetech] is a site created by Kevin MacLeod that houses a prolific library of music tracks that he has composed and made available to the public. All of Incompetech tracks are shared under a Creative Commons license: By Attribution 3.0 [http://creativecommons.org/licenses/by/3.0/ http://creativecommons.org/licenses/by/3.0/]. The Roll20 Jukebox has a collection of over 1,000 different Incompetech music tracks that spans a large variety of genre types.
+
[http://incompetech.com/ Incompetech] is a site created by Kevin MacLeod that houses a prolific library of music tracks that he has composed and made available to the public. All of Incompetech tracks are shared under a [http://creativecommons.org/licenses/by/3.0/ Creative Commons: By Attribution 3.0] license. The Roll20 Jukebox has a collection of over 1,000 different Incompetech music tracks that spans a large variety of genre types.
  
 
From the Incompetech tab, use the '''Search For:''' field to search via keywords. At present, keywords only seek out ones that are in the track title. We recommend going to [http://incompetech.com/music/royalty-free/music.html Incompetech's site directly] for more enhanced search options that are categorized by Feel, Tempo, Genre, and Length. Once you find the tracks you want, enter their titles in the keyword search of the Track Selection Window to bring them up.
 
From the Incompetech tab, use the '''Search For:''' field to search via keywords. At present, keywords only seek out ones that are in the track title. We recommend going to [http://incompetech.com/music/royalty-free/music.html Incompetech's site directly] for more enhanced search options that are categorized by Feel, Tempo, Genre, and Length. Once you find the tracks you want, enter their titles in the keyword search of the Track Selection Window to bring them up.
Line 26: Line 60:
 
<br>
 
<br>
  
=== Using Your Own Music/Sounds through Fanburst ===
+
===Managing Playlists===
[http://fanburst.com/ Fanburst] is a free online service for musicians and creators to upload and share their music: Unlimited uploads for artists, unlimited streaming for fans. Roll20 has integrated Fanburst so that you can stream audio from their extensive library into your own games.
+
[[File:AddToPlaylist.png|framed|Click '''Add To''' to add a track to a playlist.]]
  
From the Fanburst tab, use the '''Search For:''' field to search via keywords. At present, keywords only seek out ones that are in the track title.
+
[[File:AddPlaylistToGame.jpg|framed|Click '''Add to Game''' to add a playlist to your game.]]
{{mbox | text = '''Note:''' Fanburst’s TOS prohibits the streaming of copyrighted content. Upload at your own risk.}}
+
  
==== Transferring SoundCloud Audio to Fanburst ====
+
You now manage your Playlists in the audio management dialog box, where you can set up playlists that use audio from any source (currently including Battle Bards, Incompetech, Tabletop Audio, and your own uploaded audio files), and Playlists can be copied out of a game and into another game easily.
As of September of 2016, SoundCloud, the principle music resource utilized by the Roll20 Jukebox since its inception, privatized their API access. This prevented Jukebox playback for any tracks hosted by them in the Roll20 Jukebox. If you had hosted your own audio on SoundCloud for use in Roll20 games, there is a one-click option available to copy your SoundCloud library to Fanburst when you create a Fanburst account.
+
  
Presently, if you have any SoundCloud tracks in a campaign, these will remain listed in your Jukebox. You will not be able to play them, but you will retain the ability to obtain the SoundCloud URL of these tracks. Clicking on the Cloud icon that appears when you hover over a track will open up the SoundCloud URL in a new browser tab.
+
Open the Manage Audio dialog box by clicking the Manage Audio button in the Jukebox.
  
=== Adding Tracks to Your Game ===
+
Click the '''Playlist''' tab to navigate to your playlists. The search box returns results for terms that match Track titles, Track tags, Playlist titles, or Playlists that contain Track matching tags.
  
Add your desired music/sound tracks to your campaign's Jukebox library by clicking the '''+''' button that hovers over the track listing (this is directly to the right of the play button). This adds the new track to the bottom of your track list in the Jukebox.
+
Click '''New Playlist''' to create a new playlist for your tracks.
 +
 
 +
Click to the '''Tracks''' tab to add tracks from your uploaded audio, Tabletop Audio, Battlebards, or Incompetech. Find the track and click '''Add to...''' to select either the current game, or the playlist by name.
 +
 
 +
Add the playlist to your game by returning to the '''Playlist''' tab and clicking '''Add to Game''':
 +
 
 +
Note that, because the playlist is in your audio library, when you go into a different game where you are the GM, you can copy the playlist to the new game.
 +
 
 +
You can also rename the playlist by clicking the pencil icon, or delete tracks from the playlist by clicking the X icon. To delete a playlist, click the pencil icon and then select the trash can.
 +
 
 +
Note that this feature creates a new copy of the Playlist in the game. In this way, you can change a playlist for any one dramatic role playing scene or amazing action battle sequence without affecting any other game. If you delete a track from a playlist, it will not be deleted from the playlist in your Playlist tool, nor any games that the playlist is already in. However, if you like the changes, you can export the Playlist out of the game and into the Manage Audio tool for safe keeping.
 +
 
 +
To export a playlist, click the '''Export''' button on the far right of the playlist in the {{Jukebox}}.
 +
 
 +
[[File:ExportPlaylist.png|framed|Click the Export icon to export a playlist from the Jukebox into Manage Audio]]
 +
 
 +
=== Adding Tracks to Your Game ===
 +
Add your desired music/sound tracks to your campaign's Jukebox library by clicking the '''Add To''' menu in the track listing (this is directly to the right of the track title). Selecting "To Game" adds the new track to the bottom of your track list in the Jukebox. Selecting any playlist in your playlists will add the track to the bottom of that playlist.
 +
<div style="clear:both;"></div>
  
 
== Organizing Your Jukebox Audio Tracks ==
 
== Organizing Your Jukebox Audio Tracks ==
Line 46: Line 96:
 
=== Renaming Tracks ===
 
=== Renaming Tracks ===
 
[[File:JukeboxTrackNameChange.gif|right|frame|Renaming a Jukebox Track]]
 
[[File:JukeboxTrackNameChange.gif|right|frame|Renaming a Jukebox Track]]
You can rename a track once it has been added to the Jukebox tab of the Sidebar. To rename it, hover over its entry in the Jukebox until it highlights in yellow. A type cursor will also appear. Click anywhere over the title to make it editable. Type a new name for the track and press Enter to save the change.
+
You can rename a track once it has been added to the Jukebox tab of the Sidebar. To rename it, hover over its entry in the Jukebox until it highlights in yellow. A type cursor will also appear. Click anywhere over the title to make it editable. Type a new name for the track and press {{button|Enter}} to save the change.
 
<div style="clear:both;"></div>
 
<div style="clear:both;"></div>
  
Line 55: Line 105:
  
 
=== Removing Tracks from the Jukebox ===
 
=== Removing Tracks from the Jukebox ===
[[File:DeleteJukeboxTrack.png|right|frame|The Rick-Click Delete Option for a Jukebox Track]]
+
[[File:Audio_Right_Click.png|right|frame|The Delete Option for a Jukebox Track]]
To remove tracks from your Jukebox, right click the Track title in your Jukebox to reveal a sub-menu. Click the "Delete Item" option to remove the track from your Jukebox.
+
To remove tracks from your Jukebox, click the three dot menu next to the Track title in your Jukebox to reveal a sub-menu. Click the "Delete Item" option to remove the track from your Jukebox. You can also right-click to reach this sub-menu.
 
<div style="clear:both;"></div>
 
<div style="clear:both;"></div>
 +
 +
====Removing Deprecated Tracks from the Jukebox====
 +
Fanburst and Soundcloud tracks that were added prior to those systems becoming unavailable are greyed out in the Jukebox. If you have unsupported tracks like this, you can click the "Remove all unsupported tracks" button to remove all those tracks from your game. If your game does not have any deprecated tracks in it, the button will not appear.
  
 
=== Creating Playlists ===
 
=== Creating Playlists ===
[[File:JukeboxPlaylists.png|framed|right|A Jukebox track library with Playlists ("The Estate" and "Earth"). The Estate Playlist folder has been opened to display the tracks listed within it while the Earth Playlist folder is currently collapsed.]]
+
[[File:JukeboxPlaylists.png|framed|A Jukebox track library with Playlists ("The Estate" and "Earth"). The Estate Playlist folder has been opened to display the tracks listed within it while the Earth Playlist folder is currently collapsed.]]
 
Very similar to [[Journal#Folders|Journal Folders]] in functionality, you can create folders within Jukebox's track list called Playlists. Beyond simply keeping batches of related tracks together for organization purposes, a Playlist can be played directly. This allows you to cycle play through various tracks without manually having to stop and start playback manually.
 
Very similar to [[Journal#Folders|Journal Folders]] in functionality, you can create folders within Jukebox's track list called Playlists. Beyond simply keeping batches of related tracks together for organization purposes, a Playlist can be played directly. This allows you to cycle play through various tracks without manually having to stop and start playback manually.
  
Line 68: Line 121:
  
 
==== Adding Playlists ====
 
==== Adding Playlists ====
[[File:JukeboxAddPlaylist.png|framed|left]]
+
[[File:JukeboxAddPlaylist.png|framed]]
Click the '''+ Add''' button, and then click '''Playlist'''. A popup window will appear to prompt you to give the folder a Name. Click '''Ok''' to add the named folder to your Jukebox.
+
 
<div style="clear: left"></div>
+
In addition to using the Audio Manager to create and add a playlist, you can create a playlist directly in your game.
 +
 
 +
Click the '''Create Empty Playlist''' button. A popup window will appear to prompt you to give the folder a Name. Click '''Ok''' to add the named folder to your Jukebox.
 +
{{clear|left}}
  
 
==== Playlists Options ====
 
==== Playlists Options ====
 
Right click on a Playlist to reveal these folder options: '''Sort A-Z''', '''Rename Folder''', and '''Delete Folder'''.
 
Right click on a Playlist to reveal these folder options: '''Sort A-Z''', '''Rename Folder''', and '''Delete Folder'''.
[[File:JukeboxPlaylistOptions.png|framed|left|The Playlist Folder Options]]<br />
+
[[File:JukeboxPlaylistRightClick.png|framed|The Playlist Folder Options]]<br />
 
* '''Sort Playlist Tracks:''' Choose '''Sort A-Z''' to organize the Tracks within your Playlist in alphanumerical order.<br /><br />
 
* '''Sort Playlist Tracks:''' Choose '''Sort A-Z''' to organize the Tracks within your Playlist in alphanumerical order.<br /><br />
 
* '''Rename Playlist:''' Choose '''Rename Folder''' to rename that Playlist. This will bring up the name popup window that you saw before when you first created the Playlist.<br /><br />
 
* '''Rename Playlist:''' Choose '''Rename Folder''' to rename that Playlist. This will bring up the name popup window that you saw before when you first created the Playlist.<br /><br />
 
* '''Delete Playlist:''' Choose '''Delete Folder''' when you want to remove the Playlist entirely. Deleting a Playlist does not remove its Track contents. All Tracks that were within the folder are moved to the root Playlist (The default Jukebox track list).
 
* '''Delete Playlist:''' Choose '''Delete Folder''' when you want to remove the Playlist entirely. Deleting a Playlist does not remove its Track contents. All Tracks that were within the folder are moved to the root Playlist (The default Jukebox track list).
 +
* '''Delete Playlist & Remove Tracks''': Choose '''Delete Folder & Remove Tracks''' when you want to remove the playlist and all the tracks it contains entirely.
 
<div style="clear: both"></div>
 
<div style="clear: both"></div>
  
Line 83: Line 140:
 
You can pop-out the Jukebox to a new browser window. To do this, double click on the Jukebox icon at the top of the Jukebox tab of the Sidebar.
 
You can pop-out the Jukebox to a new browser window. To do this, double click on the Jukebox icon at the top of the Jukebox tab of the Sidebar.
  
[[File:Juke.png|left|thumb|300px]]
+
[[File:Juke.png|thumb|300px]]
 
<div style='clear: both;'></div>
 
<div style='clear: both;'></div>
  
 
== Playing Music/Sounds in Game ==
 
== Playing Music/Sounds in Game ==
[[File:Jukebox_Track_Playback_Options.png|framed|left|These are the options available to any given audio track added to the Jukebox]]
+
[[File:Jukebox_Track_Playback_Options.png|framed|right|These are the options available to any given audio Track added to the Jukebox]]
 
===Play/Stop Button===
 
===Play/Stop Button===
The first icon on the left of any Jukebox track is the '''Play/Stop''' button. All players currently in the session will be able to hear the track while it plays. You can also play more than one track at a time. For example, you can have an ambient noise track running at the same time as a soundtrack music track is playing. While a track is playing, the Play icon changes to a square Stop icon. Clicking on this icon will stop playback of the track.  
+
The first icon on the left of any Jukebox Track is the '''Play/Stop''' button. All players currently in the session will be able to hear the Track while it plays. You can also play more than one Track at a time. For example, you can have an ambient noise Track running at the same time as a soundtrack music Track is playing. While a Track is playing, the Play icon changes to a square Stop icon. Clicking on this icon will stop playback of the Track.  
 
===Loop Button===
 
===Loop Button===
The next icon beside the Play/Stop button is the '''Loop Track''' button. When Loop Track is turned on, once a track reaches the end of its playback, it will automatically start playing itself from the beginning. In other words, it will never stop playing until you either toggle off Loop or click on the Stop button of the track. By default, Loop is toggled off, which shows the icon in grey. Once activated by clicking on the button, the icon turns black. Enabling or disabling Loop on a track is just a single left click.
+
The next icon beside the Play/Stop button is the '''Loop Track''' button. When Loop Track is turned on, once a Track reaches the end of its playback, it will automatically start playing itself from the beginning. In other words, it will never stop playing until you either toggle off Loop or click on the Stop button of the Track. This feature is recommended for background noise and music, but not for circumstantial sound effects like an explosion or sword slashing audio Track. By default, Loop is toggled off, which shows the icon in grey. Once activated by clicking on the button, the icon turns black. Enabling or disabling Loop on a Track is just a single left click.
 
===Volume Slider===
 
===Volume Slider===
To the right of the Loop Track button is the '''Volume Slider'''. Each track has its own volume control which can be used to normalize their volume. When the slider handle is moved to the far left of the slider, the volume level is at 0% and 100% when moved to the far right.
+
To the right of the Loop Track button is the '''Volume Slider'''. Each Track has its own volume control which can be used to normalize their volume. When the slider handle is moved to the far left of the slider, the volume level is at 0% and 100% when moved to the far right.
 
===Track Source URL Button===
 
===Track Source URL Button===
While this feature does not affect playback, it is worth mentioning if you ever want to retrace where this sound track comes from. When you hover your mouse over a track, a cloud icon will appear directly right of the Volume Slider. Clicking this icon will open the track source in a new window.
+
While this feature does not affect playback, it is worth mentioning if you ever want to retrace where an audio Track comes from. When you hover your mouse over a Track, a cloud icon will appear directly right of the Volume Slider. Clicking this icon will open the Track's source in a new window.
 
<div style="clear: left"></div>
 
<div style="clear: left"></div>
 
=== Play from Playlists ===
 
=== Play from Playlists ===
Playlists have additional play options. Next to the name of the playlist you'll find a "Play" button as well as a toggle for the "Play Mode" of the playlist.
+
Playlists have additional play options. Next to the name of the playlist you'll find a "Play" button, a toggle for the "Play Mode" of the playlist, and an icon to export the playlist from your game into your My Audio library.
  
[[File:Jukebox1.0.png|frame|border|left]]
+
In Manage Audio, you can set different playlists to different playback modes that will be used when you start that playlist.
  
==== Back to Back ====
+
Note that you cannot change the playback mode for a playlist while it is playing; either stop the playlist, or wait for it to finish.
  
"Back to Back" indicates that each track will be played individually one after another. When the end of the playlist is reached, it will start again from the beginning. If an individual track is looped within the active playlist, using this option will cause the individual track to keep looping when the playlist gets to that track.
+
==== Loop ====
 +
[[File:Loop.png|left]]
 +
"Loop" indicates that each Track will be played individually one after another in the order in which they are stored in the playlist. When the end of the playlist is reached, it will start again from the beginning. If an individual Track is looped within the active playlist, using this option will cause the individual Track to keep looping when the playlist gets to that Track.
  
==== Shuffle ====
+
=== Play Once ===
 +
[[File:PlayOneIcon.png|left]]
 +
"Play Once" means each track will be played individually one after another in the order in which they are stored in the playlist. When the end of the playlist is reached, it will stop playing. If an individual Track is looped within the active playlist, using this option will cause the individual Track to keep looping when the playlist gets to that Track.
  
"Shuffle" indicates that the tracks will be played in a random order. Order is synchronized across clients, so that tracks will play in the same order for everyone. The playlist will continue playing shuffled until you pause it manually. You should not use looped tracks with this option or it will just loop the same track over and over.
+
==== Shuffle ====
 +
[[File:Shuffle.png|left]]
 +
"Shuffle" indicates that the Tracks will be played in a random order. Order is synchronized across clients, so that Tracks will play in the same order for everyone. The playlist will continue playing shuffled until you pause it manually. You should not use looped Tracks with this option or it will just loop the same Track over and over.
  
==== All at Once ====
+
Note that the jukebox plays any random track from the playlist and may repeat some tracks before playing others.
  
"All At Once" indicates that all tracks in the playlist will start playing once the playlist is began. Note that it is up to each track's individual loop settings to determine if it will loop after it plays once. You can mix and match looped and unlooped tracks with this option.
+
==== Simulplay ====
 +
[[File:Simulplay.png|left]]
 +
"Simulplay" indicates that all Tracks in the playlist will start playing once the playlist is began. Note that it is up to each Track's individual loop settings to determine if it will loop after it plays once. You can mix and match looped and unlooped Tracks with this option.
  
 
<div style='clear: both;'></div>
 
<div style='clear: both;'></div>
Line 118: Line 183:
 
=== Now Playing Widget ===
 
=== Now Playing Widget ===
 
[[File:JukeboxNowPlaying.png|thumbnail|right|The Now Playing Widget appears up at the top of the Jukebox Tab]]
 
[[File:JukeboxNowPlaying.png|thumbnail|right|The Now Playing Widget appears up at the top of the Jukebox Tab]]
At the top of the Jukebox is a small "Now Playing" widget. This tool is visible to players in game and will only display tracks that are currently playing. Pressing "Play" will add tracks to the widget and GMs can stop directly from this widget.
+
At the top of the Jukebox is a '''Now Playing''' widget. This tool is visible to players in game, but will only display Tracks that are currently playing, and will not display the track's waveform. This is the only 'hint' to the players of what is being played when they tab over to the Jukebox. They don't have access to see the Game Master's entire Jukebox Track list. Pressing "Play" on any given Track will add those Tracks to the widget and GMs can stop their playback directly from this widget.
 +
 
 +
GMs can click anywhere in the waveform to skip to that spot in the track. Clicking the X will stop the track playback. Click the slider to adjust the volume of the individual track.
 +
 
 
<div style="clear: both"></div>
 
<div style="clear: both"></div>
  
 
=== Play on Load ===
 
=== Play on Load ===
 
[[File:Jukebox2.png|thumb|300px|right|The Play on Load feature on a Page's Settings Window]]
 
[[File:Jukebox2.png|thumb|300px|right|The Play on Load feature on a Page's Settings Window]]
At the bottom of a Page's [[Page Settings]] dialog box, there is a '''Play on Load''' drop-down menu. This menu lists every Track and Playlist that you've added to this game's Jukebox. Selecting either Jukebox track or Playlist will automatically play when you move the players to that page. Note that this only takes effect when a GM moves the '''Player Ribbon''' to that page, not for the [[Page_Toolbar#Split_the_Party|"Split the Party" feature]] (since the Jukebox is global, not player-specific).
+
At the bottom of a Page's [[Page Settings]] dialog box, there is a '''Play on Load''' drop-down menu. This menu lists every Track and Playlist that you've added to this game's Jukebox. Selecting either Jukebox Track or Playlist will automatically play when you move the players to that page. Note that this only takes effect when a GM moves the '''Player Ribbon''' to that page, not for the [[Page_Toolbar#Split_the_Party|"Split the Party" feature]] (since the Jukebox is global, not player-specific).
  
 
== Master Volume Control ==
 
== Master Volume Control ==
 
[[File:MySettingsMasterVolumeControl.png|thumbnail|left|The Master Volume Control on the My Settings Tab of the Sidebar]]
 
[[File:MySettingsMasterVolumeControl.png|thumbnail|left|The Master Volume Control on the My Settings Tab of the Sidebar]]
 
In addition to the Game Master's control of the individual track volumes in the Jukebox tab, each person connected to the game can also use the Master Volume Control located under the [[My_Settings#My_Settings|'''My Settings''']] tab to control the volume level of all music being played. This slider is located right underneath the '''Display Name''' field. This functions exactly like a volume slider on an audio track, where the far left is 0% and the far right is 100% volume.
 
In addition to the Game Master's control of the individual track volumes in the Jukebox tab, each person connected to the game can also use the Master Volume Control located under the [[My_Settings#My_Settings|'''My Settings''']] tab to control the volume level of all music being played. This slider is located right underneath the '''Display Name''' field. This functions exactly like a volume slider on an audio track, where the far left is 0% and the far right is 100% volume.
<div style="clear: both"></div>
+
<div style="clear: both"></div>{{apiboxRec}}
 +
=API=
 +
{{Pro only|section}}
 +
{{:Jukebox/API}}
 +
 
 +
=[[Sidebar]]=
 +
The other tabs in the [[Sidebar]]:
 +
* {{Text Chat}}
 +
** [[Complete Guide to Macros & Rolls‎]]
 +
* {{Art Library}}
 +
* {{Journal}}
 +
** [[Character Sheets]]
 +
* {{Compendium}}
 +
* {{Jukebox}}
 +
* {{Collections}}
 +
** [[Macros]]
 +
** [[Playing Cards]]
 +
** [[Rollable Tables]]
 +
* {{My Settings}}
 +
** [[Advanced Shortcuts|Advanced Keyboard Shortcuts]]
 +
 
 
[[Category:Docs]]
 
[[Category:Docs]]
 +
[[Category:Sidebar]]
 +
[[Category:Roll20]]
 +
[[Category:Audio]]

Latest revision as of 13:42, 4 June 2022

Attention: This page is community-maintained. For the official Roll20 version of this article, see the Help Center for assistance: Here .

The Jukebox

The u Jukebox is the fourth tab of the Sidebar.

This feature allows the GM to accesses the sounds and music from Tabletop Audio, Incompetech, BattleBards, My Audio, or to upload & play their own files.

Contents

[edit] Finding and Adding Audio Tracks to the Jukebox

Click on the Manage Audio button to open the Audio Manager
Find, upload, rename, and delete tracks

From the Jukebox, click the Manage Audio button to open a popup window to manage your audio.

The Manage Audio dialog box has two tabs: Playlists and Tracks.

The Manage Audio dialog box has two tabs: Playlists and Tracks. Click Tracks to manage individual audio tracks.

There are tabs for the current four sources of audio we have available through Roll20: My Audio, Tabletop Audio, BattleBards, Incompetech.

Regardless of what audio tab you're searching under, you can always preview individual tracks by pressing the Play button.

[edit] My Audio Using Your Own Music/Sounds

Roll20 supports uploading and streaming of your own audio files with the My Audio section in the Jukebox. Audio files uploaded count towards your storage quota. The system allows uploads of up to 20MB. The Roll20 system processes your audio to optimize streaming and storage.

[edit] Supported Audio Files

My Audio supports .mp3, .ogg, and .flac file types. Only upload audio files that you have the rights to use. Please keep in mind best practices for audio files when creating or choosing files.

The Add New Empty Playlist button will allow you to create a folder that can store and play tracks that you upload.

[edit] How to Upload Music and Sound Files

From the My Audio tab, drag files to the box marked with dashed line, and "Drop media files here to upload." A square will appear to represent the file as it's being processed. Once complete, the file will show up in the list of files.

Once there, you can click:

  • The title of the track to edit the track title and open the track edit tools
  • The track title, then trash can icon to delete the track
  • The Add To dropdown to add the track to a playlist or to the game
  • The play icon to preview the track
  • The Add button to add tags to the track for easier searching

[edit] Tabletop Audio

Tabletop Audio is a site created to provide 10-minute-long background audio tracks for RPG gaming sessions. Roll20 has teamed up with Tabletop Audio to incorporate their library of audio and music into the Roll20 Jukebox.

From the Tabletop Audio tab, use the Search For: drop-down menu to filter the Tabletop Audio tracks available. You can narrow down your search by genre (Fantasy, Sci-Fi, Historical, Modern, Nature, Horror, and Music are the currently available genre options).


TabletopAudio content can be used in podcasts and videos with attribution, if the channel is non-profit. For content producers monetizing their content, TabletopAudio requests you contact him to discuss a licensing arrangement, if your channel is making significant money.

[edit] BattleBards

BattleBards is another site partnered with Roll20 to bring you a portfolio of audio and music tracks integrated into Roll20's Jukebox.

From the BattleBards tab, use the Search For: drop-down menu to filter the BattleBards tracks available. You can narrow down your search by track category (Monsterscapes, Music, NPC Scripts, Racial Languages, Sound Effects, and Soundscapes are the currently available category options).

[edit] Incompetech

Incompetech is a site created by Kevin MacLeod that houses a prolific library of music tracks that he has composed and made available to the public. All of Incompetech tracks are shared under a Creative Commons: By Attribution 3.0 license. The Roll20 Jukebox has a collection of over 1,000 different Incompetech music tracks that spans a large variety of genre types.

From the Incompetech tab, use the Search For: field to search via keywords. At present, keywords only seek out ones that are in the track title. We recommend going to Incompetech's site directly for more enhanced search options that are categorized by Feel, Tempo, Genre, and Length. Once you find the tracks you want, enter their titles in the keyword search of the Track Selection Window to bring them up.


[edit] Managing Playlists

Click Add To to add a track to a playlist.
Click Add to Game to add a playlist to your game.

You now manage your Playlists in the audio management dialog box, where you can set up playlists that use audio from any source (currently including Battle Bards, Incompetech, Tabletop Audio, and your own uploaded audio files), and Playlists can be copied out of a game and into another game easily.

Open the Manage Audio dialog box by clicking the Manage Audio button in the Jukebox.

Click the Playlist tab to navigate to your playlists. The search box returns results for terms that match Track titles, Track tags, Playlist titles, or Playlists that contain Track matching tags.

Click New Playlist to create a new playlist for your tracks.

Click to the Tracks tab to add tracks from your uploaded audio, Tabletop Audio, Battlebards, or Incompetech. Find the track and click Add to... to select either the current game, or the playlist by name.

Add the playlist to your game by returning to the Playlist tab and clicking Add to Game:

Note that, because the playlist is in your audio library, when you go into a different game where you are the GM, you can copy the playlist to the new game.

You can also rename the playlist by clicking the pencil icon, or delete tracks from the playlist by clicking the X icon. To delete a playlist, click the pencil icon and then select the trash can.

Note that this feature creates a new copy of the Playlist in the game. In this way, you can change a playlist for any one dramatic role playing scene or amazing action battle sequence without affecting any other game. If you delete a track from a playlist, it will not be deleted from the playlist in your Playlist tool, nor any games that the playlist is already in. However, if you like the changes, you can export the Playlist out of the game and into the Manage Audio tool for safe keeping.

To export a playlist, click the Export button on the far right of the playlist in the u Jukebox.

Click the Export icon to export a playlist from the Jukebox into Manage Audio

[edit] Adding Tracks to Your Game

Add your desired music/sound tracks to your campaign's Jukebox library by clicking the Add To menu in the track listing (this is directly to the right of the track title). Selecting "To Game" adds the new track to the bottom of your track list in the Jukebox. Selecting any playlist in your playlists will add the track to the bottom of that playlist.

[edit] Organizing Your Jukebox Audio Tracks

Once you begin adding audio to your Jukebox, you're likely to create a very robust library of audio tracks before too long. There are several methods Roll20 gives you to keep all of your tracks organized.

[edit] Renaming Tracks

Renaming a Jukebox Track

You can rename a track once it has been added to the Jukebox tab of the Sidebar. To rename it, hover over its entry in the Jukebox until it highlights in yellow. A type cursor will also appear. Click anywhere over the title to make it editable. Type a new name for the track and press Enter to save the change.

[edit] Rearranging Tracks

How to Rearrange the Order of the Track List

When you hover your mouse over a Track in the Jukebox, an icon displaying three horizontal lines will appear to the left of its listing. This icon is the handle for the Track. Clicking and dragging this icon allows you to rearrange the order of the current track list.

[edit] Removing Tracks from the Jukebox

The Delete Option for a Jukebox Track

To remove tracks from your Jukebox, click the three dot menu next to the Track title in your Jukebox to reveal a sub-menu. Click the "Delete Item" option to remove the track from your Jukebox. You can also right-click to reach this sub-menu.

[edit] Removing Deprecated Tracks from the Jukebox

Fanburst and Soundcloud tracks that were added prior to those systems becoming unavailable are greyed out in the Jukebox. If you have unsupported tracks like this, you can click the "Remove all unsupported tracks" button to remove all those tracks from your game. If your game does not have any deprecated tracks in it, the button will not appear.

[edit] Creating Playlists

A Jukebox track library with Playlists ("The Estate" and "Earth"). The Estate Playlist folder has been opened to display the tracks listed within it while the Earth Playlist folder is currently collapsed.

Very similar to Journal Folders in functionality, you can create folders within Jukebox's track list called Playlists. Beyond simply keeping batches of related tracks together for organization purposes, a Playlist can be played directly. This allows you to cycle play through various tracks without manually having to stop and start playback manually.

To add a Track to a Playlist folder, click and drag the Track's handle icon to move items into the folder. You can pull Tracks out or swap Tracks between Playlists in the exact same fashion.

One thing to note about The Jukebox Playlist system is that it is only 1 level deep, sub-folders are not available in the Jukebox.

[edit] Adding Playlists

JukeboxAddPlaylist.png

In addition to using the Audio Manager to create and add a playlist, you can create a playlist directly in your game.

Click the Create Empty Playlist button. A popup window will appear to prompt you to give the folder a Name. Click Ok to add the named folder to your Jukebox.

[edit] Playlists Options

Right click on a Playlist to reveal these folder options: Sort A-Z, Rename Folder, and Delete Folder.

The Playlist Folder Options

  • Sort Playlist Tracks: Choose Sort A-Z to organize the Tracks within your Playlist in alphanumerical order.

  • Rename Playlist: Choose Rename Folder to rename that Playlist. This will bring up the name popup window that you saw before when you first created the Playlist.

  • Delete Playlist: Choose Delete Folder when you want to remove the Playlist entirely. Deleting a Playlist does not remove its Track contents. All Tracks that were within the folder are moved to the root Playlist (The default Jukebox track list).
  • Delete Playlist & Remove Tracks: Choose Delete Folder & Remove Tracks when you want to remove the playlist and all the tracks it contains entirely.

[edit] Popping-Out the Jukebox into a New Browser Window

You can pop-out the Jukebox to a new browser window. To do this, double click on the Jukebox icon at the top of the Jukebox tab of the Sidebar.

Juke.png

[edit] Playing Music/Sounds in Game

These are the options available to any given audio Track added to the Jukebox

[edit] Play/Stop Button

The first icon on the left of any Jukebox Track is the Play/Stop button. All players currently in the session will be able to hear the Track while it plays. You can also play more than one Track at a time. For example, you can have an ambient noise Track running at the same time as a soundtrack music Track is playing. While a Track is playing, the Play icon changes to a square Stop icon. Clicking on this icon will stop playback of the Track.

[edit] Loop Button

The next icon beside the Play/Stop button is the Loop Track button. When Loop Track is turned on, once a Track reaches the end of its playback, it will automatically start playing itself from the beginning. In other words, it will never stop playing until you either toggle off Loop or click on the Stop button of the Track. This feature is recommended for background noise and music, but not for circumstantial sound effects like an explosion or sword slashing audio Track. By default, Loop is toggled off, which shows the icon in grey. Once activated by clicking on the button, the icon turns black. Enabling or disabling Loop on a Track is just a single left click.

[edit] Volume Slider

To the right of the Loop Track button is the Volume Slider. Each Track has its own volume control which can be used to normalize their volume. When the slider handle is moved to the far left of the slider, the volume level is at 0% and 100% when moved to the far right.

[edit] Track Source URL Button

While this feature does not affect playback, it is worth mentioning if you ever want to retrace where an audio Track comes from. When you hover your mouse over a Track, a cloud icon will appear directly right of the Volume Slider. Clicking this icon will open the Track's source in a new window.

[edit] Play from Playlists

Playlists have additional play options. Next to the name of the playlist you'll find a "Play" button, a toggle for the "Play Mode" of the playlist, and an icon to export the playlist from your game into your My Audio library.

In Manage Audio, you can set different playlists to different playback modes that will be used when you start that playlist.

Note that you cannot change the playback mode for a playlist while it is playing; either stop the playlist, or wait for it to finish.

[edit] Loop

Loop.png

"Loop" indicates that each Track will be played individually one after another in the order in which they are stored in the playlist. When the end of the playlist is reached, it will start again from the beginning. If an individual Track is looped within the active playlist, using this option will cause the individual Track to keep looping when the playlist gets to that Track.

[edit] Play Once

PlayOneIcon.png

"Play Once" means each track will be played individually one after another in the order in which they are stored in the playlist. When the end of the playlist is reached, it will stop playing. If an individual Track is looped within the active playlist, using this option will cause the individual Track to keep looping when the playlist gets to that Track.

[edit] Shuffle

Shuffle.png

"Shuffle" indicates that the Tracks will be played in a random order. Order is synchronized across clients, so that Tracks will play in the same order for everyone. The playlist will continue playing shuffled until you pause it manually. You should not use looped Tracks with this option or it will just loop the same Track over and over.

Note that the jukebox plays any random track from the playlist and may repeat some tracks before playing others.

[edit] Simulplay

Simulplay.png

"Simulplay" indicates that all Tracks in the playlist will start playing once the playlist is began. Note that it is up to each Track's individual loop settings to determine if it will loop after it plays once. You can mix and match looped and unlooped Tracks with this option.

[edit] Now Playing Widget

The Now Playing Widget appears up at the top of the Jukebox Tab

At the top of the Jukebox is a Now Playing widget. This tool is visible to players in game, but will only display Tracks that are currently playing, and will not display the track's waveform. This is the only 'hint' to the players of what is being played when they tab over to the Jukebox. They don't have access to see the Game Master's entire Jukebox Track list. Pressing "Play" on any given Track will add those Tracks to the widget and GMs can stop their playback directly from this widget.

GMs can click anywhere in the waveform to skip to that spot in the track. Clicking the X will stop the track playback. Click the slider to adjust the volume of the individual track.

[edit] Play on Load

The Play on Load feature on a Page's Settings Window

At the bottom of a Page's Page Settings dialog box, there is a Play on Load drop-down menu. This menu lists every Track and Playlist that you've added to this game's Jukebox. Selecting either Jukebox Track or Playlist will automatically play when you move the players to that page. Note that this only takes effect when a GM moves the Player Ribbon to that page, not for the "Split the Party" feature (since the Jukebox is global, not player-specific).

[edit] Master Volume Control

The Master Volume Control on the My Settings Tab of the Sidebar

In addition to the Game Master's control of the individual track volumes in the Jukebox tab, each person connected to the game can also use the Master Volume Control located under the My Settings tab to control the volume level of all music being played. This slider is located right underneath the Display Name field. This functions exactly like a volume slider on an audio track, where the far left is 0% and the far right is 100% volume.

[edit] API

The u Jukebox is the music player, and some APIs interact with it

Relevant:

[edit] Sidebar

The other tabs in the Sidebar: