Home Reference Source Test
import Plugin from 'osc-js/src/plugin/plugin.js'
public class | source

Plugin

Constructor Summary

Public Constructor
public

Method Summary

Public Methods
public

close()

Close socket connection and anything else used in the implementation.

public

open(customOptions: object)

Open socket connection.

public

send(binary: Uint8Array, customOptions: object)

Send an OSC Packet, Bundle or Message.

public

Returns the current status of the connection

Public Constructors

public constructor() source

Public Methods

public close() source

Close socket connection and anything else used in the implementation.

public open(customOptions: object) source

Open socket connection. Specifics depend on implementation.

Params:

NameTypeAttributeDescription
customOptions object
  • optional

Custom options. See implementation specifics.

public send(binary: Uint8Array, customOptions: object) source

Send an OSC Packet, Bundle or Message. Use options here for custom receiver, otherwise the global options will be taken

Params:

NameTypeAttributeDescription
binary Uint8Array

Binary representation of OSC Packet

customOptions object
  • optional

Custom options. Specifics depend on implementation.

public status(): number source

Returns the current status of the connection

Return:

number

Status ID