com.jme3.cinematic.events

Class SoundEvent

java.lang.Object

com.jme3.cinematic.events.AbstractCinematicEvent

com.jme3.cinematic.events.SoundEvent

All Implemented Interfaces:

CinematicEvent, Savable

Direct Known Subclasses:

SoundTrack

public class SoundEvent
extends AbstractCinematicEvent

A sound track to be played in a cinematic.

Field Summary

Fields

Modifier and Type	Field and Description
protected AudioNode	audioNode
protected java.lang.String	path
protected boolean	stream

Fields inherited from class com.jme3.cinematic.events.AbstractCinematicEvent

initialDuration, listeners, loopMode, playState, resuming, speed, time

Constructor Summary

Constructors

Constructor and Description
SoundEvent() creates a sound event used for serialization
SoundEvent(java.lang.String path) creates a sound track from the given resource path
SoundEvent(java.lang.String path, boolean stream) creates a sound track from the given resource path
SoundEvent(java.lang.String path, boolean stream, float initialDuration) creates a sound track from the given resource path
SoundEvent(java.lang.String path, boolean stream, float initialDuration, LoopMode loopMode) creates a sound track from the given resource path
SoundEvent(java.lang.String path, boolean stream, LoopMode loopMode) creates a sound track from the given resource path
SoundEvent(java.lang.String path, float initialDuration) creates a sound track from the given resource path
SoundEvent(java.lang.String path, float initialDuration, LoopMode loopMode) creates a sound track from the given resource path
SoundEvent(java.lang.String path, LoopMode loopMode) creates a sound track from the given resource path

Method Summary

Modifier and Type	Method and Description
AudioNode	getAudioNode() Returns the underlying audio node of this sound track
void	initEvent(Application app, Cinematic cinematic) Initialize this event (called internally only).
void	onPause() Implement this method with code that you want to execute when the event is paused.
void	onPlay() Implement this method with code that you want to execute when the event is started.
void	onStop() Implement this method with code that you want to execute when the event is stopped.
void	onUpdate(float tpf) Implement this method with the code that you want to execute on update (only called when the event is playing).
void	read(JmeImporter im) Used for serialization only.
void	setLoopMode(LoopMode loopMode) Sets the loopMode of the animation.
void	setTime(float time) Fast-forward the event to the given timestamp.
void	write(JmeExporter ex) Used for serialization only.

Methods inherited from class com.jme3.cinematic.events.AbstractCinematicEvent

addListener, dispose, forceStop, getDuration, getInitialDuration, getLoopMode, getPlayState, getSpeed, getTime, internalUpdate, pause, play, removeListener, setInitialDuration, setSpeed, stop

Methods inherited from class java.lang.Object

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

Field Detail

path

protected java.lang.String path

audioNode

protected AudioNode audioNode

stream

protected boolean stream

Constructor Detail

SoundEvent

public SoundEvent(java.lang.String path)

creates a sound track from the given resource path

Parameters:

path - the path to an audio file (ie : "Sounds/mySound.wav")

SoundEvent

public SoundEvent(java.lang.String path,
                  boolean stream)

creates a sound track from the given resource path

Parameters:

path - the path to an audio file (ie : "Sounds/mySound.wav")

stream - true to make the audio data streamed

SoundEvent

public SoundEvent(java.lang.String path,
                  boolean stream,
                  float initialDuration)

creates a sound track from the given resource path

Parameters:

path - the path to an audio file (ie : "Sounds/mySound.wav")

stream - true to make the audio data streamed

initialDuration - the initial duration of the event

SoundEvent

public SoundEvent(java.lang.String path,
                  boolean stream,
                  LoopMode loopMode)

creates a sound track from the given resource path

Parameters:

path - the path to an audio file (ie : "Sounds/mySound.wav")

stream - true to make the audio data streamed

loopMode - the loopMode

See Also:

LoopMode

SoundEvent

public SoundEvent(java.lang.String path,
                  boolean stream,
                  float initialDuration,
                  LoopMode loopMode)

creates a sound track from the given resource path

Parameters:

path - the path to an audio file (ie : "Sounds/mySound.wav")

stream - true to make the audio data streamed

initialDuration - the initial duration of the event

loopMode - the loopMode

See Also:

LoopMode

SoundEvent

public SoundEvent(java.lang.String path,
                  float initialDuration)

creates a sound track from the given resource path

Parameters:

path - the path to an audio file (ie : "Sounds/mySound.wav")

initialDuration - the initial duration of the event

SoundEvent

public SoundEvent(java.lang.String path,
                  LoopMode loopMode)

creates a sound track from the given resource path

Parameters:

path - the path to an audio file (ie : "Sounds/mySound.wav")

loopMode - the loopMode

See Also:

LoopMode

SoundEvent

public SoundEvent(java.lang.String path,
                  float initialDuration,
                  LoopMode loopMode)

creates a sound track from the given resource path

Parameters:

path - the path to an audio file (ie : "Sounds/mySound.wav")

initialDuration - the initial duration of the event

loopMode - the loopMode

See Also:

LoopMode

SoundEvent

public SoundEvent()

creates a sound event used for serialization

Method Detail

initEvent

public void initEvent(Application app,
                      Cinematic cinematic)

Description copied from class: AbstractCinematicEvent

Initialize this event (called internally only).

Specified by:

initEvent in interface CinematicEvent

Overrides:

initEvent in class AbstractCinematicEvent

Parameters:

app - ignored

cinematic - ignored

setTime

public void setTime(float time)

Description copied from class: AbstractCinematicEvent

Fast-forward the event to the given timestamp. Time=0 is the start of the event.

Specified by:

setTime in interface CinematicEvent

Overrides:

setTime in class AbstractCinematicEvent

Parameters:

time - the time to fast forward to.

onPlay

public void onPlay()

Description copied from class: AbstractCinematicEvent

Implement this method with code that you want to execute when the event is started.

Specified by:

onPlay in class AbstractCinematicEvent

onStop

public void onStop()

Description copied from class: AbstractCinematicEvent

Implement this method with code that you want to execute when the event is stopped.

Specified by:

onStop in class AbstractCinematicEvent

onPause

public void onPause()

Description copied from class: AbstractCinematicEvent

Implement this method with code that you want to execute when the event is paused.

Specified by:

onPause in class AbstractCinematicEvent

onUpdate

public void onUpdate(float tpf)

Description copied from class: AbstractCinematicEvent

Implement this method with the code that you want to execute on update (only called when the event is playing).

Specified by:

onUpdate in class AbstractCinematicEvent

Parameters:

tpf - time per frame

getAudioNode

public AudioNode getAudioNode()

Returns the underlying audio node of this sound track

Returns:

the pre-existing instance

setLoopMode

public void setLoopMode(LoopMode loopMode)

Description copied from class: AbstractCinematicEvent

Sets the loopMode of the animation.

Specified by:

setLoopMode in interface CinematicEvent

Overrides:

setLoopMode in class AbstractCinematicEvent

Parameters:

loopMode - the desired mode (default=DontLoop)

See Also:

LoopMode

write

public void write(JmeExporter ex)
           throws java.io.IOException

Description copied from class: AbstractCinematicEvent

Used for serialization only.

Specified by:

write in interface Savable

Overrides:

write in class AbstractCinematicEvent

Parameters:

ex - exporter

Throws:

java.io.IOException - from the exporter

read

public void read(JmeImporter im)
          throws java.io.IOException

Description copied from class: AbstractCinematicEvent

Used for serialization only.

Specified by:

read in interface Savable

Overrides:

read in class AbstractCinematicEvent

Parameters:

im - importer

Throws:

java.io.IOException - from the importer