.\" -*- 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::SDL::AudioSpec 3pm"
.TH pods::SDL::AudioSpec 3pm 2024-01-10 "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
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 AUDIO_U8 4
.IX Item "AUDIO_U8"
Unsigned 8\-bit samples.
.IP AUDIO_S8 4
.IX Item "AUDIO_S8"
Signed 8\-bit samples.
.IP "AUDIO_U16 or AUDIO_U16LSB" 4
.IX Item "AUDIO_U16 or AUDIO_U16LSB"
not supported by all hardware (unsigned 16\-bit little-endian)
.IP "AUDIO_S16 or AUDIO_S16LSB" 4
.IX Item "AUDIO_S16 or AUDIO_S16LSB"
not supported by all hardware (signed 16\-bit little-endian)
.IP AUDIO_U16MSB 4
.IX Item "AUDIO_U16MSB"
not supported by all hardware (unsigned 16\-bit big-endian)
.IP AUDIO_S16MSB 4
.IX Item "AUDIO_S16MSB"
not supported by all hardware (signed 16\-bit big-endian)
.IP AUDIO_U16SYS 4
.IX Item "AUDIO_U16SYS"
Either AUDIO_U16LSB or AUDIO_U16MSB depending on hardware CPU endianness
.IP AUDIO_S16SYS 4
.IX Item "AUDIO_S16SYS"
Either AUDIO_S16LSB or AUDIO_S16MSB depending on hardware CPU 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 "AUTHORS" in SDL.