Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OSCSender

Represents an OSC sender.

An OSCSender object can send OSC messages to a specified host over UDP socket.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new OSCSender(hostname: string, port: number): OSCSender

  • Creates an OSCSender object with a specified hostname and port.

    Parameters

    • hostname: string

      The remote host to which messages will be send.

    • port: number

      The remote UDP port number.

      Throws an exception if the connection cannot be established for the specified hostname and port.

    Returns OSCSender

Properties

gain

gain: number

The gain for this object.

Defaults to 1.0.

gainDecibels

gainDecibels: number

The dBFS level for this object.

Defaults to 0.0

hostname

hostname: string

Returns hostname for this object.

Optional id

id: ObjectID

The identifier of this node.

input

input: [ObjectID, Channel][]

The audio input channels of this audio unit.

midiIn

midiIn: [ObjectID, Channel]

The midi input for this audio unit.

output

output: [ObjectID, Channel][]

The audio output channels of this audio unit.

pan

pan: number

The pan for this object.

Defaults to 0.0; -1.0 = left, 0.0 = centre, 1.0 = right.

port

port: number

Returns the UDP port for this object.

Methods

connect

  • Connects this object's output to the specified destination object's input ("output" if the destination is a graph).

    Parameters

    • destination: AudioUnit | Graph

      The AudioUnit | Graph to which to connect.

    • Optional outputIndex: number

      An index specifying which output of this AudioUnit to connect to the destination.

    • Optional inputIndex: number

      An index describing which input of the destination you want to connect this AudioUnit to.

      Returns a reference to the destination AudioUnit object allowing you to chain multiple connect() calls. If the destination is a Graph object, connect() returns undefined.

    Returns AudioUnit | undefined

Generated using TypeDoc