libGDX 1.14.2 · com.badlogic.gdx.backends.lwjgl.audio.OpenALSound

Modifier and Type	Field and Description
private final OpenALLwjglAudio	audio
private int	bufferID
private int	channels
private float	duration
private int	sampleRate
private String	type

Access	Constructor and Description
public	OpenALSound(OpenALLwjglAudio audio)

Method Summary

Modifier and Type	Method and Description
public void	dispose() Implements com.badlogic.gdx.audio.Sound.dispose. Releases all the resources.
public float	duration() Returns the length of the sound in seconds.
public int	getChannels() Returns the number of channels of the sound (1 for mono, 2 for stereo).
public int	getRate() Returns the original sample rate of the sound in Hz.
public String	getType()
public long	loop() Implements com.badlogic.gdx.audio.Sound.loop. Plays the sound, looping.
public long	loop(float volume) Implements com.badlogic.gdx.audio.Sound.loop. Plays the sound, looping.
public long	loop(float volume, float pitch, float pan) Implements com.badlogic.gdx.audio.Sound.loop. Plays the sound, looping.
public void	pause() Implements com.badlogic.gdx.audio.Sound.pause. Pauses all instances of this sound.
public void	pause(long soundId) Implements com.badlogic.gdx.audio.Sound.pause. Pauses the sound instance with the given id as returned by `play()` or `play(float)`.
public long	play() Implements com.badlogic.gdx.audio.Sound.play. Plays the sound.
public long	play(float volume) Implements com.badlogic.gdx.audio.Sound.play. Plays the sound.
public long	play(float volume, float pitch, float pan) Implements com.badlogic.gdx.audio.Sound.play. Plays the sound.
public void	resume() Implements com.badlogic.gdx.audio.Sound.resume. Resumes all paused instances of this sound.
public void	resume(long soundId) Implements com.badlogic.gdx.audio.Sound.resume. Resumes the sound instance with the given id as returned by `play()` or `play(float)`.
public void	setLooping(long soundId, boolean looping) Implements com.badlogic.gdx.audio.Sound.setLooping. Sets the sound instance with the given id to be looping.
public void	setPan(long soundId, float pan, float volume) Implements com.badlogic.gdx.audio.Sound.setPan. Sets the panning and volume of the sound instance with the given id as returned by `play()` or `play(float)`.
public void	setPitch(long soundId, float pitch) Implements com.badlogic.gdx.audio.Sound.setPitch. Changes the pitch multiplier of the sound instance with the given id as returned by `play()` or `play(float)`.
public void	setType(String The type of audio, such as mp3, ogg or wav. type)
pack-priv void	setup(byte[] Byte array of raw PCM data to be played. pcm, int The number of channels for the sound. Most commonly 1 (for mono) or 2 (for stereo). channels, int The number of bits in each sample. Normally 16. Can also be 8, 32 or sometimes 64. bitDepth, int The number of samples to be played each second. Commonly 44100; can be anything within reason. sampleRate) Prepare our sound for playback!
public void	setVolume(long soundId, float volume) Implements com.badlogic.gdx.audio.Sound.setVolume. Changes the volume of the sound instance with the given id as returned by `play()` or `play(float)`.
public void	stop() Implements com.badlogic.gdx.audio.Sound.stop. Stops playing all instances of this sound.
public void	stop(long soundId) Implements com.badlogic.gdx.audio.Sound.stop. Stops the sound instance with the given id as returned by `play()` or `play(float)`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

audio	back to summary
private final OpenALLwjglAudio audio

bufferID	back to summary
private int bufferID

channels	back to summary
private int channels

duration	back to summary
private float duration

sampleRate	back to summary
private int sampleRate

type	back to summary
private String type

OpenALSound	back to summary
public OpenALSound(OpenALLwjglAudio audio)

Method Detail

dispose	back to summary
public void dispose() Implements com.badlogic.gdx.audio.Sound.dispose. Doc from com.badlogic.gdx.audio.Sound.dispose. Releases all the resources.

dispose

back to summary

public void dispose()

Implements com.badlogic.gdx.audio.Sound.dispose.

Doc from com.badlogic.gdx.audio.Sound.dispose.

Releases all the resources.

duration	back to summary
public float duration() Returns the length of the sound in seconds.

getChannels	back to summary
public int getChannels() Returns the number of channels of the sound (1 for mono, 2 for stereo).

getRate	back to summary
public int getRate() Returns the original sample rate of the sound in Hz.

getType	back to summary
public String getType()

loop	back to summary
public long loop() Implements com.badlogic.gdx.audio.Sound.loop. Doc from com.badlogic.gdx.audio.Sound.loop. Plays the sound, looping. If the sound is already playing, it will be played again, concurrently.

loop

back to summary

public long loop()

Implements com.badlogic.gdx.audio.Sound.loop.

Doc from com.badlogic.gdx.audio.Sound.loop.

Plays the sound, looping. If the sound is already playing, it will be played again, concurrently.

loop back to summary

