org.jaudiolibs.pipes.graph

Class GraphPlayer

java.lang.Object

org.jaudiolibs.pipes.graph.GraphPlayer

All Implemented Interfaces:

Runnable

public class GraphPlayer
extends Object
implements Runnable

GraphPlayer takes a Graph subclass, automatically injects fields annotated with UGen or Inject, attaches it to an AudioServer and plays it. Use create(org.jaudiolibs.pipes.graph.Graph) and a GraphPlayer.Builder to create and configure a GraphPlayer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphPlayer.Builder A builder for a GraphPlayer

Method Summary

Modifier and Type	Method and Description
static GraphPlayer.Builder	create(Graph graph) Create a builder for a GraphPlayer for the provided graph.
void	run() Run the graph player on the current thread.
void	shutdown() Trigger the GraphPlayer to shutdown.
void	start() Start a maximum priority thread and run this player on it.

Methods inherited from class java.lang.Object

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

Method Detail

run

public void run()

Run the graph player on the current thread. The GraphPlayer may only be run once.

Specified by:

run in interface Runnable

start

public void start()

Start a maximum priority thread and run this player on it. The GraphPlayer may only be run once.

shutdown

public void shutdown()

Trigger the GraphPlayer to shutdown. This method is asynchronous - it calls shutdown on the running AudioServer and returns immediately.

create

public static GraphPlayer.Builder create(Graph graph)

Create a builder for a GraphPlayer for the provided graph.

Parameters:

graph - to build a player for

Returns:

graph builder