\section{ost::Audio\-File Class Reference} \label{classost_1_1_audio_file}\index{ost::AudioFile@{ost::Audio\-File}} A class used to manipulate audio data. audio file access. {\tt \#include $<$audio.h$>$} \subsection*{Public Methods} \begin{CompactItemize} \item {\bf Audio\-File} (const char $\ast$fname, unsigned long samples=0) \item {\bf Audio\-File} (const char $\ast$fname, {\bf audioinfo\_\-t} $\ast$info, unsigned long min=0) \item {\bf Audio\-File} () \item {\bf $\sim$Audio\-File} () \item void {\bf Open} (const char $\ast$fname) \item void {\bf Create} (const char $\ast$fname, {\bf audioinfo\_\-t} $\ast$info) \item void {\bf Close} (void) \item int {\bf get\-Buffer} (void $\ast$addr, unsigned len) \item int {\bf put\-Buffer} (void $\ast$attr, unsigned len) \item {\bf audioerror\_\-t} {\bf get\-Samples} (void $\ast$addr, unsigned samples) \item {\bf audioerror\_\-t} {\bf put\-Samples} (void $\ast$addr, unsigned samples) \item {\bf audioerror\_\-t} {\bf Skip} (long samples) \item {\bf audioerror\_\-t} {\bf set\-Position} (unsigned long samples=$\sim$0l) \item {\bf audioerror\_\-t} {\bf get\-Info} ({\bf audioinfo\_\-t} $\ast$info) \item {\bf audioerror\_\-t} {\bf set\-Minimum} (unsigned long samples) \item unsigned long {\bf get\-Position} (void) \item virtual bool {\bf is\-Open} (void) \item virtual bool {\bf has\-Positioning} (void) \item {\bf audioencoding\_\-t} {\bf get\-Encoding} (void) \item {\bf audioformat\_\-t} {\bf get\-Format} (void) \item unsigned {\bf get\-Sample\-Rate} (void) \item char $\ast$ {\bf get\-Annotation} (void) \item {\bf audioerror\_\-t} {\bf get\-Error} (void) \item bool {\bf operator!} (void) \end{CompactItemize} \subsection*{Protected Methods} \begin{CompactItemize} \item virtual bool {\bf af\-Create} (const char $\ast$path) \item virtual bool {\bf af\-Open} (const char $\ast$path) \item virtual bool {\bf af\-Peek} (unsigned char $\ast$data, unsigned size) \item virtual int {\bf af\-Read} (unsigned char $\ast$data, unsigned size) \item virtual int {\bf af\-Write} (unsigned char $\ast$data, unsigned size) \item virtual bool {\bf af\-Seek} (unsigned long pos) \item virtual void {\bf af\-Close} (void) \item virtual char $\ast$ {\bf get\-Continuation} (void) \item {\bf audioerror\_\-t} {\bf set\-Error} ({\bf audioerror\_\-t} err) \item unsigned short {\bf getaushort} (unsigned char $\ast$data) \item void {\bf setaushort} (unsigned char $\ast$data, unsigned short value) \item unsigned long {\bf getaulong} (unsigned char $\ast$data) \item void {\bf setaulong} (unsigned char $\ast$data, unsigned long value) \end{CompactItemize} \subsection*{Protected Attributes} \begin{CompactItemize} \item ost::Audio\-File:: \{ ... \} {\bf file} \item int {\bf fd} \item void $\ast$ {\bf handle} \end{CompactItemize} \subsection{Detailed Description} A class used to manipulate audio data. audio file access. This class provides file level access to audio data stored in different formats. This class also provides the ability to write audio data into a disk file. \begin{Desc} \item[Author: ]\par David Sugar $<${\tt dyfet@ostel.com}$>$ \end{Desc} \subsection{Constructor \& Destructor Documentation} \index{ost::AudioFile@{ost::Audio\-File}!AudioFile@{AudioFile}} \index{AudioFile@{AudioFile}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::Audio\-File::Audio\-File (const char $\ast$ {\em fname}, unsigned long {\em samples} = 0)}\label{classost_1_1_audio_file_a0} \index{ost::AudioFile@{ost::Audio\-File}!AudioFile@{AudioFile}} \index{AudioFile@{AudioFile}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::Audio\-File::Audio\-File (const char $\ast$ {\em fname}, {\bf audioinfo\_\-t} $\ast$ {\em info}, unsigned long {\em min} = 0)}\label{classost_1_1_audio_file_a1} \index{ost::AudioFile@{ost::Audio\-File}!AudioFile@{AudioFile}} \index{AudioFile@{AudioFile}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::Audio\-File::Audio\-File ()\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_audio_file_a2} \index{ost::AudioFile@{ost::Audio\-File}!~AudioFile@{$\sim$AudioFile}} \index{~AudioFile@{$\sim$AudioFile}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::Audio\-File::$\sim$Audio\-File ()\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_audio_file_a3} \subsection{Member Function Documentation} \index{ost::AudioFile@{ost::Audio\-File}!Close@{Close}} \index{Close@{Close}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Audio\-File::Close (void)}\label{classost_1_1_audio_file_a6} \index{ost::AudioFile@{ost::Audio\-File}!Create@{Create}} \index{Create@{Create}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Audio\-File::Create (const char $\ast$ {\em fname}, {\bf audioinfo\_\-t} $\ast$ {\em info})}\label{classost_1_1_audio_file_a5} \index{ost::AudioFile@{ost::Audio\-File}!Open@{Open}} \index{Open@{Open}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Audio\-File::Open (const char $\ast$ {\em fname})}\label{classost_1_1_audio_file_a4} \index{ost::AudioFile@{ost::Audio\-File}!Skip@{Skip}} \index{Skip@{Skip}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf audioerror\_\-t} ost::Audio\-File::Skip (long {\em samples})}\label{classost_1_1_audio_file_a11} \index{ost::AudioFile@{ost::Audio\-File}!afClose@{afClose}} \index{afClose@{afClose}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void ost::Audio\-File::af\-Close (void)\hspace{0.3cm}{\tt [protected, virtual]}}\label{classost_1_1_audio_file_b6} \index{ost::AudioFile@{ost::Audio\-File}!afCreate@{afCreate}} \index{afCreate@{afCreate}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool ost::Audio\-File::af\-Create (const char $\ast$ {\em path})\hspace{0.3cm}{\tt [protected, virtual]}}\label{classost_1_1_audio_file_b0} \index{ost::AudioFile@{ost::Audio\-File}!afOpen@{afOpen}} \index{afOpen@{afOpen}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool ost::Audio\-File::af\-Open (const char $\ast$ {\em path})\hspace{0.3cm}{\tt [protected, virtual]}}\label{classost_1_1_audio_file_b1} \index{ost::AudioFile@{ost::Audio\-File}!afPeek@{afPeek}} \index{afPeek@{afPeek}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool ost::Audio\-File::af\-Peek (unsigned char $\ast$ {\em data}, unsigned {\em size})\hspace{0.3cm}{\tt [protected, virtual]}}\label{classost_1_1_audio_file_b2} \index{ost::AudioFile@{ost::Audio\-File}!afRead@{afRead}} \index{afRead@{afRead}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual int ost::Audio\-File::af\-Read (unsigned char $\ast$ {\em data}, unsigned {\em size})\hspace{0.3cm}{\tt [protected, virtual]}}\label{classost_1_1_audio_file_b3} \index{ost::AudioFile@{ost::Audio\-File}!afSeek@{afSeek}} \index{afSeek@{afSeek}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool ost::Audio\-File::af\-Seek (unsigned long {\em pos})\hspace{0.3cm}{\tt [protected, virtual]}}\label{classost_1_1_audio_file_b5} \index{ost::AudioFile@{ost::Audio\-File}!afWrite@{afWrite}} \index{afWrite@{afWrite}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual int ost::Audio\-File::af\-Write (unsigned char $\ast$ {\em data}, unsigned {\em size})\hspace{0.3cm}{\tt [protected, virtual]}}\label{classost_1_1_audio_file_b4} \index{ost::AudioFile@{ost::Audio\-File}!getAnnotation@{getAnnotation}} \index{getAnnotation@{getAnnotation}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ ost::Audio\-File::get\-Annotation (void)\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_audio_file_a21} \index{ost::AudioFile@{ost::Audio\-File}!getBuffer@{getBuffer}} \index{getBuffer@{getBuffer}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}int ost::Audio\-File::get\-Buffer (void $\ast$ {\em addr}, unsigned {\em len})}\label{classost_1_1_audio_file_a7} \index{ost::AudioFile@{ost::Audio\-File}!getContinuation@{getContinuation}} \index{getContinuation@{getContinuation}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual char$\ast$ ost::Audio\-File::get\-Continuation (void)\hspace{0.3cm}{\tt [inline, protected, virtual]}}\label{classost_1_1_audio_file_b7} \index{ost::AudioFile@{ost::Audio\-File}!getEncoding@{getEncoding}} \index{getEncoding@{getEncoding}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf audioencoding\_\-t} ost::Audio\-File::get\-Encoding (void)\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_audio_file_a18} \index{ost::AudioFile@{ost::Audio\-File}!getError@{getError}} \index{getError@{getError}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf audioerror\_\-t} ost::Audio\-File::get\-Error (void)\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_audio_file_a22} \index{ost::AudioFile@{ost::Audio\-File}!getFormat@{getFormat}} \index{getFormat@{getFormat}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf audioformat\_\-t} ost::Audio\-File::get\-Format (void)\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_audio_file_a19} \index{ost::AudioFile@{ost::Audio\-File}!getInfo@{getInfo}} \index{getInfo@{getInfo}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf audioerror\_\-t} ost::Audio\-File::get\-Info ({\bf audioinfo\_\-t} $\ast$ {\em info})}\label{classost_1_1_audio_file_a13} \index{ost::AudioFile@{ost::Audio\-File}!getPosition@{getPosition}} \index{getPosition@{getPosition}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned long ost::Audio\-File::get\-Position (void)}\label{classost_1_1_audio_file_a15} \index{ost::AudioFile@{ost::Audio\-File}!getSampleRate@{getSampleRate}} \index{getSampleRate@{getSampleRate}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned ost::Audio\-File::get\-Sample\-Rate (void)\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_audio_file_a20} \index{ost::AudioFile@{ost::Audio\-File}!getSamples@{getSamples}} \index{getSamples@{getSamples}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf audioerror\_\-t} ost::Audio\-File::get\-Samples (void $\ast$ {\em addr}, unsigned {\em samples})}\label{classost_1_1_audio_file_a9} \index{ost::AudioFile@{ost::Audio\-File}!getaulong@{getaulong}} \index{getaulong@{getaulong}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned long ost::Audio\-File::getaulong (unsigned char $\ast$ {\em data})\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_audio_file_b11} \index{ost::AudioFile@{ost::Audio\-File}!getaushort@{getaushort}} \index{getaushort@{getaushort}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned short ost::Audio\-File::getaushort (unsigned char $\ast$ {\em data})\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_audio_file_b9} \index{ost::AudioFile@{ost::Audio\-File}!hasPositioning@{hasPositioning}} \index{hasPositioning@{hasPositioning}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool ost::Audio\-File::has\-Positioning (void)\hspace{0.3cm}{\tt [inline, virtual]}}\label{classost_1_1_audio_file_a17} \index{ost::AudioFile@{ost::Audio\-File}!isOpen@{isOpen}} \index{isOpen@{isOpen}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool ost::Audio\-File::is\-Open (void)\hspace{0.3cm}{\tt [virtual]}}\label{classost_1_1_audio_file_a16} \index{ost::AudioFile@{ost::Audio\-File}!operator"!@{operator"!}} \index{operator"!@{operator"!}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::Audio\-File::operator! (void)\hspace{0.3cm}{\tt [inline]}}\label{classost_1_1_audio_file_a23} \index{ost::AudioFile@{ost::Audio\-File}!putBuffer@{putBuffer}} \index{putBuffer@{putBuffer}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}int ost::Audio\-File::put\-Buffer (void $\ast$ {\em attr}, unsigned {\em len})}\label{classost_1_1_audio_file_a8} \index{ost::AudioFile@{ost::Audio\-File}!putSamples@{putSamples}} \index{putSamples@{putSamples}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf audioerror\_\-t} ost::Audio\-File::put\-Samples (void $\ast$ {\em addr}, unsigned {\em samples})}\label{classost_1_1_audio_file_a10} \index{ost::AudioFile@{ost::Audio\-File}!setError@{setError}} \index{setError@{setError}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf audioerror\_\-t} ost::Audio\-File::set\-Error ({\bf audioerror\_\-t} {\em err})\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_audio_file_b8} \index{ost::AudioFile@{ost::Audio\-File}!setMinimum@{setMinimum}} \index{setMinimum@{setMinimum}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf audioerror\_\-t} ost::Audio\-File::set\-Minimum (unsigned long {\em samples})}\label{classost_1_1_audio_file_a14} \index{ost::AudioFile@{ost::Audio\-File}!setPosition@{setPosition}} \index{setPosition@{setPosition}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf audioerror\_\-t} ost::Audio\-File::set\-Position (unsigned long {\em samples} = $\sim$0l)}\label{classost_1_1_audio_file_a12} \index{ost::AudioFile@{ost::Audio\-File}!setaulong@{setaulong}} \index{setaulong@{setaulong}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Audio\-File::setaulong (unsigned char $\ast$ {\em data}, unsigned long {\em value})\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_audio_file_b12} \index{ost::AudioFile@{ost::Audio\-File}!setaushort@{setaushort}} \index{setaushort@{setaushort}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Audio\-File::setaushort (unsigned char $\ast$ {\em data}, unsigned short {\em value})\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_audio_file_b10} \subsection{Member Data Documentation} \index{ost::AudioFile@{ost::Audio\-File}!fd@{fd}} \index{fd@{fd}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}int ost::Audio\-File::fd\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_audio_file_n0} \index{ost::AudioFile@{ost::Audio\-File}!file@{file}} \index{file@{file}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}union \{ ... \} ost::Audio\-File::file\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_audio_file_n2} \index{ost::AudioFile@{ost::Audio\-File}!handle@{handle}} \index{handle@{handle}!ost::AudioFile@{ost::Audio\-File}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ ost::Audio\-File::handle\hspace{0.3cm}{\tt [protected]}}\label{classost_1_1_audio_file_n1} The documentation for this class was generated from the following file:\begin{CompactItemize} \item {\bf audio.h}\end{CompactItemize}