| Property | \nValue | \nDescription | \n
|---|---|---|
| type | \n\"once\" or \"repeat\" | \n The type of event to schedule (either one-time or repeating). | \n
| time | \nNumber | \nThe future time in seconds when the scheduled event should occur. | \n
| interval | \nNumber | \n(Only for repeating events) The time interval, in seconds, between repetitions. This option takes precendence over freq if both are provided. | \n
| freq | \nNumber | \n(Only for repeating events) The frequency at which the event should repeat. This option will be overridden by interval if both are provided. | \n
| end | \nNumber | \n(Only for repeating events) The future time in seconds when the scheduled event should stop repeating. | \n
| callback | \nFunction | \nThe function to invoke. | \n
| Property | \nDescription | \nTypes | \n
|---|---|---|
| timeScale | \nThe scheduler's time scale factor. Defaults to 1.0. | \nNumber | \n
| Property | \nDescription | \nTypes | \n
|---|---|---|
| queue | \nThe priority queue used to sort and queue score events. | \nberg.priorityQueue | \n
| Method | \nDescription | \nArgument Types | \nReturns | \n
|---|---|---|---|
| start | \nStarts the scheduler and its clock. | \nnone | \nundefined | \n
| stop | \nStops the scheduler and its clock. | \nnone | \nundefined | \n
| schedule\n | Schedules an event | \nA _score event specification_ object | \nThe scheduled score event specification. | \n
| clear | \nRemoves a scheduled event from the scheduler queue. | \nThe _score event specification_ to clear. | \nundefined | \n
| clearAll | \nRemoves all scheduled events from the scheduler queue. | \nnone | \nundefined | \n
| setTimeScale | \nSets the time scale factor for the scheduler. This will cause all time values for current and future scheduled events to be scaled by the specified value. | \nNumber | \n undefined | \n
| Property | \nDescription | \nTypes | \n
|---|---|---|
| time | \nThe current clock time, in seconds. | \nNumber | \n
| freq | \nThe clock's frequency, in cyles per second. | \nNumber | \n
| tickDuration | \nThe duration between ticks, in seconds. | \nNumber | \n
| Method | \nDescription | \nArgument Types | \nReturns | \n
|---|---|---|---|
| start | \nStarts the clock. | \nnone | \nundefined | \n
| stop | \nStops clock. | \nnone | \nundefined | \n
| tick | \nAdvances the clock's time. (This will be invoked automatically for most clocks.) | \nNone | \nundefined | \n
| Event Name | \nDescription | \nArgument Types | \n
|---|---|---|
| onTick | \nFires each time the clock ticks. | \nNumber time: the current clock time in seconds | \n
| Clock | \nDescription | \nDefault rate | \n
|---|---|---|
berg.clock.requestAnimationFrame | \n A clock that is driven at (or as near as possible to) the display's refresh rate by the browser's built-in requestAnimationFrame function. Note that this clock will be throttled down to\n 1 Hz automatically by the browser if its tab is not active. | \n 60 Hz. You must override this value if your display is running a different refresh rate. | \n
berg.clock.audioContext | \n Uses the Web Audio API's AudioContext as a source of time. This clock\n needs to be driven by your own ScriptProcessorNode code (i.e. by calling its tick() method within your onaudioprocess handler). This clock will not start ticking until its start() method is invoked by a user action (such as a button click). | \n Dynamically determined based on the AudioContext's sampleRate and this clock's blockSize option. | \n
berg.clock.autoAudioContext | \n An AudioContext-based clock that will automatically create a ScriptProcessorNode instance and wire it up correctly for you. Use this if you're not using the Web Audio API directly, but want a rock-solid clock for scheduling events in your application. This clock will not start ticking until its start() method is invoked by a user action (such as a button click). | \n Dynamically determined based on the AudioContext's sampleRate and this clock's blockSize option. | \n
berg.clock.setInterval | \n A clock that is driven by the browser's built-in (and notoriously jittery) setInterval function. Use this if you don't need significant reliability, and want maximal cross-environment compatibility (e.g. with Node.js). Note that this clock will be throttled down automatically\n by the browser if its tab is not active. | \n 10 Hz | \n
berg.clock.workerSetInterval | \n Like berg.clock.setInterval, except that it employs a Web Worker in order to avoid\n the standard throttling done by browsers when the page is in the background. | \n 10 Hz | \n
berg.clock.offline | \n A base grade for creating your own types of clocks.\n An offline clock tracks time relatively (i.e. without reference to a \"real\" source of time\n such as the system clock). This clock should be driven manually by invoking its tick() method. | \n1 Hz | \n
berg.clock.realtime | \n A base grade for creating your own types of clocks.\n A realtime clock tracks time based on the actual system time using,\n by default, performance.now().\n This clock should be driven manually by invoking its tick() method. | \n 1 Hz | \n
npm install -g grunt-cli\n 4. Install Testem: npm install -g testem\n\n\n### How to Build Bergson\n\nTo download all of Bergson's dependencies, build them, and then build Bergson itself, run the following commands:\n\n npm install\n grunt\n\n### Running Bergson's Test Suite\n\nBergson's test suite can be run on both Node.js and all of the browsers installed on your computer using Testem:\n\n npm test\n\nIf you'd like to run only the Node.js tests, run:\n\n npm run node-test\n\nOr if you only want to run the browser tests:\n\n npm run browser-test\n\nAlternatively, if you'd like to only run the tests in one browser, you can open the test suite ``tests/unit/all-tests.html`` file by hand in your browser.\n\nCommunity\n---------\n\nBergson is supported by the Flocking community and uses its forums:\n\n### Mailing List\nThe [Flocking mailing list](http://lists.idrc.ocadu.ca/mailman/listinfo/flocking)\nis the place to ask questions, share code, and request new features.\n\n### Chat\nFlocking has an IRC channel, which can also be used to ask questions about Bergson. Join #flocking on irc.freenode.net.\n\nCredits and License\n-------------------\n\nBergson is written and maintained by Colin Clark. It is dually licensed under the MIT and GPL 2.0 licenses.\n","gitHead":"6728e52d224900c1ec357bc215e1935a10f2d981","_id":"bergson@0.15.0-dev.20190108T045554Z.6728e52.gh-15","_npmVersion":"6.4.1","_nodeVersion":"10.13.0","_npmUser":{"name":"colinbdclark","email":"colinbdclark@gmail.com"},"dist":{"integrity":"sha512-nSCPpA+/Ef5YsAHv/6SV7rI5/atnhQ6Aeo5eW6uikMLHZbj9GTowvctOqRaYS03ZvQszEGSkb7RQQjDt2UCqbg==","shasum":"808ec2a47a10d75904a61b16c1e9e3c27d911ac2","tarball":"https://registry.npmjs.org/bergson/-/bergson-0.15.0-dev.20190108T045554Z.6728e52.gh-15.tgz","fileCount":63,"unpackedSize":1460746,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcNC3VCRA9TVsSAnZWagAA5IIQAIG58EPvk4MXswt1556B\nHoeXdUxzas/qontD7uBnRsWxR8Soa5ONhj7jpKXH3/yBEf3WmJQfQhbCRE2P\nBnPVR6Mj3yWnEME6G8E1Qx4StGbnzNPcp+KvQuP66dyA6rXH6si3HbyJyYl/\nf/JaVBL4xiogalpUGMBgCVTIOQMOSKuUbkYTyKTN1vmTx/o9k5eYFKQ0miTN\nXeun83GlKJLUB0pNIVVoAX+3xpyDiPZbjhaqiCE9Uuvi1gUOf04raZsssUd3\nG9kompdr1NususXE/OzBUUXGCYrnNfbrbWgOD8XkkQSOIjW7oiqvTEIvOE8s\nfertgFdSERGbjw0q3bUWxzIVPo8kmQaW2XCizOQHZD2aIJWFZemx+dvKRvmX\nuu9dpyHw7L3bqWR6QfYrpJ5IG8sE0GpkxGWkNrFoKt5qxwuw/jr/BNbPRT2m\n+MN8/KNgOQBTmxDzX3y28VXaMAvRiCf+i/l0D0/u7HKSEDBwgOa4k97D6BtC\n6FDsfy7WaGSv2T/Ti7+QDJlHTRI37+o0k7zddgJ67N7IUsK5lGAcnBjT1iUd\n+m5zZuyMkKpi8yeww0rEkUiTaeuJXecCkmRIkQJrG+1Bn6v0jEehqMy3I90C\nu0hX/P6HwbGAnW+QMWsRIZkgtDkFHUR5c4ycSSwI/upjpEexY5VlCu81SlkO\naLH2\r\n=9TGk\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD8AT+yR9jI9nc5Zy6bummbdNC2kZ+9WUVpNziY7yOgUgIhAM8gyFZGJN5j0c+Qjgtxq8l9YNZXPvYcKEiKl4EdjJeV"}]},"maintainers":[{"name":"colinbdclark","email":"colinbdclark@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bergson_0.15.0-dev.20190108T045554Z.6728e52.gh-15_1546923477178_0.6292738469902948"},"_hasShrinkwrap":false},"0.14.1":{"name":"bergson","main":"index.js","version":"0.14.1","description":"Time and scheduling for the web","author":{"name":"Colin Clark"},"homepage":"http://github.com/colinbdclark/bergson","repository":{"type":"git","url":"git://github.com/colinbdclark/bergson.git"},"bugs":{"url":"http://github.com/colinbdclark/bergson/issues"},"license":"(MIT OR GPL-2.0)","keywords":["music","audio","video","scheduling"],"devDependencies":{"node-jqunit":"1.1.8","sheep-benchmark":"github:colinbdclark/sheep.js","grunt":"1.0.4","grunt-contrib-clean":"2.0.0","grunt-contrib-concat":"1.0.1","grunt-contrib-uglify":"4.0.1","fluid-grunt-eslint":"18.1.2","testem":"3.0.2"},"dependencies":{"infusion":"3.0.0-dev.20191107T164711Z.332e92c33.FLUID-6148"},"scripts":{"prepare":"grunt","browser-test":"testem ci --file tests/testem.json","node-test":"node tests/node-all-tests.js","test":"npm run node-test && npm run browser-test"},"gitHead":"8ad446da646c8074c2e487bd2f8877a125bfd3c6","_id":"bergson@0.14.1","_npmVersion":"6.4.1","_nodeVersion":"10.15.1","_npmUser":{"name":"colinbdclark","email":"colinbdclark@gmail.com"},"dist":{"integrity":"sha512-Wgt2ILppZH9KYeD1dqyYn+tmUen9t4Q30kLWHUb979MZu2f8SXTBSkbr3IDE4lg7br0x0wFMUeJTiXrtsmrI8w==","shasum":"f0544e78584eb289fddb18ef49ed95c9aced2b69","tarball":"https://registry.npmjs.org/bergson/-/bergson-0.14.1.tgz","fileCount":59,"unpackedSize":1633199,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd8nNaCRA9TVsSAnZWagAAFJ4QAKHq8fTbKO5jpzgn+Igy\nM659XUFCABut5B1P8K57t/Tz/zFzumv5YoAcRxaxgbw6uuF8rOwbLzWqOTET\nCg4S1HZnlsDK6GeG1GBLSc3H1CCbCOmgg95AnytYK+xgE/GDDhuPFFgVho1T\nLkDtP5K2FQB7f31u3GiKX4jFNc2F3zDjsNztxWJ10OZ4LTyb47sK3Tr5loiO\nSBiudcXMeo/A1C7jtSasvSDBNIMve+GkyxT0Ob2u78XvqN3CFrofn3zgg3HR\nX9QVVuApTF1yg/06gEUniWEUJRyCjb5RPbw8R47iClWfN4+cSXDdDc+HPLxL\nFF810m5vu0PRzi9KsbuSYlLbUw5eMQvWEKQgerMjvR63z1oXigCZQIKGrNSI\nRBubHNkoRhWVxlEZxpkFHeaT8t/k8NlMriY04u2Jj0vsW0LVgfsuPuw3Qeot\nUh441Cb8MzxUBTQ6T+7bskclLhBwaPUdU2Fr98ahNJ+2fN356yEpFOG2iTlf\nmwmhr6ZYLwW+s9Om3NzaiFh7qvDiV4UXa+mUzIy+o3NJjpF0lwhyxZj0h+pe\nHtLoIWMgUAQV1N9NGFz3lrkFp6lDAYR2MpMgQe+iTjQ6YaQe+KKbic4WdehH\nD9l/BFfAOlL8Dywrbi3QGDajiHMOmYOIM00vInKOZ5ZsCK437HJqb8AJzLnN\nITeT\r\n=1zsc\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGqFx5waqWDRTR+pYZJ89D2eyMa/SQx+5/0XI1I2rrYkAiEAqxVVTvP4mwBl3sdrqobNk8N4zH3mbllq4VFKw7Bd/FQ="}]},"maintainers":[{"name":"colinbdclark","email":"colinbdclark@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bergson_0.14.1_1576170329835_0.5427308277827543"},"_hasShrinkwrap":false},"0.15.0":{"name":"bergson","main":"index.js","version":"0.15.0","description":"Time and scheduling for the web","author":{"name":"Colin Clark"},"homepage":"http://github.com/colinbdclark/bergson","repository":{"type":"git","url":"git://github.com/colinbdclark/bergson.git"},"bugs":{"url":"http://github.com/colinbdclark/bergson/issues"},"license":"(MIT OR GPL-2.0)","keywords":["music","audio","video","scheduling"],"devDependencies":{"node-jqunit":"1.1.9","sheep-benchmark":"github:colinbdclark/sheep.js","grunt":"1.6.1","grunt-contrib-clean":"2.0.1","grunt-contrib-concat":"2.1.0","grunt-contrib-uglify":"5.2.2","fluid-grunt-eslint":"18.1.2","testem":"3.10.1"},"dependencies":{"infusion":"4.6.0"},"scripts":{"prepare":"npx grunt","browser-test":"npx testem ci --file tests/testem.json","node-test":"node tests/node-all-tests.js","test":"npm run node-test && npm run browser-test"},"gitHead":"c8e1310206c2ecc6ca03811635e72ee24b9accc4","_id":"bergson@0.15.0","_nodeVersion":"16.14.0","_npmVersion":"8.3.0","dist":{"integrity":"sha512-H+g0VG2hkEVeXcpkqMY5UZ1XC6S0nObRScZ9ViYxDKFVxQnsxnFb5Wo/4+hmslKeNudc2Dm5DvhbIwfenZ9M4g==","shasum":"5039d23eeea403fde04661631e9c63ae7e61492e","tarball":"https://registry.npmjs.org/bergson/-/bergson-0.15.0.tgz","fileCount":59,"unpackedSize":1649182,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIB0j1gDCyqIbjt9r/iyJDnRhUfght8MIhXwNJtkFOFsDAiALbTa2UQSmJAlTS7Fv97++fX3dzqP78cleGNdOobnF6w=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj/jwKACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq15BAAkOhX5qkrPyVVGBP7ysv0NNokvDPQiEWdEpf+Golnl0BpbMXd\r\n7adskRgFLjJ/eEr0vXmPyA5f2LUPxcyDH8XHiEEH5Rpn6//6Aqm5T5cmCEXY\r\nFZOoQRXRMGaLCmgmV06AHmO2WmoKRYN7uJRXCJOLAN44frFjuStlnL720Z1V\r\nFBUdycUP0EJhIeFYP8iCl5Rmc6jFUTQiMlUpk4ZJnlBAoqu32cdAP/SLEFBr\r\nGDmkzo5LGZhIfXz8ypQz6eGjyN95EPyou/vW37HGhsVaSRlBqVIG3Lg53fRu\r\n29y4KD+C0ogXf0+4hHj329UbxzmmWrDD744ae5LQEE46XTPKbD94SqyNEn3v\r\nLs0SvBkOCI5ZXiODwTEm+6mQO87gDrYvSAQ7GFRKvKz8vh+LwUpYbICJZAl5\r\nOgNhrD4V80Dv4kQ6u93R/SLMP29mhjx0XmzULwjKW7kt/gWOv2dN/MlAoC18\r\nl/kvaUCeMhQqdUkD9L2/Y5p82N7WS4BEjTcqVCu8KOMg49yev/dg1ADk53wO\r\nAEOOxyRww2xECAVW6vVYpRoHmeF/ONEjnQAB1j2t8MSxBrw+lIt/NGrIO7ba\r\noRFi5ZVs9r8OjL+gbl0nUQsXKUYR5Z/eC+1GPpZfFFh7SQlgZ68Rqr6vJUtz\r\noAUzbWifIFZTBWEMItWav8zvwVvqiICVbEw=\r\n=s2d5\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"colinbdclark","email":"colinbdclark@gmail.com"},"directories":{},"maintainers":[{"name":"colinbdclark","email":"colinbdclark@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bergson_0.15.0_1677605898527_0.5291648760806891"},"_hasShrinkwrap":false},"0.16.0":{"name":"bergson","main":"index.js","version":"0.16.0","description":"Time and scheduling for the web","author":{"name":"Colin Clark"},"homepage":"http://github.com/colinbdclark/bergson","repository":{"type":"git","url":"git://github.com/colinbdclark/bergson.git"},"bugs":{"url":"http://github.com/colinbdclark/bergson/issues"},"license":"(MIT OR GPL-2.0)","keywords":["music","audio","video","scheduling"],"devDependencies":{"node-jqunit":"1.1.9","sheep-benchmark":"github:colinbdclark/sheep.js","grunt":"1.6.1","grunt-contrib-clean":"2.0.1","grunt-contrib-concat":"2.1.0","grunt-contrib-uglify":"5.2.2","fluid-grunt-eslint":"18.1.2","testem":"3.10.1"},"dependencies":{"infusion":"4.6.0"},"scripts":{"prepare":"npx grunt","browser-core-test":"npx testem ci --file tests/testem.json","webaudio-test":"npx testem ci --file tests/testem-webaudio.json","node-test":"node tests/node-all-tests.js","test":"npm run node-test && npm run webaudio-test && npm run browser-core-test"},"gitHead":"5a5947d4f7f840216b6294a87c45c9aca50a28f5","_id":"bergson@0.16.0","_nodeVersion":"16.14.0","_npmVersion":"8.3.0","dist":{"integrity":"sha512-2WJbVN2y7GRuBTVHp+yl0XqTncCVyprXrtqs9CjJJTkbZcO5vB8LKvq7zJaI/p1WRdgzNm1OOjZ5pRYE38b5Rw==","shasum":"78b016190694747e387d97c0136ca397b556df0b","tarball":"https://registry.npmjs.org/bergson/-/bergson-0.16.0.tgz","fileCount":62,"unpackedSize":1655624,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDeMEB4QaBSAvYlUC0P9tOQER09HyhCGVy7sa19e4bdKwIhAP7b5a2d5Feg4gxwHqh5Vmx9bNRUyB2ePz5UyBbfacQk"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkB3AqACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqDtg//bCy+wvUpaorpFAiZaYC2MFbosgvWqBWXXGKXrdcmzRBOedru\r\nBdc6r6QqG7Uue7e/XcKXJnTH7OLPX3szT88hH00283EqILpjrsahPP3kSd3R\r\nVJ6xBMWs2Ek9CjeqQtnoKn7OqEIEfpqFHe4uZOjeGO2Qvapcd/Z8G/pAQNp3\r\nxa8GNBQLLmgEGZyLIVqVOVmiwNwKPfo65eZ7LASMrC1RwiH1IwLOCb33TeYL\r\nbzIbArGYENW6ryBIr6Y+VwFL/pRXayPEKKggQkzjnT7t+ZTOnCY0iaJA3zt+\r\nfVuzdj9A73S/2qYN/5a+Hw8m7I5JhFAXsP2rA1XnQVkHHNtDmcNDSpK9fKS3\r\nYb7ahYDJJHCm0foNs29d3Fn5hiRlrC/ryGrMbL/5VQKSlVCzzqFr4apAHZZd\r\nJcFvmLfu0B1PRDn9Dor+EaVo9qzWaQ54QfheC/JBC5pk5WQsKDlFnRiG7Vrm\r\nuxNdT3UnXB/OmEzTmIzSWGhY878/p3qmISETO6qIqN1TwKw5yffMW2Kxqls7\r\n+MRAEgWxT6SCKfGnv2z5GmaeFcyM68+OzAp8aDIWy4EcGq4SIOeV42SE9S7t\r\nIWcw7YnDqg15i5LZ3VqpTboshF32L6hyZ9R/GRtt5xnm/nuo5E6ar7FnPdS+\r\nZvHa1m7W9bsSbGGlViHduOrSGWOY65LjW2Y=\r\n=NQAE\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"colinbdclark","email":"colinbdclark@gmail.com"},"directories":{},"maintainers":[{"name":"colinbdclark","email":"colinbdclark@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bergson_0.16.0_1678209065992_0.3719663127140005"},"_hasShrinkwrap":false}},"readme":"Bergson\n=======\n\nWhat is Bergson?\n----------------\n\nBergson is the scheduling system for [Flocking](https://github.com/colinbdclark/Flocking) and [Aconite](https://github.com/colinbdclark/aconite). It provides a variety of clocks driven by different\nsources (such as requestAnimationFrame, the Web Audio API, and setInterval), and a priority queue-based\nscheduler that allows you to queue up one-time and repeating function calls.\n\nBergson provides a very low-level API for scheduling, and is intended for library developers to build\ntheir own rhythmic and pattern-based abstractions on top of.\n\nExamples\n--------\n\n### Creating a Scheduler with the requestAnimationFrame Clock ###\n\n var scheduler = berg.scheduler({\n components: {\n clock: {\n type: \"berg.clock.requestAnimationFrame\",\n options: {\n freq: 60\n }\n }\n }\n });\n\n scheduler.start();\n\n### Scheduling one-time events ###\n\n scheduler.schedule({\n type: \"once\",\n time: 30 // 30 seconds from now\n callback: function (now) {\n // Do something in the future.\n }\n });\n\n### Scheduling repeating events ###\n\n scheduler.schedule({\n type: \"repeat\",\n time: 5, // Start repeating five seconds from now.\n freq: 2, // Repeat every two seconds.\n end: 20, // Stop repeating 20 seconds from now.\n callback: function (now) {\n // Do something repeatedly.\n }\n });\n\n### Listening for Clock Events Directly ###\n\n scheduler.clock.events.onTick.addListener(function (time, rate) {\n // Do something every time the clock ticks.\n });\n\n\nBergson API\n-------------\n\n### Scheduler API ###\n\n#### Score Event Specifications ####\n\nA _score event specification_ is a JSON-type (i.e. plain old, non-prototypal) object that describes the event to be scheduled. It can contain the following properties.\n\n| Property | \nValue | \nDescription | \n
|---|---|---|
| type | \n\"once\" or \"repeat\" | \n The type of event to schedule (either one-time or repeating). | \n
| time | \nNumber | \nThe future time in seconds when the scheduled event should occur. | \n
| interval | \nNumber | \n(Only for repeating events) The time interval, in seconds, between repetitions. This option takes precendence over freq if both are provided. | \n
| freq | \nNumber | \n(Only for repeating events) The frequency at which the event should repeat. This option will be overridden by interval if both are provided. | \n
| end | \nNumber | \n(Only for repeating events) The future time in seconds when the scheduled event should stop repeating. | \n
| callback | \nFunction | \nThe function to invoke. | \n
| Property | \nDescription | \nTypes | \n
|---|---|---|
| timeScale | \nThe scheduler's time scale factor. Defaults to 1.0. | \nNumber | \n
| Property | \nDescription | \nTypes | \n
|---|---|---|
| queue | \nThe priority queue used to sort and queue score events. | \nberg.priorityQueue | \n
| Method | \nDescription | \nArgument Types | \nReturns | \n
|---|---|---|---|
| start | \nStarts the scheduler and its clock. | \nnone | \nundefined | \n
| stop | \nStops the scheduler and its clock. | \nnone | \nundefined | \n
| schedule\n | Schedules an event | \nA _score event specification_ object | \nThe scheduled score event specification. | \n
| clear | \nRemoves a scheduled event from the scheduler queue. | \nThe _score event specification_ to clear. | \nundefined | \n
| clearAll | \nRemoves all scheduled events from the scheduler queue. | \nnone | \nundefined | \n
| setTimeScale | \nSets the time scale factor for the scheduler. This will cause all time values for current and future scheduled events to be scaled by the specified value. | \nNumber | \n undefined | \n
| Property | \nDescription | \nTypes | \n
|---|---|---|
| time | \nThe current clock time, in seconds. | \nNumber | \n
| freq | \nThe clock's frequency, in cyles per second. | \nNumber | \n
| tickDuration | \nThe duration between ticks, in seconds. | \nNumber | \n
| Method | \nDescription | \nArgument Types | \nReturns | \n
|---|---|---|---|
| start | \nStarts the clock. | \nnone | \nundefined | \n
| stop | \nStops clock. | \nnone | \nundefined | \n
| tick | \nAdvances the clock's time. (This will be invoked automatically for most clocks.) | \nNone | \nundefined | \n
| Event Name | \nDescription | \nArgument Types | \n
|---|---|---|
| onTick | \nFires each time the clock ticks. | \nNumber time: the current clock time in seconds | \n
| Clock | \nDescription | \nDefault rate | \n
|---|---|---|
berg.clock.requestAnimationFrame | \n A clock that is driven at (or as near as possible to) the display's refresh rate by the browser's built-in requestAnimationFrame function. Note that this clock will be throttled down to\n 1 Hz automatically by the browser if its tab is not active. | \n 60 Hz. You must override this value if your display is running a different refresh rate. | \n
berg.clock.audioContext | \n Uses the Web Audio API's AudioContext as a source of time. This clock\n needs to be driven by your own ScriptProcessorNode code (i.e. by calling its tick() method within your onaudioprocess handler). This clock will not start ticking until its start() method is invoked by a user action (such as a button click). | \n Dynamically determined based on the AudioContext's sampleRate and this clock's blockSize option. | \n
berg.clock.autoAudioContext | \n An AudioContext-based clock that will automatically create a ScriptProcessorNode instance and wire it up correctly for you. Use this if you're not using the Web Audio API directly, but want a rock-solid clock for scheduling events in your application. This clock will not start ticking until its start() method is invoked by a user action (such as a button click). | \n Dynamically determined based on the AudioContext's sampleRate and this clock's blockSize option. | \n
berg.clock.setInterval | \n A clock that is driven by the browser's built-in (and notoriously jittery) setInterval function. Use this if you don't need significant reliability, and want maximal cross-environment compatibility (e.g. with Node.js). Note that this clock will be throttled down automatically\n by the browser if its tab is not active. | \n 10 Hz | \n
berg.clock.workerSetInterval | \n Like berg.clock.setInterval, except that it employs a Web Worker in order to avoid\n the standard throttling done by browsers when the page is in the background. | \n 10 Hz | \n
berg.clock.offline | \n A base grade for creating your own types of clocks.\n An offline clock tracks time relatively (i.e. without reference to a \"real\" source of time\n such as the system clock). This clock should be driven manually by invoking its tick() method. | \n1 Hz | \n
berg.clock.realtime | \n A base grade for creating your own types of clocks.\n A realtime clock tracks time based on the actual system time using,\n by default, performance.now().\n This clock should be driven manually by invoking its tick() method. | \n 1 Hz | \n
npm install -g grunt-cli\n 4. Install Testem: npm install -g testem\n\n\n### How to Build Bergson\n\nTo download all of Bergson's dependencies, build them, and then build Bergson itself, run the following commands:\n\n npm install\n grunt\n\n### Running Bergson's Test Suite\n\nBergson's test suite can be run on both Node.js and all of the browsers installed on your computer using Testem:\n\n npm test\n\nIf you'd like to run only the Node.js tests, run:\n\n npm run node-test\n\nOr if you only want to run the browser tests:\n\n npm run browser-test\n\nAlternatively, if you'd like to only run the tests in one browser, you can open the test suite ``tests/unit/all-tests.html`` file by hand in your browser.\n\nCommunity\n---------\n\nBergson is supported by the Flocking community and uses its forums:\n\n### Mailing List\nThe [Flocking mailing list](http://lists.idrc.ocadu.ca/mailman/listinfo/flocking)\nis the place to ask questions, share code, and request new features.\n\n### Chat\nFlocking has an IRC channel, which can also be used to ask questions about Bergson. Join #flocking on irc.freenode.net.\n\nCredits and License\n-------------------\n\nBergson is written and maintained by Colin Clark. It is dually licensed under the MIT and GPL 2.0 licenses.\n","maintainers":[{"name":"colinbdclark","email":"colinbdclark@gmail.com"}],"time":{"modified":"2023-03-07T17:11:06.331Z","created":"2015-07-21T23:18:09.416Z","0.9.0":"2015-07-21T23:18:09.416Z","0.9.1":"2015-08-06T00:05:43.611Z","0.9.2":"2015-08-11T22:29:28.712Z","0.9.3":"2015-08-18T18:27:09.140Z","0.9.4":"2015-08-18T18:39:12.173Z","0.10.0":"2015-10-09T04:05:57.431Z","0.10.1":"2015-10-25T00:01:57.416Z","0.11.0":"2015-10-25T00:47:03.220Z","0.11.1":"2015-12-07T01:32:44.515Z","0.12.0":"2016-03-13T20:24:47.655Z","0.12.1":"2016-03-13T21:28:05.144Z","0.12.2":"2016-08-31T00:27:49.077Z","0.12.3":"2016-08-31T00:42:59.612Z","0.13.0":"2016-12-15T03:00:51.495Z","0.12.4":"2017-11-14T03:29:16.004Z","0.13.1":"2017-11-14T03:34:58.553Z","0.13.2":"2018-07-31T04:19:29.101Z","0.14.0":"2019-01-04T20:14:36.956Z","0.15.0-dev.20190108T045554Z.6728e52.gh-15":"2019-01-08T04:57:57.402Z","0.14.1":"2019-12-12T17:05:30.038Z","0.15.0":"2023-02-28T17:38:18.734Z","0.16.0":"2023-03-07T17:11:06.217Z"},"homepage":"http://github.com/colinbdclark/bergson","keywords":["music","audio","video","scheduling"],"repository":{"type":"git","url":"git://github.com/colinbdclark/bergson.git"},"author":{"name":"Colin Clark"},"bugs":{"url":"http://github.com/colinbdclark/bergson/issues"},"license":"(MIT OR GPL-2.0)","readmeFilename":"README.md"}