Differences

This shows you the differences between two versions of the page.

--- class-player [2022/03/14 01:09] – created renick
+++ class-player [2023/11/24 19:14] (current) – steve.wang
@@ Line 1: / Line 1: @@
 ====== class: Player ======
-===== Description =====
+<markdown>
+### Players
+Players are processes that can be started or stopped using the metaphor of a player in a musical ensemble like a band or orchestra.
-===== Constructor =====
+Players are data structures to represent an agent which carries out Action functions in time according to an IOI function.
-===== Static Properties =====
+Players can be used for a single or multiple outputs. Anything that can be manipulated with a JavaScript function call can be an output. Actions for the SuperDirt sampler and MIDI are included in the distribution.
-===== Static Methods =====
+By starting and stopping Players, a performance can be realized.
-===== Instance Properties =====
-===== Instance Methods =====
+##### Syntax
+```
+new Player(name)
+```
-===== Examples =====
+##### Parameters
+###### name
+Name of the player. This will also be the value of the name variable in the player.
+##### Examples
+```
+e.players.testPlayer = new Player('testPlayer')
+e.players.testPlayer.maskMap = 'default'
+e.players.testPlayer.action = 'midiSequencedRhythm'
+e.players.testPlayer.rhythmMap = 'default'
+console.log(e.palyers.testPlayer)
+```
+This class is usually called by helper functions like setupMidiRhythm or setupPlaybackPlayer. To make the the player work, the user needs to give it a maskMap, action function and, a rhythmMap.
+---
+---
+### NOTE
+The things stored in side the player are just instructions of where to look for the actual information so that the information is not tied to player. Any player will be able to choose which information to use.
+</markdown>