Скачать osc js - скачать исходный код osc js

osc js

Другие категории

v2.4.1

Скачать

оск-js

osc-js — это библиотека Open Sound Control для приложений JavaScript (модуль UMD для узла, браузера и т. д.) с сопоставлением шаблонов адресов и обработкой временных меток. Отправляет сообщения через UDP , WebSocket или оба (режим моста) и предлагает настраиваемый API-интерфейс плагина для сетевых протоколов.

Вики | Основное использование | Документация | API плагина

Функции

Модуль UMD, работающий в Node.js, Electron, приложениях Chrome, браузере или любой другой среде JS.
Может использоваться с Webpack и Browserify.
Определения TypeScript
Никаких зависимостей (кроме ws в Node.js или аналогичных средах)
Получать информацию об отправителе из входящих сообщений
Встроенная поддержка сетей UDP и WebSocket в виде плагинов.
Специальный плагин моста для удобной связи между UDP- и WebSocket- клиентами.
Плагин API для пользовательских сетевых протоколов
Обладает всеми спецификациями OSC 1.0.
Соответствие шаблону адреса OSC
Критически важные по времени пакеты OSC с временными метками
Расширенные (нестандартные) типы аргументов

Документация

Узнайте больше о osc-js и о том, как его использовать, в Wiki и документации.

Пример

 const osc = new OSC ( )

osc . on ( '/param/density' , ( message , rinfo ) => {
  console . log ( message . args )
  console . log ( rinfo )
} )

osc . on ( '*' , message => {
  console . log ( message . args )
} )

osc . on ( '/{foo,bar}/*/param' , message => {
  console . log ( message . args )
} )

osc . on ( 'open' , ( ) => {
  const message = new OSC . Message ( '/test' , 12.221 , 'hello' )
  osc . send ( message )
} )

osc . open ( { port : 9000 } )

Установка и использование

Рекомендуемая установка через npm: npm i osc-js или yarn add osc-js .

Импортируйте библиотеку const OSC = require('osc-js') или добавьте скрипт lib/osc.js или lib/osc.min.js (мини-версия) для использования в браузере.

Плагины

osc-js предлагает архитектуру плагинов для расширения сетевых возможностей. Библиотека поставляется с четырьмя встроенными плагинами. Вероятно, это все, что вам нужно для приложения OSC:

WebsocketClientPlugin (по умолчанию)
WebsocketServerPlugin
DatagramPlugin для обмена сетевыми сообщениями UDP
Полезный BridgePlugin Мост между клиентами WebSocket и UDP

Конфигурацию и примеры каждого плагина можно прочитать здесь: Wiki.

Пример: сервер WebSocket.

Зарегистрируйте плагин при создании экземпляра OSC:

 const osc = new OSC ( { plugin : new OSC . WebsocketServerPlugin ( ) } )
osc . open ( ) // listening on 'ws://localhost:8080'

Пример: OSC между MaxMSP/PD/SC и т. д. и вашим браузером.

Напишите простую веб-страницу. По умолчанию библиотека будет использовать клиент WebSocket.

 < button id =" send " > Send Message </ button >
< script type =" text/javascript " src =" lib/osc.min.js " > </ script >
< script type =" text/javascript " >
  var osc = new OSC ( ) ;
  osc . open ( ) ; // connect by default to ws://localhost:8080

  document . getElementById ( 'send' ) . addEventListener ( 'click' , ( ) => {
    var message = new OSC . Message ( '/test/random' , Math . random ( ) ) ;
    osc . send ( message ) ;
  } ) ;
</ script >

Напишите приложение Node («мост» между вашими клиентами UDP и WebSocket).

 const OSC = require ( 'osc-js' )

const config = { udpClient : { port : 9129 } }
const osc = new OSC ( { plugin : new OSC . BridgePlugin ( config ) } )

osc . open ( ) // start a WebSocket server on port 8080

Создайте свой патч Max/MSP (или PD, SuperCollider и т. д.).

 [udpreceive 9129] // incoming '/test/random' messages with random number

Индивидуальные решения с API плагинов

Можно написать более сложные решения для приложений OSC, не теряя при этом интерфейса osc-js (включая обработку сообщений и т. д.). Прочтите документацию по API плагинов для получения дополнительной информации.

 class MyCustomPlugin {
  // ... read docs for implementation details
}

const osc = new OSC ( { plugin : MyCustomPlugin ( ) } )
osc . open ( )

osc . on ( '/test' , message => {
  // use event listener with your plugin
} )

Использование без плагинов

Библиотеку можно использовать без упомянутых функций, если вам необходимо записывать и читать двоичные данные OSC. См. этот пример ниже для использования низкоуровневого API (хотя в библиотеке уже есть решение для обработки UDP, как в этом примере):

 const dgram = require ( 'dgram' )
const OSC = require ( 'osc-js' )

const socket = dgram . createSocket ( 'udp4' )

// send a messsage via udp
const message = new OSC . Message ( '/some/path' , 21 )
const binary = message . pack ( )
socket . send ( new Buffer ( binary ) , 0 , binary . byteLength , 41234 , 'localhost' )

// receive a message via UDP
socket . on ( 'message' , data => {
  const msg = new OSC . Message ( )
  msg . unpack ( data )
  console . log ( msg . args )
} )

Разработка

osc-js использует Babel для поддержки ES6, ESDoc для документации, Mocha + Chai для тестирования и Rollup для создания модуля UMD.

Клонируйте репозиторий и установите все зависимости:

 git clone [email protected]:adzialocha/osc-js.git
cd osc-js
npm install

Тестирование

npm run test для запуска тестов. npm run test:watch за выполнением спецификаций во время разработки. Проверьте стиль кода с помощью npm run lint .