/lib/pods/SDL/Mixer/MixChunk.pod

http://github.com/PerlGameDev/SDL · Unknown · 42 lines · 22 code · 20 blank · 0 comment · 0 complexity · 82fcc302b107b4459c6104c887312a71 MD5 · raw file

  1. =pod
  2. =head1 NAME
  3. SDL::Mixer::MixChunk -- SDL Bindings for structure SDL_MixChunk
  4. =head1 CATEGORY
  5. Mixer, Structure
  6. =head1 SYNOPSIS
  7. use SDL;
  8. use SDL::Mixer::MixChunk;
  9. my $mix_chunk = SDL::Mixer::Music::load_WAV('sample.wav');
  10. printf("length of audio data is %d bytes\n", $mix_chunk->alen);
  11. printf("volume is %d\n", $mix_chunk->volume);
  12. =head1 DESCRIPTION
  13. Stores audio data in memory.
  14. B<Note:> It's a bad idea to free a chunk that is still being played...
  15. =head1 METHODS
  16. =head2 alen
  17. length of audio data in bytes
  18. =head2 volume
  19. Per-sample volume, 0-128 (normally C<MIX_MAX_VOLUME> after loading)
  20. =head1 AUTHORS
  21. See L<SDL/AUTHORS>.
  22. =cut