.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "pods::SDLx::Sound 3pm"
.TH pods::SDLx::Sound 3pm 2024-03-28 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
SDLx::Sound \- SDL sound extension
.SH CATEGORY
.IX Header "CATEGORY"
Extension
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use SDLx::Sound;
\&
\&    my $snd = SDLx::Sound\->new();
\&    
\&    # loads and plays a single sound now
\&    $snd\->play(\*(Aqmyfile.wav\*(Aq);
\&
\&    # load a single file
\&    $snd\->load(\*(AqtheSound.aif\*(Aq);
\&
\&    # plays it or all loaded files
\&    $snd\->play();
\&
\&    # more sounds
\&    my %files = (
\&        channel_01 => "/my_sound1.wav",
\&        channel_02 => "/my_sound2.ogg"
\&    );
\&
\&    # times sounds bangs
\&    my %times = (
\&        channel_01 => 0,      # start
\&        channel_01 => 1256,   # milliseconds
\&        channel_02 => 2345
\&    );
\&    
\&    # Load files in channels for realtime play
\&    $snd\->load(%files);
\&
\&    # sets sound channel_01 loudness
\&    $snd\->loud(\*(Aqchannel_01\*(Aq, 80);       # loud at 80%
\&    $snd\->play(%times);                 # play loaded files at times
\&    $snd\->play;                         # play again
\&
\&    # plays sound channel_01 at 578 milliseconds from now
\&    $snd\->play(\*(Aqchannel_01\*(Aq, 578);
\&
\&    # fades sound 
\&    $snd\->fade(\*(Aqchannel_02\*(Aq, 2345, 3456, \-20);
\&
\&    # in a single act do the whole Sound
\&    my $snd = SDLx::Sound\->new(
\&        files => (
\&            channel_01 => "/my_sound1.wav",
\&            channel_02 => "/my_sound2.ogg"
\& 
\&        ), 
\&        loud  => (
\&            channel_01 => 80,
\&            channel_02 => 75
\&        ),
\&        times => (
\&            channel_01 => 0,      # start
\&            channel_01 => 1256,   # milliseconds
\&            channel_02 => 2345
\&        ),
\&        fade  => (
\&            channel_02 => [2345, 3456, \-20]
\&        )
\&    )\->play();
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
You can think about the SDLx::Sound at 2 approaches.
.IP \(bu 4
A simple sound or
.IP \(bu 4
The sound of your game or app.
.PP
Your application will say what the best approach.
.PP
In a taste that resembles to perl and to SDL, our SDLx:Sound hooks at SDL::Audio and SDL::Mixer with a graceful and simple interface that can offer to monks a modern perlish way to manage sounds.
.PP
An SDLx::Sound object can load sounds from filesystem, play it, adjust this loudness level or stops the sound.
.PP
Each sound will play in the next available channel, so it can be handled isolately.
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
Returns a new instance of SDLx::Sound
.SS load
.IX Subsection "load"
.SS play
.IX Subsection "play"
.Vb 1
\& $sdlx_sound\->play(\*(Aqfile.wav\*(Aq);
.Ve
.PP
Play a file
.SS pause
.IX Subsection "pause"
.SS resume
.IX Subsection "resume"
.SS stop
.IX Subsection "stop"
.SH AUTHORS
.IX Header "AUTHORS"
See "AUTHORS" in SDL.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.