sdl_audiospec(3) [opensolaris man page]

SDL_AudioSpec(3)						 SDL API Reference						  SDL_AudioSpec(3)

NAME

       SDL_AudioSpec - Audio Specification Structure

STRUCTURE DEFINITION

       typedef struct{
	 int freq;
	 Uint16 format;
	 Uint8 channels;
	 Uint8 silence;
	 Uint16 samples;
	 Uint32 size;
	 void (*callback)(void *userdata, Uint8 *stream, int len);
	 void *userdata;
       } SDL_AudioSpec;

STRUCTURE DATA

       freq		   Audio frequency in samples per second

       format		   Audio data format

       channels 	   Number of channels: 1 mono, 2 stereo

       silence		   Audio buffer silence value (calculated)

       samples		   Audio buffer size in samples

       size		   Audio buffer size in bytes (calculated)

       callback(..)	   Callback function for filling the audio buffer

       userdata 	   Pointer the user data which is passed to the callback function

DESCRIPTION

       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. We  will  detail  these  common
       members here.

       freq		   The	number	of samples sent to the sound device every second. Common values are 11025, 22050 and 44100. The higher the
			   better.

       format		   Specifies the size and type of each sample element

       AUDIO_U8

       AUDIO_S8

       AUDIO_U16 or AUDIO_U16LSB

       AUDIO_S16 or AUDIO_S16LSB

       AUDIO_U16MSB

       AUDIO_S16MSB

       AUDIO_U16SYS

       AUDIO_S16SYS

       channels 	   The number of seperate sound channels. 1 is mono (single channel), 2 is stereo (dual channel).

       samples		   When used with SDL_OpenAudio this refers to the size of the audio buffer in samples. A sample a chunk of audio data	of
			   the size specified in format mulitplied by the number of channels. When the SDL_AudioSpec is used with SDL_LoadWAV sam-
			   ples is set to 4096.

SEE ALSO

       SDL_OpenAudio, SDL_LoadWAV

SDL
							      Tue 11 Sep 2001, 22:58						  SDL_AudioSpec(3)

pods::SDL::AudioSpec(3pm)				User Contributed Perl Documentation				 pods::SDL::AudioSpec(3pm)

NAME

       SDL::AudioSpec -- SDL Bindings for structure SDL::AudioSpec

CATEGORY

       Core, Audio, Structure

SYNOPSIS

	use SDL;
	use SDL::AudioSpec;

	SDL::init(SDL_INIT_AUDIO);

	my $audio_spec = SDL::AudioSpec->new();

	    $audio_spec->freq(22050);	       # 22050Hz - FM Radio quality
	    $audio_spec->format(AUDIO_S16SYS); # 16-bit signed audio
	    $audio_spec->samples(8192);        # Large audio buffer reduces risk of dropouts but increases response time
	    $audio_spec->channels(1);	       # Mono
	    $audio_spec->callback('main::callback');

	sub callback
	{
	    # do something here
	}

DESCRIPTION

       The "SDL::AudioSpec" structure is used to describe the format of some audio data. This structure is used by "SDL::Audio::open_audio" and
       "SDL::Audio::load_wav".	While all fields are used by "SDL::Audio::open_audio", only "freq", "format", "samples" and "channels" are used by
       "SDL::Audio::load_wav".	We will detail these common members here.

METHODS

   freq
       The number of samples sent to the sound device every second. Common values are 11025, 22050 and 44100. The higher the better.

   format
       Specifies the size and type of each sample element. Values it can take are:

       AUDIO_U8
	   Unsigned 8-bit samples.

       AUDIO_S8
	   Signed 8-bit samples.

       AUDIO_U16 or AUDIO_U16LSB
	   not supported by all hardware (unsigned 16-bit little-endian)

       AUDIO_S16 or AUDIO_S16LSB
	   not supported by all hardware (signed 16-bit little-endian)

       AUDIO_U16MSB
	   not supported by all hardware (unsigned 16-bit big-endian)

       AUDIO_S16MSB
	   not supported by all hardware (signed 16-bit big-endian)

       AUDIO_U16SYS
	   Either AUDIO_U16LSB or AUDIO_U16MSB depending on hardware CPU endianness

       AUDIO_S16SYS
	   Either AUDIO_S16LSB or AUDIO_S16MSB depending on hardware CPU endianness

   channels
       The number of separate sound channels. 1 is mono (single channel), 2 is stereo (dual channel).

   samples
       When used with "SDL::Audio::open_audio" this refers to the size of the audio buffer in samples. A sample is a chunk of audio data of the
       size specified in format multiplied by the number of channels. When the "SDL::AudioSpec" is used with "SDL::Audio::load_wav" samples is set
       to 4096.

   callback
       To be documented.

AUTHORS

       See "AUTHORS" in SDL.

perl v5.14.2							    2012-05-28						 pods::SDL::AudioSpec(3pm)