osc js

osc-js

osc-js 是一个用于 JavaScript 应用程序的开放声音控制库（用于节点、浏览器等的 UMD 模块），具有地址模式匹配和时间标签处理功能。通过UDP 、 WebSocket或两者（桥接模式）发送消息，并为网络协议提供可定制的插件 API。

维基 |基本用法 |文档 |插件API

特征

• 在 Node.js、Electron、Chrome Apps、浏览器或任何其他 JS 环境中运行的 UMD 模块
• 可以与 Webpack 和 Browserify 一起使用
• TypeScript 定义
• 无依赖项（Node.js 或类似环境中的ws除外）
• 从传入消息中接收发件人信息
• 内置UDP 、 WebSocket网络支持作为插件
• 特殊的桥接插件，可轻松实现UDP和WebSocket客户端之间的通信
• 用于自定义网络协议的插件 API
• 具有所有 OSC 1.0 规格
• OSC 地址模式匹配
• 具有时间标签的时间关键型 OSC 捆绑包
• 扩展（非标准）参数类型

文档

在 Wiki 和文档中了解有关 osc-js 以及如何使用它的更多信息。

例子

 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
• 用于 UDP 网络消息传递的DatagramPlugin
• BridgePlugin是 WebSocket 和 UDP 客户端之间有用的桥梁

每个插件的配置和示例可以在这里阅读：Wiki。

示例：WebSocket 服务器

创建OSC实例时注册插件：

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

示例：MaxMSP/PD/SC 等与您的浏览器之间的 OSC

1. 写一个简单的网页。默认情况下，该库将使用 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 >

2. 编写一个 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

3. 创建您的 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检查代码风格。

部署

npm run build用于导出lib文件夹中的 UMD 模块。

贡献者

• @adzialocha
• @大卫格兰斯特罗姆
• @埃尔吉亚诺
• @艾略特阿基拉
• @JacobMuchow
• @彼得基
• @亚旭
• @yojeek

ES文档

npm run docs用于生成一个docs文件夹，其中包含记录库的 HTML 文件。在这里在线阅读它们：https://adzialocha.github.io/osc-js

执照

麻省理工MIT许可证