Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keijiro/oscjack
Lightweight C# implementation of OSC server/client
https://github.com/keijiro/oscjack
osc unity unity3d
Last synced: 5 days ago
JSON representation
Lightweight C# implementation of OSC server/client
- Host: GitHub
- URL: https://github.com/keijiro/oscjack
- Owner: keijiro
- License: unlicense
- Created: 2015-06-22T13:51:24.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2022-04-25T14:05:49.000Z (over 2 years ago)
- Last Synced: 2024-12-30T01:10:33.915Z (12 days ago)
- Topics: osc, unity, unity3d
- Language: C#
- Homepage:
- Size: 146 KB
- Stars: 481
- Watchers: 20
- Forks: 65
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
OSC Jack
========
**OSC Jack** is a lightweight C# implementation of [OSC (Open Sound Control)]
server/client, mainly aiming to provide OSC support to [Unity].
[OSC (Open Sound Control)]: http://opensoundcontrol.org/
[Unity]: https://unity3d.com/
System Requirements
-------------------
- Unity 2021.3 or later
OSC Jack requires `System.Net.Sockets` supported on most platforms but a few
network-restrictive platforms like WebGL.
How To Install
--------------
This package is available in the `Keijiro` scoped registry.
- Name: `Keijiro`
- URL: `https://registry.npmjs.com`
- Scope: `jp.keijiro`
Please follow [this gist] to add the registry to your project.
[this gist]: https://gist.github.com/keijiro/f8c7e8ff29bfe63d86b888901b82644c
OSC Connection File
-------------------
The OSC Jack components require **OSC Connection** files to specify connection
types, host addresses and port numbers. To create a new OSC Connection file,
navigate to Assets > Create > ScriptableObjects > OSC Jack > Connection.
You must specify a target host address to send OSC messages (leave it empty for
receive-only connections).
OSC Components
--------------
### OSC Event Receiver
**OSC Event Receiver** receives OSC messages and invokes a [UnityEvent] with
received data.
[UnityEvent]: https://docs.unity3d.com/Manual/UnityEvents.html
### OSC Property Sender
**OSC Property Sender** observes a component property and sends OSC messages
on changes to it.
OSC Monitor
-----------
**OSC Monitor** is a small utility inspecting incoming OSC messages. To open
the monitor, navigate to Window > OSC Monitor.
Low-Level API
-------------
### Supported data types
At the moment, the OSC Jack low-level API only supports `int`, `float` and
`string` data types.
### OscClient (implements IDisposable)
`OscClient` is a class for sending OSC messages, supporting up to four
arguments within a single message.
```csharp
// IP address, port number
using (var client = new OscClient("127.0.0.1", 9000))
{
// Send two-component float values ten times.
for (var i = 0; i < 10; i++)
{
yield return new WaitForSeconds(0.5f);
client.Send("/test", // OSC address
i * 10.0f, // First element
Random.value); // Second element
}
}
```
### OscServer (implements IDisposable)
`OscServer` is a class for receiving OSC messages, supporting up to four
arguments within a single message.
You can add a delegate to `MessageDispatcher` to receive messages sent to a
specific OSC address (or give an empty string to receive all messages).
Please note that the server invokes the delegates in the server thread. You
may have to queue the events for processing them in the main thread.
```csharp
using (var server = new OscServer(9000)) // Port number
{
server.MessageDispatcher.AddCallback(
"/test", // OSC address
(string address, OscDataHandle data) => {
Debug.Log(string.Format("({0}, {1})",
data.GetElementAsFloat(0),
data.GetElementAsFloat(1)));
}
);
yield return new WaitForSeconds(10);
}
```