net.beadsproject.beads.events

Interface SoundEvent

public interface SoundEvent

A general purpose interface for defining sound events. A SoundEvent is created with the method @link #play(UGen, DataBead) and can be passed a DataBead which can contain additional classes for controlling the event after it has been triggered. The SoundEvent also gets passed a UGen which it should connect to. It should also return the UGen which is its root, so that callers of the SoundEvent can keep track of which SoundEvents are still alive.

Method Summary

Modifier and Type	Method and Description
UGen	play(UGen output, java.util.Map<java.lang.String,java.lang.Object> parameters) Cause a SoundEvent to play.

Method Detail

play

UGen play(UGen output,
          java.util.Map<java.lang.String,java.lang.Object> parameters)

Cause a SoundEvent to play. The SoundEvent is responsible for connecting itself to the output arg. The SoundEvent should also return the UGen which is its root, i.e., a UGen which, if dead, indicates that the SoundEvent is dead.

Parameters:

output - the output.

parameters - additional data.

Returns:

a UGen which is the root of the SoundEvent.