Skip to main content

SoundPlayer

Complete API reference for SoundPlayer, including constructors, attributes, virtual attributes, and methods.

Package: JAVARuntime

Category: Sound

Component: yes


public class SoundPlayer extends Component

Constructors

SignatureDescription
SoundPlayer(SoundPlayer)Executes SoundPlayer and returns after the underlying engine call finishes.
SoundPlayer()Executes SoundPlayer and returns after the underlying engine call finishes.

Attributes

NameTypeDescription
instanceSoundPlayerRepresents the instance value stored on this instance. Read or assign to update the property.

Virtual Attributes

NameTypeAccessDescription
diameterfloatget/setVirtual attribute exposed by getDiameter. Access it like a field to read or write the underlying value.
loadModeLoadModeget/setVirtual attribute exposed by getLoadMode. Access it like a field to read or write the underlying value.
loopbooleanget/setVirtual attribute exposed by isLoop. Access it like a field to read or write the underlying value.
modeModeget/setVirtual attribute exposed by getMode. Access it like a field to read or write the underlying value.
pausedbooleangetVirtual attribute exposed by isPaused. Access it like a field to read or write the underlying value.
pitchfloatget/setVirtual attribute exposed by getPitch. Access it like a field to read or write the underlying value.
playingbooleangetVirtual attribute exposed by isPlaying. Access it like a field to read or write the underlying value.
speedfloatget/setVirtual attribute exposed by getSpeed. Access it like a field to read or write the underlying value.
stoppedbooleangetVirtual attribute exposed by isStopped. Access it like a field to read or write the underlying value.
volumefloatget/setVirtual attribute exposed by getVolume. Access it like a field to read or write the underlying value.

Methods

SignatureReturnsDescription
setSoundFile(SoundFile)voidSets or updates the sound file.
setSoundFile(File)voidSets or updates the sound file.
play()voidExecutes play and returns after the underlying engine call finishes.
stop()voidExecutes stop and returns after the underlying engine call finishes.
pause()voidExecutes pause and returns after the underlying engine call finishes.
unPause()voidExecutes unPause and returns after the underlying engine call finishes.
seekTo(int)voidExecutes seekTo and returns after the underlying engine call finishes.
componentClassMatch(Component, Component)booleanExecutes componentClassMatch and returns after the underlying engine call finishes.
getEngineComponent()ComponentExecutes getEngineComponent and returns after the underlying engine call finishes.