1\section{deprecated.h File Reference}
2\label{deprecated_8h}\index{deprecated.h@{deprecated.h}}
3Deprecated interfaces.
4
5
6\subsection*{Typedefs}
7\begin{CompactItemize}
8\item
9typedef {\bf FishSoundDecoded\_\-Float} {\bf FishSoundDecoded}
10\begin{CompactList}\small\item\em DEPRECATED TYPE. \item\end{CompactList}\end{CompactItemize}
11\subsection*{Functions}
12\begin{CompactItemize}
13\item
14int {\bf fish\_\-sound\_\-set\_\-decoded\_\-callback} ({\bf FishSound} $\ast$fsound, {\bf FishSoundDecoded} decoded, void $\ast$user\_\-data)
15\begin{CompactList}\small\item\em DEPRECATED FUNCTION. \item\end{CompactList}\item
16int {\bf fish\_\-sound\_\-set\_\-interleave} ({\bf FishSound} $\ast$fsound, int interleave)
17\begin{CompactList}\small\item\em DEPRECATED FUNCTION. \item\end{CompactList}\item
18long {\bf fish\_\-sound\_\-encode} ({\bf FishSound} $\ast$fsound, float $\ast$$\ast$pcm, long frames)
19\begin{CompactList}\small\item\em DEPRECATED FUNCTION. \item\end{CompactList}\end{CompactItemize}
20
21
22\subsection{Detailed Description}
23Deprecated interfaces.
24
25
26
27\subsection{Typedef Documentation}
28\index{deprecated.h@{deprecated.h}!FishSoundDecoded@{FishSoundDecoded}}
29\index{FishSoundDecoded@{FishSoundDecoded}!deprecated.h@{deprecated.h}}
30\subsubsection[{FishSoundDecoded}]{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf FishSoundDecoded\_\-Float} {\bf FishSoundDecoded}}\label{deprecated_8h_30f4221d1810083d5907749dcacf8df3}
31
32
33DEPRECATED TYPE.
34
35Signature of a callback for libfishsound to call when it has decoded PCM audio data, and you want this provided as floats using the current interleave method as set by \doxyref{fish\_\-sound\_\-set\_\-interleave()}{p.}{deprecated_8h_8e6b76134675d948015fe4afa3fe4104}.
36
37\subsection{Function Documentation}
38\index{deprecated.h@{deprecated.h}!fish\_\-sound\_\-encode@{fish\_\-sound\_\-encode}}
39\index{fish\_\-sound\_\-encode@{fish\_\-sound\_\-encode}!deprecated.h@{deprecated.h}}
40\subsubsection[{fish\_\-sound\_\-encode}]{\setlength{\rightskip}{0pt plus 5cm}long fish\_\-sound\_\-encode ({\bf FishSound} $\ast$ {\em fsound}, \/  float $\ast$$\ast$ {\em pcm}, \/  long {\em frames})}\label{deprecated_8h_6cd1117b2d09f0f9589c8b10cccae75c}
41
42
43DEPRECATED FUNCTION.
44
45Encode a block of audio \begin{Desc}
46\item[Parameters:]
47\begin{description}
48\item[{\em fsound}]A FishSound$\ast$ handle (created with mode FISH\_\-SOUND\_\-ENCODE) \item[{\em pcm}]The audio data to encode \item[{\em frames}]A count of frames to encode \end{description}
49\end{Desc}
50\begin{Desc}
51\item[Returns:]The number of frames encoded \end{Desc}
52\begin{Desc}
53\item[Note:]For multichannel audio, the audio data is interpreted according to the current PCM style \end{Desc}
54\index{deprecated.h@{deprecated.h}!fish\_\-sound\_\-set\_\-decoded\_\-callback@{fish\_\-sound\_\-set\_\-decoded\_\-callback}}
55\index{fish\_\-sound\_\-set\_\-decoded\_\-callback@{fish\_\-sound\_\-set\_\-decoded\_\-callback}!deprecated.h@{deprecated.h}}
56\subsubsection[{fish\_\-sound\_\-set\_\-decoded\_\-callback}]{\setlength{\rightskip}{0pt plus 5cm}int fish\_\-sound\_\-set\_\-decoded\_\-callback ({\bf FishSound} $\ast$ {\em fsound}, \/  {\bf FishSoundDecoded} {\em decoded}, \/  void $\ast$ {\em user\_\-data})}\label{deprecated_8h_dd6f678e9e38d3b27bd8e5b95c2547f1}
57
58
59DEPRECATED FUNCTION.
60
61Set the callback for libfishsound to call when it has a block of decoded PCM audio ready, and you want this provided as floats using the current interleave method as set by \doxyref{fish\_\-sound\_\-set\_\-interleave()}{p.}{deprecated_8h_8e6b76134675d948015fe4afa3fe4104}. This function, and \doxyref{fish\_\-sound\_\-set\_\-interleave()}{p.}{deprecated_8h_8e6b76134675d948015fe4afa3fe4104}, have been superceded by the typesafe fish\_\-sound\_\-set\_\-decoded\_\-TYPE() callbacks, such as \doxyref{fish\_\-sound\_\-set\_\-decoded\_\-float()}{p.}{decode_8h_e821800e11efe106676d7ce4c743328a} or \doxyref{fish\_\-sound\_\-set\_\-decoded\_\-float\_\-ilv()}{p.}{decode_8h_3a4055f579b841a5c05d2a2865f5e939}.
62
63\begin{Desc}
64\item[Parameters:]
65\begin{description}
66\item[{\em fsound}]A FishSound$\ast$ handle (created with mode FISH\_\-SOUND\_\-DECODE) \item[{\em decoded}]The callback to call \item[{\em user\_\-data}]Arbitrary user data to pass to the callback \end{description}
67\end{Desc}
68\begin{Desc}
69\item[Returns:]0 on success, -1 on failure \end{Desc}
70\index{deprecated.h@{deprecated.h}!fish\_\-sound\_\-set\_\-interleave@{fish\_\-sound\_\-set\_\-interleave}}
71\index{fish\_\-sound\_\-set\_\-interleave@{fish\_\-sound\_\-set\_\-interleave}!deprecated.h@{deprecated.h}}
72\subsubsection[{fish\_\-sound\_\-set\_\-interleave}]{\setlength{\rightskip}{0pt plus 5cm}int fish\_\-sound\_\-set\_\-interleave ({\bf FishSound} $\ast$ {\em fsound}, \/  int {\em interleave})}\label{deprecated_8h_8e6b76134675d948015fe4afa3fe4104}
73
74
75DEPRECATED FUNCTION.
76
77Set the PCM format used by a FishSound object. The default value is non-interleaved. Prior to libfishsound 0.7.0, you would (optionally) specify whether you wanted to receive interleaved or per-channel PCM data using \doxyref{fish\_\-sound\_\-set\_\-interleave()}{p.}{deprecated_8h_8e6b76134675d948015fe4afa3fe4104}, the default being per-channel (non-interleaved) PCM. Whether or not your decoded callback expects interleaved or non-interleaved data is now implied by the particular fish\_\-sound\_\-set\_\-decoded\_\-TYPE() method you use to set it, such as \doxyref{fish\_\-sound\_\-set\_\-decoded\_\-float()}{p.}{decode_8h_e821800e11efe106676d7ce4c743328a} or \doxyref{fish\_\-sound\_\-set\_\-decoded\_\-float\_\-ilv()}{p.}{decode_8h_3a4055f579b841a5c05d2a2865f5e939}.
78
79\begin{Desc}
80\item[Parameters:]
81\begin{description}
82\item[{\em fsound}]A FishSound$\ast$ handle \item[{\em interleave}]Whether to use interleaved PCM or not. Valid values are 0 for non-interleaved, and 1 for interleaved. \end{description}
83\end{Desc}
84\begin{Desc}
85\item[Return values:]
86\begin{description}
87\item[{\em 0}]Success \item[{\em -1}]Invalid {\em fsound\/} \end{description}
88\end{Desc}
89