sdljava.audio

Class SDLAudioSpec

public class SDLAudioSpec extends Object

The SDL_AudioSpec structure is used to describe the format of some audio data. This structure is used by SDL_OpenAudio and SDL_LoadWAV. While all fields are used by SDL_OpenAudio, only freq, format, samples and channels are used by SDL_LoadWAV.

Version: $Id: SDLAudioSpec.java,v 1.5 2004/12/29 19:11:52 ivan_ganza Exp $

Field Summary
SDL_AudioSpec	swigAudioSpec

Constructor Summary
	SDLAudioSpec()

Method Summary
short	getChannels()
int	getFormat()
int	getFreq()
int	getSamples()
short	getSilence()
long	getSize()
SDL_AudioSpec	getSwigAudioSpec() Gets the value of swigAudioSpec
void	setChannels(int channels) Set number of channels (1-mono, 2-stereo)
void	setFormat(int format) Set Audio data format
void	setFreq(int freq) Set Audio frequency in samples per second
void	setSamples(int samples) Set Audio buffer size in samples
void	setSwigAudioSpec(SDL_AudioSpec argSwigAudioSpec) Sets the value of swigAudioSpec
String	toString()

Field Detail

swigAudioSpec

SDL_AudioSpec swigAudioSpec

Constructor Detail

SDLAudioSpec

public SDLAudioSpec()

Method Detail

getChannels

public short getChannels()

Returns: Number of audio channels (1-mono, 2-stereo)

getFormat

public int getFormat()

Returns: The current Audio data format

getFreq

public int getFreq()

Returns: Audio frequency in samples per second

getSamples

public int getSamples()

Returns: Audio buffer size in samples

getSilence

public short getSilence()

Returns: Audio buffer silence value (calculated)

getSize

public long getSize()

Returns: Audio buffer size in bytes (calculated)

getSwigAudioSpec

public SDL_AudioSpec getSwigAudioSpec()

Gets the value of swigAudioSpec

Returns: the value of swigAudioSpec

setChannels

public void setChannels(int channels)

Set number of channels (1-mono, 2-stereo)

Parameters: channels a short value

setFormat

public void setFormat(int format)

Set Audio data format

Parameters: format an int value

setFreq

public void setFreq(int freq)

Set Audio frequency in samples per second

Parameters: freq an int value

setSamples

public void setSamples(int samples)

Set Audio buffer size in samples

Parameters: samples an int value

setSwigAudioSpec

public void setSwigAudioSpec(SDL_AudioSpec argSwigAudioSpec)

Sets the value of swigAudioSpec

Parameters: argSwigAudioSpec Value to assign to this.swigAudioSpec

toString

public String toString()