org.intellimate.izou.sdk.frameworks.permanentSoundOutput.output

Class SimplePermanentSoundOutputPlugin<T>

java.lang.Object

org.intellimate.izou.sdk.util.AddOnModule

org.intellimate.izou.sdk.output.OutputPluginArgument<Object,T>

org.intellimate.izou.sdk.output.OutputPlugin<T>

org.intellimate.izou.sdk.frameworks.permanentSoundOutput.output.SimplePermanentSoundOutputPlugin<T>

All Implemented Interfaces:

Runnable, Identifiable, OutputPluginModel<Object,T>, ResourceBuilderModel, ResourcesProviderBase, PermanentSoundHelper, PermanentSoundResources, PermanentSoundUsed, ContextProvider, FireEvent, Loggable, LoggedExceptionCallback, ThreadPoolUser, ExceptionCallback

public abstract class SimplePermanentSoundOutputPlugin<T>
extends OutputPlugin<T>
implements PermanentSoundUsed, PermanentSoundHelper, PermanentSoundResources

extend this class to use the framework

Version:

1.0

Author:

LeanderK

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isUsingJava

Fields inherited from interface org.intellimate.izou.sdk.util.Loggable

FQCN

Constructor Summary

Constructors

Constructor and Description
SimplePermanentSoundOutputPlugin(Context context, String id, boolean isUsingJava) creates a new output-plugin with a new id

Method Summary

Modifier and Type	Method and Description
EventModel	blockingQueueHandling() Default implementation waits until a new Event has been received and then processes it.
boolean	isOutputRunning() retruns true if playing and false if not
boolean	isUsingJava() true if using java, false if not (and for example a C-library)
abstract void	mute() this method call must mute the plugin
Optional<CompletableFuture<Void>>	startPlaying(Runnable function) use this method to start playing sound (only plays sound if it is not already playing)
abstract void	stopSound() this method call must stop the sound
abstract void	unMute() this method call must un-mute the plugin

Methods inherited from class org.intellimate.izou.sdk.output.OutputPlugin

getArgument, getArgumentType, renderFinalOutput

Methods inherited from class org.intellimate.izou.sdk.output.OutputPluginArgument

addToEventList, getEventBlockingQueue, getOutputExtensionList, getReceivingType, getTimeoutLimit, handleFutures, isDone, isRunning, outputExtensionAdded, outputExtensionRemoved, run, stop, terminate

Methods inherited from class org.intellimate.izou.sdk.util.AddOnModule

getContext, getID

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.intellimate.izou.sdk.frameworks.permanentSoundOutput.output.PermanentSoundHelper

endedSound, startedSound

Methods inherited from interface org.intellimate.izou.sdk.util.FireEvent

fire, fire, fire, fire, fire

Methods inherited from interface org.intellimate.izou.sdk.util.ContextProvider

debug, debug, error, error, getContext

Methods inherited from interface org.intellimate.izou.sdk.frameworks.permanentSoundOutput.output.PermanentSoundResources

announceResources, createUsingSoundResource, generateResource, provideResource

Methods inherited from interface org.intellimate.izou.sdk.frameworks.common.resources.ResourcesProviderBase

announceEvents, resourcesInit

Methods inherited from interface org.intellimate.izou.identification.Identifiable

getID, isOwner

Methods inherited from interface org.intellimate.izou.sdk.util.ThreadPoolUser

submit, submit, submit, submitRun, timeOut, timeOut

Methods inherited from interface org.intellimate.izou.sdk.util.Loggable

debug, debug, error, error, fatal, fatal, warn, warn

Methods inherited from interface org.intellimate.izou.sdk.util.LoggedExceptionCallback

exceptionThrown

Field Detail

isUsingJava

public final boolean isUsingJava

Constructor Detail

SimplePermanentSoundOutputPlugin

public SimplePermanentSoundOutputPlugin(Context context,
                                        String id,
                                        boolean isUsingJava)

creates a new output-plugin with a new id

Parameters:

context - context

id - the id of the new output-plugin

Method Detail

blockingQueueHandling

public EventModel blockingQueueHandling()
                                 throws InterruptedException

Default implementation waits until a new Event has been received and then processes it.

This method is made to be overwritten as seen fit by the developer

Overrides:

blockingQueueHandling in class OutputPluginArgument<Object,T>

Returns:

the recently added Event-instance to be processed by the outputPlugin

Throws:

InterruptedException - if interrupted while waiting

isOutputRunning

public boolean isOutputRunning()

retruns true if playing and false if not

Specified by:

isOutputRunning in interface PermanentSoundUsed

Returns:

tre if playing

isUsingJava

public boolean isUsingJava()

true if using java, false if not (and for example a C-library)

Specified by:

isUsingJava in interface PermanentSoundUsed

Returns:

true if using java

startPlaying

public Optional<CompletableFuture<Void>> startPlaying(Runnable function)

use this method to start playing sound (only plays sound if it is not already playing)

Parameters:

function - the function which plays the sound

Returns:

the Future

mute

public abstract void mute()

this method call must mute the plugin

unMute

public abstract void unMute()

this method call must un-mute the plugin

stopSound

public abstract void stopSound()

this method call must stop the sound