com.runwayml

Class RunwayOSC

java.lang.Object

com.runwayml.Runway

com.runwayml.RunwayOSC

public class RunwayOSC
extends Runway

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONNECT
static java.lang.String	DATA
static java.lang.String	DISCONNECT
static java.lang.String	ERROR
static java.lang.String	INFO
static int	PORT_OSC_FROM_RUNWAY
static int	PORT_OSC_TO_RUNWAY
static java.lang.String	QUERY

Fields inherited from class com.runwayml.Runway

DEFAULT_HOST, VERSION

Constructor Summary

Constructors

Constructor and Description
RunwayOSC(PApplet parent) a Constructor, usually called in the setup() method in your sketch to initialize and start the Library.
RunwayOSC(PApplet parent, java.lang.String host) Constructor variant that takes in an IPv4 Address for situations where Runway runs on a different computer on the same network

Method Summary

Modifier and Type	Method and Description
void	connect() send a /server/connect message to Runway
void	disconnect() send a /server/disconnect message to Runway
void	oscEvent(OscMessage message) called internally by OscP5 library
void	query(PImage input) send a /query with a PImage sencoded as Base64 string within a JSON string (
void	query(PImage input, java.lang.String format, java.lang.String key) Send a /query OSC message to Runway with the passed image Base64 encoded with the selected format and as the value of the selected JSON key
void	query(java.lang.String input) send a query to Runway Don't call this on a Runway instace, but a Runway sublcass instead.

Methods inherited from class com.runwayml.Runway

drawPoseNetParts, version

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PORT_OSC_TO_RUNWAY

public static final int PORT_OSC_TO_RUNWAY

See Also:

Constant Field Values

PORT_OSC_FROM_RUNWAY

public static final int PORT_OSC_FROM_RUNWAY

See Also:

Constant Field Values

CONNECT

public static final java.lang.String CONNECT

See Also:

Constant Field Values

DISCONNECT

public static final java.lang.String DISCONNECT

See Also:

Constant Field Values

QUERY

public static final java.lang.String QUERY

See Also:

Constant Field Values

DATA

public static final java.lang.String DATA

See Also:

Constant Field Values

ERROR

public static final java.lang.String ERROR

See Also:

Constant Field Values

INFO

public static final java.lang.String INFO

See Also:

Constant Field Values

Constructor Detail

RunwayOSC

public RunwayOSC(PApplet parent)

a Constructor, usually called in the setup() method in your sketch to initialize and start the Library.

Parameters:

parent - - the parent PApplet (usually

this

)

RunwayOSC

public RunwayOSC(PApplet parent,
                 java.lang.String host)

Constructor variant that takes in an IPv4 Address for situations where Runway runs on a different computer on the same network

Parameters:

parent - - the parent PApplet (usually

this

)

host - - the IPv4 Address where Runway is running

Method Detail

connect

public void connect()

send a /server/connect message to Runway

disconnect

public void disconnect()

send a /server/disconnect message to Runway

query

public void query(PImage input)

send a /query with a PImage sencoded as Base64 string within a JSON string (

{"image": }

)

Overrides:

query in class Runway

Parameters:

input - - the PImage to query the Runway model with (Must be of the dimensions the model expects)

query

public void query(PImage input,
                  java.lang.String format,
                  java.lang.String key)

Send a /query OSC message to Runway with the passed image Base64 encoded with the selected format and as the value of the selected JSON key

Overrides:

query in class Runway

Parameters:

input - - PImage to encode and send

format - - ModelUtils.IMAGE_FORMAT_JPG or ModelUtils.IMAGE_FORMAT_PNG

key - - the key of the JSON object for the image value

query

public void query(java.lang.String input)

Description copied from class: Runway

send a query to Runway Don't call this on a Runway instace, but a Runway sublcass instead.

Overrides:

query in class Runway

Parameters:

input - - JSON formatted string for the selected model

oscEvent

public void oscEvent(OscMessage message)

called internally by OscP5 library

Parameters:

message -