com.runwayml

Class RunwayHTTP

java.lang.Object

com.runwayml.Runway

com.runwayml.RunwayHTTP

public class RunwayHTTP
extends Runway

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATA
static java.lang.String	ERROR
static int	HTTP_TIMEOUT_SECONDS
static java.lang.String	INFO
static int	PORT
static java.lang.String	QUERY

Fields inherited from class com.runwayml.Runway

DEFAULT_HOST, VERSION

Constructor Summary

Constructors

Constructor and Description
RunwayHTTP(PApplet parent) Constructor, usually called in the setup() method in your sketch to initialize and start the Library.
RunwayHTTP(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
RunwayHTTP(PApplet parent, java.lang.String host, int port)

Method Summary

Modifier and Type	Method and Description
boolean	isAutoUpdating()
void	pre() Don't call method directly The sketch calls this before each frame if
void	query(PImage input) send an image query to Runway (defaults to jpg encoding format and "image" JSON object key)
void	query(PImage input, java.lang.String format, java.lang.String key) send an image query to Runway
void	query(java.lang.String input) send a JSON string query to Runway
void	setAutoUpdate(boolean autoUpdate) Call Runway before each frame or not ?
void	update() call

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

HTTP_TIMEOUT_SECONDS

public static int HTTP_TIMEOUT_SECONDS

PORT

public static final int PORT

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

RunwayHTTP

public RunwayHTTP(PApplet parent)

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

Parameters:

parent - - the parent PApplet (usually

this

)

RunwayHTTP

public RunwayHTTP(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

RunwayHTTP

public RunwayHTTP(PApplet parent,
                  java.lang.String host,
                  int port)

Method Detail

pre

public void pre()

Don't call method directly The sketch calls this before each frame if

isAutoUpdating()

update

public void update()

call

/error

and

/data

endpoints to retrieve new information from Runway calling

setAutoUpdate(true)

(true by default) automatically calls update() before each frame

isAutoUpdating

public boolean isAutoUpdating()

Returns:

the autoUpdate

setAutoUpdate

public void setAutoUpdate(boolean autoUpdate)

Call Runway before each frame or not ?

Parameters:

autoUpdate - the value to set

query

public void query(PImage input)

send an image query to Runway (defaults to jpg encoding format and "image" JSON object key)

Overrides:

query in class Runway

Parameters:

input - - input image for Runway to query (assumes image is resized/cropped to dimensions set in model)

query

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

send an image query to Runway

Overrides:

query in class Runway

Parameters:

input - - input image for Runway to query (assumes image is resized/cropped to dimensions set in model)

format - - the image format:

ModelUtils.IMAGE_FORMAT_JPG

("JPG") or

ModelUtils.IMAGE_FORMAT_PNG

("PNG")

key - - the JSON key for the Base64 image

query

public void query(java.lang.String input)

send a JSON string query to Runway

Overrides:

query in class Runway

Parameters:

input - - JSON formatted input