.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "pods::SDL::AudioSpec 3pm"
.TH pods::SDL::AudioSpec 3pm "2020-11-09" "perl v5.32.0" "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"
SDL::AudioSpec \-\- SDL Bindings for structure SDL::AudioSpec
.SH "CATEGORY"
.IX Header "CATEGORY"
Core, Audio, Structure
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& 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(\*(Aqmain::callback\*(Aq);
\& 
\& sub callback
\& {
\&     # do something here
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`SDL::AudioSpec\*(C'\fR structure is used to describe the format of some audio data. This structure is used by \f(CW\*(C`SDL::Audio::open_audio\*(C'\fR 
and \f(CW\*(C`SDL::Audio::load_wav\*(C'\fR. 
While all fields are used by \f(CW\*(C`SDL::Audio::open_audio\*(C'\fR, only \f(CW\*(C`freq\*(C'\fR, \f(CW\*(C`format\*(C'\fR, \f(CW\*(C`samples\*(C'\fR and \f(CW\*(C`channels\*(C'\fR are used by \f(CW\*(C`SDL::Audio::load_wav\*(C'\fR. 
We will detail these common members here.
.SH "METHODS"
.IX Header "METHODS"
.SS "freq"
.IX Subsection "freq"
The number of samples sent to the sound device every second. Common values are 11025, 22050 and 44100. The higher the better.
.SS "format"
.IX Subsection "format"
Specifies the size and type of each sample element. Values it can take are:
.IP "\s-1AUDIO_U8\s0" 4
.IX Item "AUDIO_U8"
Unsigned 8\-bit samples.
.IP "\s-1AUDIO_S8\s0" 4
.IX Item "AUDIO_S8"
Signed 8\-bit samples.
.IP "\s-1AUDIO_U16\s0 or \s-1AUDIO_U16LSB\s0" 4
.IX Item "AUDIO_U16 or AUDIO_U16LSB"
not supported by all hardware (unsigned 16\-bit little-endian)
.IP "\s-1AUDIO_S16\s0 or \s-1AUDIO_S16LSB\s0" 4
.IX Item "AUDIO_S16 or AUDIO_S16LSB"
not supported by all hardware (signed 16\-bit little-endian)
.IP "\s-1AUDIO_U16MSB\s0" 4
.IX Item "AUDIO_U16MSB"
not supported by all hardware (unsigned 16\-bit big-endian)
.IP "\s-1AUDIO_S16MSB\s0" 4
.IX Item "AUDIO_S16MSB"
not supported by all hardware (signed 16\-bit big-endian)
.IP "\s-1AUDIO_U16SYS\s0" 4
.IX Item "AUDIO_U16SYS"
Either \s-1AUDIO_U16LSB\s0 or \s-1AUDIO_U16MSB\s0 depending on hardware \s-1CPU\s0 endianness
.IP "\s-1AUDIO_S16SYS\s0" 4
.IX Item "AUDIO_S16SYS"
Either \s-1AUDIO_S16LSB\s0 or \s-1AUDIO_S16MSB\s0 depending on hardware \s-1CPU\s0 endianness
.SS "channels"
.IX Subsection "channels"
The number of separate sound channels. 1 is mono (single channel), 2 is stereo (dual channel).
.SS "samples"
.IX Subsection "samples"
When used with \f(CW\*(C`SDL::Audio::open_audio\*(C'\fR 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 \f(CW\*(C`SDL::AudioSpec\*(C'\fR is used with \f(CW\*(C`SDL::Audio::load_wav\*(C'\fR samples is 
set to 4096.
.SS "callback"
.IX Subsection "callback"
To be documented.
.SH "AUTHORS"
.IX Header "AUTHORS"
See \*(L"\s-1AUTHORS\*(R"\s0 in \s-1SDL\s0.