osc js

osc-js

osc-js adalah pustaka Kontrol Suara Terbuka untuk aplikasi JavaScript (modul UMD untuk Node, Browser, dll.) dengan pencocokan pola alamat dan penanganan tag waktu. Mengirim pesan melalui UDP , WebSocket atau keduanya (mode jembatan) dan menawarkan API Plugin yang dapat disesuaikan untuk protokol jaringan.

Wiki | Penggunaan Dasar | Dokumentasi | API Pengaya

Fitur

• Modul UMD berjalan di Node.js, Electron, Aplikasi Chrome, browser, atau lingkungan JS lainnya
• Dapat digunakan dengan Webpack dan Browserify
• Definisi TypeScript
• Tidak ada ketergantungan (kecuali ws di Node.js atau lingkungan serupa)
• Menerima informasi pengirim dari pesan masuk
• UDP bawaan, dukungan jaringan WebSocket sebagai plugin
• Plugin jembatan khusus untuk memudahkan komunikasi antara klien UDP - dan WebSocket
• Plugin API untuk protokol jaringan khusus
• Menampilkan semua spesifikasi OSC 1.0
• Pencocokan pola Alamat OSC
• Bundel OSC yang kritis terhadap waktu dengan Timetag
• Tipe argumen yang diperluas (tidak standar).

Dokumentasi

Baca selengkapnya tentang osc-js dan cara menggunakannya di Wiki dan Dokumentasi.

Contoh

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

Instalasi dan Penggunaan

Instalasi yang disarankan melalui npm: npm i osc-js atau yarn add osc-js .

Impor perpustakaan const OSC = require('osc-js') atau tambahkan skrip lib/osc.js atau lib/osc.min.js (versi yang diperkecil) untuk digunakan di browser.

Plugin

osc-js menawarkan arsitektur plugin untuk memperluas kemampuan jaringannya. Perpustakaan dilengkapi dengan empat plugin bawaan. Ini mungkin yang Anda perlukan untuk aplikasi OSC:

• WebsocketClientPlugin (default)
• WebsocketServerPlugin
• DatagramPlugin untuk perpesanan jaringan UDP
• BridgePlugin berguna Menjembatani antara Klien WebSocket dan UDP

Konfigurasi dan contoh setiap plugin dapat dibaca di sini: Wiki.

Contoh: Server WebSocket

Daftarkan plugin saat membuat instance OSC:

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

Contoh: OSC antara MaxMSP/PD/SC dll dan browser Anda

1. Tulis halaman web sederhana. Perpustakaan akan menggunakan klien WebSocket secara default.

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

2. Tulis aplikasi Node ("jembatan" antara klien UDP dan WebSocket Anda).

 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

3. Buat patch Max/MSP Anda (atau PD, SuperCollider, dll.).

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

Solusi khusus dengan Plugin API

Dimungkinkan untuk menulis solusi yang lebih canggih untuk aplikasi OSC tanpa kehilangan antarmuka osc-js (termasuk penanganan pesannya, dll.). Baca dokumentasi Plugin API untuk informasi lebih lanjut.

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

Penggunaan tanpa plugin

Pustaka dapat digunakan tanpa fitur yang disebutkan jika Anda perlu menulis dan membaca data OSC biner. Lihat contoh di bawah ini untuk menggunakan API Tingkat Rendah (walaupun perpustakaan sudah memiliki solusi untuk menangani UDP seperti pada contoh ini):

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

Perkembangan

osc-js menggunakan Babel untuk dukungan ES6, ESDoc untuk dokumentasi, Mocha + Chai untuk pengujian dan Rollup untuk menghasilkan modul UMD.

Kloning repositori dan instal semua dependensi:

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

Pengujian

npm run test untuk menjalankan tes. npm run test:watch spesifikasi yang berjalan selama pengembangan. Periksa gaya kode dengan npm run lint .

Penyebaran

npm run build untuk mengekspor modul UMD di folder lib .

Kontributor

• @adzialocha
• @davidgranstrom
• @elgiano
• @eliot-akira
• @JacobMuchow
• @PeterKey
• @yaxu
• @yojeek

ESDokumen

npm run docs untuk membuat folder docs dengan file HTML yang mendokumentasikan perpustakaan. Baca secara online di sini: https://adzialocha.github.io/osc-js

Lisensi

Lisensi MIT MIT