loop	back to summary
public long loop(float volume) Implements com.badlogic.gdx.audio.Sound.loop. Doc from com.badlogic.gdx.audio.Sound.loop. Plays the sound, looping. If the sound is already playing, it will be played again, concurrently. You need to stop the sound via a call to `stop(long)` using the returned id. Annotations @Override

public long loop(float volume)

Implements com.badlogic.gdx.audio.Sound.loop.

Doc from com.badlogic.gdx.audio.Sound.loop.

Plays the sound, looping. If the sound is already playing, it will be played again, concurrently. You need to stop the sound via a call to stop(long) using the returned id.

Annotations

@Override

loop back to summary

loop	back to summary
public long loop(float volume, float pitch, float pan) Implements com.badlogic.gdx.audio.Sound.loop. Doc from com.badlogic.gdx.audio.Sound.loop. Plays the sound, looping. If the sound is already playing, it will be played again, concurrently. You need to stop the sound via a call to `stop(long)` using the returned id. Note that (with the exception of the web backend) panning only works for mono sounds, not for stereo sounds! Annotations @Override

public long loop(float volume, float pitch, float pan)

Implements com.badlogic.gdx.audio.Sound.loop.

Doc from com.badlogic.gdx.audio.Sound.loop.

Plays the sound, looping. If the sound is already playing, it will be played again, concurrently. You need to stop the sound via a call to stop(long) using the returned id. Note that (with the exception of the web backend) panning only works for mono sounds, not for stereo sounds!

Annotations

@Override

pause	back to summary
public void pause() Implements com.badlogic.gdx.audio.Sound.pause. Doc from com.badlogic.gdx.audio.Sound.pause. Pauses all instances of this sound. Annotations @Override

pause

back to summary

public void pause()

Implements com.badlogic.gdx.audio.Sound.pause.

Doc from com.badlogic.gdx.audio.Sound.pause.

Pauses all instances of this sound.

Annotations

@Override

pause back to summary

pause	back to summary
public void pause(long soundId) Implements com.badlogic.gdx.audio.Sound.pause. Doc from com.badlogic.gdx.audio.Sound.pause. Pauses the sound instance with the given id as returned by `play()` or `play(float)`. If the sound is no longer playing, this has no effect. Annotations @Override

public void pause(long soundId)

Implements com.badlogic.gdx.audio.Sound.pause.

Doc from com.badlogic.gdx.audio.Sound.pause.

Pauses the sound instance with the given id as returned by play() or play(float). If the sound is no longer playing, this has no effect.

Annotations

@Override

play	back to summary
public long play() Implements com.badlogic.gdx.audio.Sound.play. Doc from com.badlogic.gdx.audio.Sound.play. Plays the sound. If the sound is already playing, it will be played again, concurrently.

play

back to summary

public long play()

Implements com.badlogic.gdx.audio.Sound.play.

Doc from com.badlogic.gdx.audio.Sound.play.

Plays the sound. If the sound is already playing, it will be played again, concurrently.

play	back to summary
public long play(float volume) Implements com.badlogic.gdx.audio.Sound.play. Doc from com.badlogic.gdx.audio.Sound.play. Plays the sound. If the sound is already playing, it will be played again, concurrently.

play

back to summary

public long play(float volume)

Implements com.badlogic.gdx.audio.Sound.play.

Doc from com.badlogic.gdx.audio.Sound.play.

Plays the sound. If the sound is already playing, it will be played again, concurrently.

play	back to summary
public long play(float volume, float pitch, float pan) Implements com.badlogic.gdx.audio.Sound.play. Doc from com.badlogic.gdx.audio.Sound.play. Plays the sound. If the sound is already playing, it will be played again, concurrently. Note that (with the exception of the web backend) panning only works for mono sounds, not for stereo sounds! Annotations @Override

play

back to summary

public long play(float volume, float pitch, float pan)

Implements com.badlogic.gdx.audio.Sound.play.

Doc from com.badlogic.gdx.audio.Sound.play.

Plays the sound. If the sound is already playing, it will be played again, concurrently. Note that (with the exception of the web backend) panning only works for mono sounds, not for stereo sounds!

Annotations

@Override

resume	back to summary
public void resume() Implements com.badlogic.gdx.audio.Sound.resume. Doc from com.badlogic.gdx.audio.Sound.resume. Resumes all paused instances of this sound. Annotations @Override

resume

back to summary

public void resume()

Implements com.badlogic.gdx.audio.Sound.resume.

Doc from com.badlogic.gdx.audio.Sound.resume.

Resumes all paused instances of this sound.

Annotations

@Override

resume back to summary

resume	back to summary
public void resume(long soundId) Implements com.badlogic.gdx.audio.Sound.resume. Doc from com.badlogic.gdx.audio.Sound.resume. Resumes the sound instance with the given id as returned by `play()` or `play(float)`. If the sound is not paused, this has no effect. Annotations @Override

public void resume(long soundId)

Implements com.badlogic.gdx.audio.Sound.resume.

Doc from com.badlogic.gdx.audio.Sound.resume.

