ptolemy.actor.lib.jjs.modules.audio

Class ClipPlayerHelper

java.lang.Object

ptolemy.actor.lib.jjs.HelperBase

ptolemy.actor.lib.jjs.modules.audio.ClipPlayerHelper

public class ClipPlayerHelper
extends HelperBase

Helper for the ClipPlayer in the audio.js module. See the module for documentation. Note that this class requires a graphical display because instantiating a JFXPanel attempts to connect to the display.

Since:

Ptolemy II 11.0

Version:

$Id: CliPlayerHelper.java 75850 2017-04-03 21:53:00Z cxh $

Author:

Elizabeth Osyk

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Yellow (eal)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.actor.lib.jjs.HelperBase

HelperBase.DATA_TYPE

Field Summary

Fields inherited from class ptolemy.actor.lib.jjs.HelperBase

_actor, _currentObj

Constructor Summary

Constructors

Constructor and Description
ClipPlayerHelper(java.lang.Object actor, jdk.nashorn.api.scripting.ScriptObjectMirror helping) Construct a new ClipPlayerHelper.

Method Summary

Modifier and Type	Method and Description
void	play() Play the sound clip.
void	setURL(java.lang.String url) Set the URL of the clip to load and construct a new MediaPlayer to it.
void	stop() Stop playback, if playing.

Methods inherited from class ptolemy.actor.lib.jjs.HelperBase

_appendNumericToBuffer, _appendToBuffer, _error, _error, _error, _error, _extractFromBuffer, _issueResponse, _removeDuplicates, _sizeOfType, _toJavaBytes, _toJSArray, getHelping

Methods inherited from class java.lang.Object

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

Constructor Detail

ClipPlayerHelper

public ClipPlayerHelper(java.lang.Object actor,
                        jdk.nashorn.api.scripting.ScriptObjectMirror helping)

Construct a new ClipPlayerHelper.

Parameters:

actor - The actor associated with this ClipPlayerHelper.

helping - The Javascript object being helped.

Method Detail

play

public void play()

Play the sound clip.

setURL

public void setURL(java.lang.String url)

Set the URL of the clip to load and construct a new MediaPlayer to it.

Parameters:

url - The URL of the clip to load.

stop

public void stop()

Stop playback, if playing.