sdl::mixer::samples(3pm) [debian man page]

pods::SDL::Mixer::Samples(3pm)				User Contributed Perl Documentation			    pods::SDL::Mixer::Samples(3pm)

NAME

       SDL::Mixer::Samples - functions for loading sound samples

CATEGORY

       Mixer

METHODS

   get_num_chunk_decoders
	my $num_decoders = SDL::Mixer::Samples::get_num_chunk_decoders();

       Returns the number of available decoders.

   get_chunk_decoder
	my $decoder = SDL::Mixer::Samples::get_chunk_decoder( $num_decoder );

       Returns the decoder for the given id.

   load_WAV
	my $mix_chunk = SDL::Mixer::Samples::load_WAV( $file );

       "load_WAV" reads a file and passes it to SDL::Mixer::Samples::load_WAV_RW. SO this is a quick way to load a file into a chunk.

       Example:

	my $chunk = SDL::Mixer::Samples::load_WAV('sample.wav');

	SDL::Mixer::Channels::play_channel(-1, $chunk, -1);
	SDL::delay(2000);

   load_WAV_RW
	my $mix_chunk = SDL::Mixer::Samples::load_WAV_RW( $rwops, $free );

       "load_WAV_RW" is a macro that loads a sound sample from a a block of memory. It supports WAVE-, MOD-, MIDI-, OGG- and MP3 files (sometimes
       depends on compilation options). It accepts two arguments, the first being a RWops object from which to read and the second being a flag to
       free the source memory after loading is complete or not.

       Returns a Mix_Chunk containing the whole sample on success, or "undef" on error.

       Note: Do not reuse the RWops-object for another call to this function!

       Example:

	my $rwops = SDL::RWOps->new_file('sample.wav', 'r');

	my $chunk = SDL::Mixer::Samples::load_WAV_RW($rwops, 0);

	SDL::Mixer::Channels::play_channel(-1, $chunk, -1);
	SDL::delay(2000);

   quick_load_WAV
	SDL::Mixer::Samples::quick_load_WAV( $buf );

       to be documented.

   quick_load_RAW
	SDL::Mixer::Samples::quick_load_RAW( $buf, $len );

       to be documented.

   volume_chunk
	my $volume_before = SDL::Mixer::Samples::volume_chunk( $chunk, $new_volume );

       "volume_chunk" let you set and get the volume of a chunk. When a chunk is created is volume is "MIX_MAX_VOLUME" (128).

       If you pass "-1" as $new_volume you just get its volume without changing it.

AUTHORS

       See "AUTHORS" in SDL.

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

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)