diff --git a/tutorials/MappingDemonstration.html b/tutorials/MappingDemonstration.html index 1c18827..1abc720 100644 --- a/tutorials/MappingDemonstration.html +++ b/tutorials/MappingDemonstration.html @@ -3,7 +3,7 @@
Here we will show off some of the mappings currently in the library. This list may not be exhaustive, and you should check the actual documentation for all the mapping modules. Additionally, feel free to create your own mappings using the provided support tools!
One of the most basic principles behind AudioShowKit is the {@link MusicPlayer}. The song player acts as an easy way for developers to set up a list of songs with simple generated controls while exposing more complex events if needed.
Instantiating a music player requires a {@link MusicPlaylist}. See the [MusicPlaylist tutorial]{@tutorial MusicPlaylist} for information on how to get one of those! Once you have one, you can proceed with instantiating a Music Player.
const ask = window.audioshowkit; // Get a reference to the audioshowkit stuff.
@@ -16,14 +16,14 @@
We need some user interactive element to start playing music. You can set this up yourself, or use a generated one by us! We'll show you how to do the latter, but feel free to read the documentation on all the methods available that can be used in event listeners to see how to do the former.
// Still using the same context from the instantiation example...
const playElement = player.generatePlayElement();
document.getElementById("musicplayer-playbtn-demo").appendChild(playElement); // Assuming this element exists.
- Go ahead and hit the play button!
We can also traverse the playlist by the player via a previous and next button. These buttons can be generated as well as programmed.
// Still using the same context from the instantiation example...
@@ -41,7 +41,7 @@
const prevElem = player.generatePreviousElement();
document.getElementById("musicplayer-nav-demo").appendChild(prevElem);
- Feel free to try the buttons and see what happens! We'll show the playlist display demonstrated in the [MusicPlaylist tutorial]{@tutorial MusicPlaylist}.
A music playlist is a list of {@link Music} which maintains metadata about the playlist, such as the length, and the name of the playlist. It also keeps track of an index for a position in the playlist.
Instantiation is simple. We grab a reference to the audioshowkit library from global, and then under the "player" path, we find the music playlist constructor.
// Get the entry point to all of AudioShowKit's glory.
@@ -20,7 +20,7 @@
A music playlist is no good if it doesn't have music. Lets add some.
// Still using the same context from the instantiation example...
@@ -39,7 +39,7 @@
In the case you want to show the playlist without coding your own display, we provide a simple generator for you!
// Still using the same context from the instantiation example...
diff --git a/tutorials/VisMusicPlayer.html b/tutorials/VisMusicPlayer.html
index 743c079..2ad3195 100644
--- a/tutorials/VisMusicPlayer.html
+++ b/tutorials/VisMusicPlayer.html
@@ -3,7 +3,7 @@
- Visualizing Music
+ Visualizing Music
This is the fun part. We can use a {@link VisualizedMusicPlayer} and a {@link MusicPlaylist} to create a music player that is like {@link MusicPlayer} but with the ability to automatically fetch the current {@link Visualizer}. On top of that, it then routes that visualizer data to {@link VisualizerUpdateManager} which can be to make much more refined mappings.
This library comes with a variety of mapping tools:
@@ -14,7 +14,7 @@
- Instantiation
+ Instantiation
Exactly like when instantiating a normal music player, you will need a playlist. Other than that, it's simple.
const ask = window.audioshowkit; // Get a reference to the audioshowkit stuff.
@@ -23,7 +23,7 @@
- Playback
+ Playback
Since the usage of playback is the same as a normal {@link module:player/MusicPlayer}, see [the MusicPlayer tutorial]{@tutorial MusicPlayer} for more information. We also added the playlist display to show you which song you're listening to.
@@ -33,7 +33,7 @@
- Visualization
+ Visualization
The actual visualization can be performed in a variety of ways. We can use canvases, or even better, actual HTML elements! We'll demonstrate an example of the latter below, but check out [the Mapping Demonstration tutorial]{@tutorial MappingDemonstration} for many other mappings! Hit the play button to see the what the mapping did.