package osc

  1. Overview
  2. Docs
OpenSoundControl core library

Install

Dune Dependency

Authors

Maintainers

Sources

osc.0.2.0.tar.gz
sha256=920640b4c6b4fe65dfb7e99733717b260ae072de530ce94b52d1e76dc3b46a0a

Description

Library containing types for representing OpenSoundControl messages, as well as functions for converting OpenSoundControl messages to and from strings.

Published: 06 Feb 2022

README

ocaml-osc

Pure OCaml implementation of the Open Sound Control protocol.

Dependencies:

Usage

If you just need to parse and serialise OSC packets, use the Osc.Codec module:

# require "osc";;

# open Osc.Types;;

# let data = Osc.Codec.of_packet (Message {address = "/hello/world"; arguments = [Int32 123l; String "foo"]});;
val data : bytes = "/hello/world\000\000\000\000,is\000\000\000\000{foo\000"

# let packet = Osc.Codec.to_packet data;;
val packet : (packet, [ `Missing_typetag_string | `Unsupported_typetag of char ]) Rresult.result =
  Rresult.Ok (Message {address = "/hello/world"; arguments = [Int32 123l; String "foo"]})

To simplify sending and receiving OSC packets over the network, the modules Osc_lwt and Osc_unix are available:

# require "osc.lwt";;

# require "lwt.syntax";;

# open Osc.Types;;

# lwt client = Osc_lwt.Udp.Client.create ();;
val client : Osc_lwt.Udp.Client.t = <abstr>

# let addr = Unix.ADDR_INET (Unix.inet_addr_of_string "127.0.0.1", 57120);;
val addr : Lwt_unix.sockaddr = Unix.ADDR_INET (<abstr>, 57120)

# lwt () = Osc_lwt.Udp.Client.send client addr (Message {address = "/hello/world"; arguments = [Int32 123l; String "foo"]});;

Dependencies (4)

  1. ocplib-endian
  2. ocaml >= "4.08"
  3. dune >= "2.9"
  4. base-bytes

Dev Dependencies (1)

  1. ounit with-test

Conflicts

None