Resumes the sound instance with the given id as returned by play() or play(float). If the sound is not paused, this has no effect.

Annotations

@Override

setLooping	back to summary
public void setLooping(long soundId, boolean looping) Implements com.badlogic.gdx.audio.Sound.setLooping. Doc from com.badlogic.gdx.audio.Sound.setLooping. Sets the sound instance with the given id to be looping. If the sound is no longer playing this has no effect.s Annotations @Override

setLooping

back to summary

public void setLooping(long soundId, boolean looping)

Implements com.badlogic.gdx.audio.Sound.setLooping.

Doc from com.badlogic.gdx.audio.Sound.setLooping.

Sets the sound instance with the given id to be looping. If the sound is no longer playing this has no effect.s

Annotations

@Override

setPan back to summary

setPan	back to summary
public void setPan(long soundId, float pan, float volume) Implements com.badlogic.gdx.audio.Sound.setPan. Doc from com.badlogic.gdx.audio.Sound.setPan. Sets the panning and volume of the sound instance with the given id as returned by `play()` or `play(float)`. If the sound is no longer playing, this has no effect. Note that panning only works for mono sounds, not for stereo sounds! Annotations @Override

public void setPan(long soundId, float pan, float volume)

Implements com.badlogic.gdx.audio.Sound.setPan.

Doc from com.badlogic.gdx.audio.Sound.setPan.

Sets the panning and volume of the sound instance with the given id as returned by play() or play(float). If the sound is no longer playing, this has no effect. Note that panning only works for mono sounds, not for stereo sounds!

Annotations

@Override

setPitch back to summary

setPitch	back to summary
public void setPitch(long soundId, float pitch) Implements com.badlogic.gdx.audio.Sound.setPitch. Doc from com.badlogic.gdx.audio.Sound.setPitch. Changes the pitch multiplier of the sound instance with the given id as returned by `play()` or `play(float)`. If the sound is no longer playing, this has no effect. Annotations @Override

public void setPitch(long soundId, float pitch)

Implements com.badlogic.gdx.audio.Sound.setPitch.

Doc from com.badlogic.gdx.audio.Sound.setPitch.

Changes the pitch multiplier of the sound instance with the given id as returned by play() or play(float). If the sound is no longer playing, this has no effect.

Annotations

@Override

setType	back to summary
public void setType(String type) Parameters type:String The type of audio, such as mp3, ogg or wav.

setup	back to summary
pack-priv void setup(byte[] pcm, int channels, int bitDepth, int sampleRate) Prepare our sound for playback! Parameters pcm:byte[] Byte array of raw PCM data to be played. channels:int The number of channels for the sound. Most commonly 1 (for mono) or 2 (for stereo). bitDepth:int The number of bits in each sample. Normally 16. Can also be 8, 32 or sometimes 64. sampleRate:int The number of samples to be played each second. Commonly 44100; can be anything within reason.

setup

back to summary

pack-priv void setup(byte[] pcm, int channels, int bitDepth, int sampleRate)

Prepare our sound for playback!

Parameters

pcm:byte[]: Byte array of raw PCM data to be played.
channels:int: The number of channels for the sound. Most commonly 1 (for mono) or 2 (for stereo).
bitDepth:int: The number of bits in each sample. Normally 16. Can also be 8, 32 or sometimes 64.
sampleRate:int: The number of samples to be played each second. Commonly 44100; can be anything within reason.

setVolume back to summary

setVolume	back to summary
public void setVolume(long soundId, float volume) Implements com.badlogic.gdx.audio.Sound.setVolume. Doc from com.badlogic.gdx.audio.Sound.setVolume. Changes the volume of the sound instance with the given id as returned by `play()` or `play(float)`. If the sound is no longer playing, this has no effect. Annotations @Override

public void setVolume(long soundId, float volume)

Implements com.badlogic.gdx.audio.Sound.setVolume.

Doc from com.badlogic.gdx.audio.Sound.setVolume.

Changes the volume of the sound instance with the given id as returned by play() or play(float). If the sound is no longer playing, this has no effect.

Annotations

@Override

stop	back to summary
public void stop() Implements com.badlogic.gdx.audio.Sound.stop. Doc from com.badlogic.gdx.audio.Sound.stop. Stops playing all instances of this sound.

stop

back to summary

public void stop()

Implements com.badlogic.gdx.audio.Sound.stop.

Doc from com.badlogic.gdx.audio.Sound.stop.

Stops playing all instances of this sound.

stop back to summary

stop	back to summary
public void stop(long soundId) Implements com.badlogic.gdx.audio.Sound.stop. Doc from com.badlogic.gdx.audio.Sound.stop. Stops the sound instance with the given id as returned by `play()` or `play(float)`. If the sound is no longer playing, this has no effect. Annotations @Override

public void stop(long soundId)

Implements com.badlogic.gdx.audio.Sound.stop.

Doc from com.badlogic.gdx.audio.Sound.stop.

Stops the sound instance with the given id as returned by play() or play(float). If the sound is no longer playing, this has no effect.

Annotations

@Override

public Class OpenALSound

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail