Class OscParameter

Namespace

BuildSoft.VRChat.Osc

Assembly

vrcosclib.dll

Provides a way to get/set OSC parameters and parameter values.

public static class OscParameter

Inheritance

object

OscParameter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Parameters

A collection of OSC parameters.

public static OscParameterCollection Parameters { get; }

Property Value

OscParameterCollection

Methods

GetValue(string)

Gets the value of an OSC parameter.

public static object? GetValue(string address)

Parameters

address string

The address of the OSC parameter.

Returns

object

The value of the OSC parameter, or null if the parameter does not exist.

SendAvatarParameter(string, MidiMessage)

Sends an OSC message with the specified BuildSoft.OscCore.MidiMessage value to the specified OSC address.

public static void SendAvatarParameter(string name, MidiMessage value)

Parameters

name string

The name of the OSC parameter.

value MidiMessage

The value of the OSC parameter.

SendAvatarParameter(string, Color32)

Sends an OSC message with the specified BuildSoft.OscCore.UnityObjects.Color32 value to the specified OSC address.

public static void SendAvatarParameter(string name, Color32 value)

Parameters

name string

The name of the OSC parameter.

value Color32

The value of the OSC parameter.

SendAvatarParameter(string, Vector2)

Sends an OSC message with the specified BuildSoft.OscCore.UnityObjects.Vector2 value to the specified OSC address.

public static void SendAvatarParameter(string name, Vector2 value)

Parameters

name string

The name of the OSC parameter.

value Vector2

The value of the OSC parameter.

SendAvatarParameter(string, Vector3)

Sends an OSC message with the specified BuildSoft.OscCore.UnityObjects.Vector3 value to the specified OSC address.

public static void SendAvatarParameter(string name, Vector3 value)

Parameters

name string

The name of the OSC parameter.

value Vector3

The value of the OSC parameter.

SendAvatarParameter(string, bool)

Sends an OSC message with the specified bool value to the specified OSC address.

public static void SendAvatarParameter(string name, bool value)

Parameters

name string

The name of the OSC parameter.

value bool

The value of the OSC parameter.

SendAvatarParameter(string, byte[])

Sends an OSC message with the specified byte[] value to the specified OSC address.

public static void SendAvatarParameter(string name, byte[] value)

Parameters

name string

The name of the OSC parameter.

value byte[]

The value of the OSC parameter.

SendAvatarParameter(string, char)

Sends an OSC message with the specified char value to the specified OSC address.

public static void SendAvatarParameter(string name, char value)

Parameters

name string

The name of the OSC parameter.

value char

The value of the OSC parameter.

SendAvatarParameter(string, double)

Sends an OSC message with the specified double value to the specified OSC address.

public static void SendAvatarParameter(string name, double value)

Parameters

name string

The name of the OSC parameter.

value double

The value of the OSC parameter.

SendAvatarParameter(string, int)

Sends an OSC message with the specified int value to the specified OSC address.

public static void SendAvatarParameter(string name, int value)

Parameters

name string

The name of the OSC parameter.

value int

The value of the OSC parameter.

SendAvatarParameter(string, long)

Sends an OSC message with the specified long value to the specified OSC address.

public static void SendAvatarParameter(string name, long value)

Parameters

name string

The name of the OSC parameter.

value long

The value of the OSC parameter.

SendAvatarParameter(string, object)

Sends an OSC message with the specified object value to the specified OSC address.

public static void SendAvatarParameter(string name, object value)

Parameters

name string

The name of the OSC parameter.

value object

The value of the OSC parameter.

SendAvatarParameter(string, float)

Sends an OSC message with the specified float value to the specified OSC address.

public static void SendAvatarParameter(string name, float value)

Parameters

name string

The name of the OSC parameter.

value float

The value of the OSC parameter.

SendAvatarParameter(string, string)

Sends an OSC message with the specified string value to the specified OSC address.

public static void SendAvatarParameter(string name, string value)

Parameters

name string

The name of the OSC parameter.

value string

The value of the OSC parameter.

SendValue(string, MidiMessage)

Sends an OSC message with the specified BuildSoft.OscCore.MidiMessage value to the specified OSC address.

public static void SendValue(string address, MidiMessage value)

Parameters

address string

The OSC address to send the message to.

value MidiMessage

The value to send in the OSC message.

SendValue(string, Color32)

Sends an OSC message with the specified BuildSoft.OscCore.UnityObjects.Color32 value to the specified OSC address.

public static void SendValue(string address, Color32 value)

Parameters

address string

The OSC address to send the message to.

value Color32

The value to send in the OSC message.

SendValue(string, Vector2)

Sends an OSC message with the specified BuildSoft.OscCore.UnityObjects.Vector2 value to the specified OSC address.

public static void SendValue(string address, Vector2 value)

Parameters

address string

The OSC address to send the message to.

value Vector2

The value to send in the OSC message.

SendValue(string, Vector3)

Sends an OSC message with the specified BuildSoft.OscCore.UnityObjects.Vector3 value to the specified OSC address.

public static void SendValue(string address, Vector3 value)

Parameters

address string

The OSC address to send the message to.

value Vector3

The value to send in the OSC message.

SendValue(string, bool)

Sends an OSC message with the specified bool value to the specified OSC address.

public static void SendValue(string address, bool value)

Parameters

address string

The OSC address to send the message to.

value bool

The value to send in the OSC message.

SendValue(string, byte[])

Sends an OSC message with the specified byte[] value to the specified OSC address.

public static void SendValue(string address, byte[] value)

Parameters

address string

The OSC address to send the message to.

value byte[]

The value to send in the OSC message.

SendValue(string, char)

Sends an OSC message with the specified char value to the specified OSC address.

public static void SendValue(string address, char value)

Parameters

address string

The OSC address to send the message to.

value char

The value to send in the OSC message.

SendValue(string, double)

Sends an OSC message with the specified double value to the specified OSC address.

public static void SendValue(string address, double value)

Parameters

address string

The OSC address to send the message to.

value double

The value to send in the OSC message.

SendValue(string, int)

Sends an OSC message with the specified int value to the specified OSC address.

public static void SendValue(string address, int value)

Parameters

address string

The OSC address to send the message to.

value int

The value to send in the OSC message.

SendValue(string, long)

Sends an OSC message with the specified long value to the specified OSC address.

public static void SendValue(string address, long value)

Parameters

address string

The OSC address to send the message to.

value long

The value to send in the OSC message.

SendValue(string, float)

Sends an OSC message with the specified float value to the specified OSC address.

public static void SendValue(string address, float value)

Parameters

address string

The OSC address to send the message to.

value float

The value to send in the OSC message.

SendValue(string, string)

Sends an OSC message with the specified string value to the specified OSC address.

public static void SendValue(string address, string value)

Parameters

address string

The OSC address to send the message to.

value string

The value to send in the OSC message.

Events

ValueChanged

An event that is raised when the value of an OSC parameter is changed.

public static event OscParameterChangedEventHandler<IReadOnlyOscParameterCollection> ValueChanged

Event Type

OscParameterChangedEventHandler<IReadOnlyOscParameterCollection>