com.jsyn.ports

Class QueueDataCommand

java.lang.Object

java.util.EventObject

com.jsyn.ports.QueueDataEvent

com.jsyn.ports.QueueDataCommand

All Implemented Interfaces:

ScheduledCommand, java.io.Serializable

public abstract class QueueDataCommand
extends QueueDataEvent
implements ScheduledCommand

A command that can be used to queue SequentialData to a UnitDataQueuePort. Here is an example of queuing data with a callback using this command.

 
        // Queue an envelope with a completion callback.
        QueueDataCommand command = envelopePlayer.dataQueue.createQueueDataCommand( envelope, 0,
                        envelope.getNumFrames() );
        // Create an object to be called when the queued data is done.
        TestQueueCallback callback = new TestQueueCallback();
        command.setCallback( callback );
        command.setNumLoops( 2 );
        envelopePlayer.rate.set( 0.2 );
        synth.queueCommand( command );
  
 

The callback will be passed QueueDataEvents.

 
        class TestQueueCallback implements UnitDataQueueCallback
        {
                public void started( QueueDataEvent event )
                {
                        System.out.println("CALLBACK: Envelope started.");
                }

                public void looped( QueueDataEvent event )
                {
                        System.out.println("CALLBACK: Envelope looped.");
                }

                public void finished( QueueDataEvent event )
                {
                        System.out.println("CALLBACK: Envelope finished.");
                }
        }
 
 

Author:

Phil Burk 2009 Mobileer Inc

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected com.jsyn.ports.SequentialDataCrossfade	crossfadeData
protected SequentialData	currentData

Fields inherited from class com.jsyn.ports.QueueDataEvent

autoStop, crossFadeIn, immediate, loopsLeft, numFrames, numLoops, sequentialData, skipIfOthers, startFrame

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
QueueDataCommand(UnitDataQueuePort port, SequentialData sequentialData, int startFrame, int numFrames)

Method Summary

Modifier and Type	Method and Description
UnitDataQueueCallback	getCallback()
com.jsyn.ports.SequentialDataCrossfade	getCrossfadeData()
SequentialData	getCurrentData()
abstract void	run()
void	setAutoStop(boolean autoStop) Stop the unit that contains this port after this command has finished.
void	setCallback(UnitDataQueueCallback callback)
void	setCrossfadeData(com.jsyn.ports.SequentialDataCrossfade crossfadeData)
void	setCrossFadeIn(int size) Number of frames to cross fade from the previous block to this block.
void	setCurrentData(SequentialData currentData)
void	setImmediate(boolean immediate) If true then the queue will be cleared and this item will be started immediately.
void	setNumLoops(int numLoops) Set how many time the block should be repeated after the first time.
void	setSkipIfOthers(boolean skipIfOthers) If true then this item will be skipped if other items are queued after it.

Methods inherited from class com.jsyn.ports.QueueDataEvent

getCrossFadeIn, getLoopsLeft, getNumFrames, getNumLoops, getSequentialData, getStartFrame, isAutoStop, isImmediate, isSkipIfOthers

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

crossfadeData

protected com.jsyn.ports.SequentialDataCrossfade crossfadeData

currentData

protected SequentialData currentData

Constructor Detail

QueueDataCommand

public QueueDataCommand(UnitDataQueuePort port,
                        SequentialData sequentialData,
                        int startFrame,
                        int numFrames)

Method Detail

run

public abstract void run()

Specified by:

run in interface ScheduledCommand

setSkipIfOthers

public void setSkipIfOthers(boolean skipIfOthers)

If true then this item will be skipped if other items are queued after it. This flag allows you to queue lots of small pieces of sound without making the queue very long.

Parameters:

skipIfOthers -

setImmediate

public void setImmediate(boolean immediate)

If true then the queue will be cleared and this item will be started immediately. It is better to use this flag than to clear the queue from the application because there could be a gap before the next item is available. This is most useful when combined with setCrossFadeIn().

Parameters:

immediate -

getCallback

public UnitDataQueueCallback getCallback()

setCallback

public void setCallback(UnitDataQueueCallback callback)

getCrossfadeData

public com.jsyn.ports.SequentialDataCrossfade getCrossfadeData()

setCrossfadeData

public void setCrossfadeData(com.jsyn.ports.SequentialDataCrossfade crossfadeData)

getCurrentData

public SequentialData getCurrentData()

setCurrentData

public void setCurrentData(SequentialData currentData)

setAutoStop

public void setAutoStop(boolean autoStop)

Stop the unit that contains this port after this command has finished.

Parameters:

autoStop -

setNumLoops

public void setNumLoops(int numLoops)

Set how many time the block should be repeated after the first time. For example, if you set numLoops to zero the block will only be played once. If you set numLoops to one the block will be played twice.

Parameters:

numLoops - number of times to loop back

setCrossFadeIn

public void setCrossFadeIn(int size)

Number of frames to cross fade from the previous block to this block. This can be used to avoid pops when making abrupt transitions. There must be frames available after the end of the previous block to use for crossfading. The crossfade is linear.

Parameters:

size -