OSC Parameter Specification
Note
This page is automatically translated from Japanese to English. Please refer to the original Japanese page for the most accurate information.
1. Function Control Parameters
| Parameter Format | Type | Description | Value Range |
|---|---|---|---|
/avatar/parameters/VRCPleasure/{N}/Control |
float | N-th function control value | 0.0 to 1.0 |
/avatar/parameters/VRCPleasure/{N}/Mode |
int | N-th function mode | 0, 1, 2, 3, 10, 20 |
Function Numbering Rules
- Connection Order Based: Numbers are assigned in the order devices are connected.
- Function Separation: If the same device has multiple functions, a separate number is assigned for each function.
- Dynamic Generation: Numbers are dynamically changed based on connection and disconnection events.
Interpretation of Control Values (Unified Specification)
All functions receive values from 0.0 to 1.0 and process them uniformly:
| Function Type | Value Interpretation | Notes |
|---|---|---|
| Vibration | 0.0=Stop, 1.0=Maximum Intensity | - |
| Rotation | 0.0=Stop, 1.0=Maximum Speed (Forward rotation only) | Reverse control is not supported |
| Linear Motion | 0.0=Stop, 1.0=Maximum Speed | - |
| Oscillation | 0.0=Stop, 1.0=Maximum Speed | - |
2. Common Control Parameters
| Parameter Name | Type | Description | Value Range |
|---|---|---|---|
/avatar/parameters/VRCPleasure/StopAll |
float/int/bool | Stop all functions | 0=Continue, 1=Stop |
/avatar/parameters/VRCPleasure/Pause |
float/int/bool | Pause all functions | 0=Resume, 1=Stop |
Details of Mode Values
| Value | Action | Description |
|---|---|---|
| 0 | Stop | Stops the function |
| 1 | Preset 1 | Basic patterns like sine waves |
| 2 | Preset 2 | Complex waveform patterns |
| 3 | Preset 3 | Composite waveform patterns |
| 10 | Manual | Manual control mode (directly controlled by the Control value) |
| 20 | OSC Pattern | OSC linked pattern mode |
StopAll Behavior
- Can receive float, int, or bool types.
-
If it is "0/false" (e.g., 0, 0.0, false), operation continues. If it is "non-zero/true" (e.g., 1, 1.0, true, 0.5 or greater), all operations are stopped.
-
Examples
- float type: 0.0 → Continue, 1.0 → Stop, 0.5 → Stop
- int type: 0 → Continue, 1 → Stop
- bool type: false → Continue, true → Stop
Pause Behavior
- Can receive float, int, or bool types.
- If it is "0/false" (e.g., 0, 0.0, false), operation continues. If it is "non-zero/true" (e.g., 1, 1.0, true, 0.5 or greater), all operations are paused.
- While paused, updates to individual control values (vibration intensity, rotation speed, etc.) occur internally, but output to the device is stopped.
- When Pause is released, the device operation resumes with the latest control values.
3. OSC Pattern Control
| Parameter Name | Type | Description | Value Range |
|---|---|---|---|
/avatar/parameters/VRCPleasure/Gimmick/* |
float | Pattern control input | 0.0 to 0.1 |
Receives all paths under Gimmick/.
Info
/avatar/parameters/VRCPleasure/Gimmick/* receives addresses where * contains any arbitrary string.
For example, /avatar/parameters/VRCPleasure/Gimmick/Contact or /avatar/parameters/VRCPleasure/Gimmick/Piston.
Note that the part up to /avatar/parameters/VRCPleasure/Gimmick/ can be changed via settings.
The default avatar gimmick sends to the following five addresses:
- Contact
- Piston
- Breast
- SPSPlug
- SPSSocket