Baixar osc js - baixar o código-fonte osc js

osc js

Outras categorias

v2.4.1

Baixar

osc-js

osc-js é uma biblioteca Open Sound Control para aplicativos JavaScript (módulo UMD para Node, Browser etc.) com correspondência de padrão de endereço e manipulação de timetag. Envia mensagens via UDP , WebSocket ou ambos (modo bridge) e oferece uma API de plug-in personalizável para protocolos de rede.

Wiki | Uso Básico | Documentação | API de plug-in

Características

Módulo UMD em execução em Node.js, Electron, Chrome Apps, navegador ou qualquer outro ambiente JS
Pode ser usado com Webpack e Browserify
Definições de TypeScript
Sem dependências (exceto ws em Node.js ou ambientes semelhantes)
Receba informações do remetente de mensagens recebidas
UDP integrado e suporte de rede WebSocket como plug-ins
Plugin de ponte especial para fácil comunicação entre clientes UDP e WebSocket
API de plug-in para protocolos de rede personalizados
Apresentando todas as especificações OSC 1.0
Correspondência de padrão de endereço OSC
Pacotes OSC urgentes com timetags
Tipos de argumentos estendidos (não padrão)

Documentação

Leia mais sobre osc-js e como usá-lo no Wiki e na Documentação.

Exemplo

 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 } )

Instalação e uso

Instalação recomendada via npm: npm i osc-js ou yarn add osc-js .

Importe a biblioteca const OSC = require('osc-js') ou adicione o script lib/osc.js ou lib/osc.min.js (versão reduzida) para uso em um navegador.

Plug-ins

osc-js oferece uma arquitetura de plugin para estender seus recursos de rede. A biblioteca vem com quatro plug-ins integrados. Provavelmente, isso é tudo que você precisa para um aplicativo OSC:

WebsocketClientPlugin (padrão)
WebsocketServerPlugin
DatagramPlugin para mensagens de rede UDP
BridgePlugin útil Ponte entre clientes WebSocket e UDP

Configuração e exemplos de cada plugin podem ser lidos aqui: Wiki.

Exemplo: Servidor WebSocket

Registre o plugin ao criar a instância do OSC:

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

Exemplo: OSC entre MaxMSP/PD/SC etc. e seu navegador

Escreva uma página da web simples. A biblioteca usará um cliente WebSocket por padrão.

 < 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 >

Escreva um aplicativo Node (a "ponte" entre seus clientes UDP e 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

Crie seu patch Max/MSP (ou PD, SuperCollider etc.).

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

Soluções personalizadas com Plugin API

É possível escrever soluções mais sofisticadas para aplicações OSC sem perder a interface osc-js (incluindo o tratamento de mensagens, etc.). Leia a documentação da API do plug-in para obter mais informações.

 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
} )

Uso sem plug-ins

A biblioteca pode ser usada sem os recursos mencionados caso você precise escrever e ler dados binários OSC. Veja este exemplo abaixo para usar a API de baixo nível (mesmo que a biblioteca já tenha uma solução para lidar com UDP como neste exemplo):

 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 )
} )

Desenvolvimento

osc-js usa Babel para suporte ES6, ESDoc para documentação, Mocha + Chai para testes e Rollup para gerar o módulo UMD.

Clone o repositório e instale todas as dependências:

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

Teste

npm run test para executar os testes. npm run test:watch as especificações de execução durante o desenvolvimento. Verifique o estilo do código com npm run lint .