# OSCReceiver

This plugin provides you with the means to handle incoming OSC messages using extra Blocks.

![](/files/-M8pN8FpiQOsli--Gcqz)

## How To Use

### Configuration

First you need to enable this plugin using the [Settings](/guide/views/settings.md) menu.

Right after enabling the plugin, Schéma starts listening for OSC messages.

The default configuration is:

* IP (local bind address): **0.0.0.0**
* Port: **4444**
* Enabled: **true**

Use the [JSON configuration ](/guide/external-configuration.md)files to change these settings. Using *Enabled: false* will disable receiving while keeping the blocks available you. The settings format is available below:

```
{
    "OSCReceiver": {
        "IP": "0.0.0.0",
        "Port": 4444,
        "Enabled": true
    }
}
```

### Blocks

Once you have everything configured to your liking, it's time to bring out the Blocks.

{% hint style="warning" %}
"/" characters in OSC addresses are automatically replaced with "." to keep with Schéma's naming conventions.
{% endhint %}

You can enter addresses manually (with . instead of /) or more conveniently select it from the list. Whenever Schéma receives an OSC message, its address will be appended to the selection list.

#### Source.Value.OSC

Receives a float value at the specified address (*Name*).

*Default* specifies the value that is generated before the message is received for the first time.

#### Source.Value.OSCReceived

Bangs upon receiving any OSC message at the specified address (*Name*).

Turning *Simulate* on will generate a value bang.

## Examples

Trigger flashes using [Orca](https://hundredrabbits.itch.io/orca)

![](/files/-M8pUirA0bZ34nR1vOM8)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.scenic.tools/plugins/oscreceiver.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
