Struct VRChatOSC

Source

pub struct VRChatOSC { /* private fields */ }

Expand description

Main struct for managing VRChat OSC services, discovery, and communication.

Implementations§

Source §

impl VRChatOSC

Source

pub async fn new() -> Result<Arc<VRChatOSC>, Error>

Creates a new VRChatOSC instance. Initializes mDNS, sets up service discovery, and starts a listener task for mDNS service notifications.

Source

pub async fn on_connect<F>(&self, callback: F)
where F: Fn(ServiceType) + Send + Sync + 'static,

Registers a callback function to be invoked when an mDNS service is discovered.

§Arguments

callback - A function or closure that takes the service Name and SocketAddr as arguments. It must be Send + Sync + 'static.

Source

pub async fn register<F>( &self, service_name: &str, parameters: OscRootNode, handler: F, ) -> Result<(), Error>
where F: Fn(OscPacket) + Send + 'static,

Registers a new OSC service with the local mDNS daemon and starts listening for OSC messages.

§Arguments

service_name - The name of the service to register (e.g., “MyAppOSC”).
parameters - The root node of the OSC address space for this service.
handler - A function that will be called when an OSC packet is received for this service. It must be Fn(OscPacket) + Send + 'static.

Source

pub async fn unregister(&self, service_name: &str) -> Result<(), Error>

Unregisters an OSC service. Stops the OSC and OSCQuery servers and removes mDNS announcements.

§Arguments

service_name - The name of the service to unregister.

Source

pub async fn send(&self, packet: OscPacket, to: &str) -> Result<(), Error>

Sends an OSC packet to services matching a given pattern.

§Arguments

packet - The OscPacket to send.
to - A glob pattern (e.g., “VRChat-Client-*”) to match against service names. This matches against the service instance name found via mDNS.

Source

pub async fn send_to_addr( &self, packet: OscPacket, addr: SocketAddr, ) -> Result<(), Error>

Sends an OSC packet to a specific socket address.

§Arguments

packet - The OscPacket to send.
addr - The SocketAddr to send the packet to.

Source

pub async fn get_parameter( &self, method: &str, from: &str, ) -> Result<Vec<(Name, OscNode)>, Error>

Retrieves a specific OSC parameter (node) from services matching a pattern.

§Arguments

method - The OSC path of the parameter to fetch (e.g., “/avatar/parameters/SomeParam”).
from - A glob pattern (e.g., “VRChat-Client-*”) to match against service names. This matches against the service instance name found via mDNS.

§Returns

A Vec of tuples, where each tuple contains the service Name and the fetched OscNode. Returns an empty Vec if no services match or if fetching fails for all matched services.

Source

pub async fn get_parameter_from_addr( &self, method: &str, addr: SocketAddr, ) -> Result<OscNode, Error>

Retrieves a specific OSC parameter (node) from a specific OSCQuery service address.

§Arguments

method - The OSC path of the parameter to fetch (e.g., “/avatar/parameters/SomeParam”).
addr - The SocketAddr of the OSCQuery service.

§Returns

The fetched OscNode.

Source

pub async fn shutdown(&self) -> Result<(), Error>

Shuts down all registered services and cleans up resources. This method should be called before the VRChatOSC instance is dropped to ensure graceful shutdown of asynchronous tasks and network services.