X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e8482f24cfc00645607f8526fde38d39e0dcaa63..922ba68045d84789ab1dfceb4d1aa1b6e2c5e810:/contrib/docs/latex/mmedia/sndrter.tex

diff --git a/contrib/docs/latex/mmedia/sndrter.tex b/contrib/docs/latex/mmedia/sndrter.tex
index 67d39bce7b..4f9dba3cb0 100644
--- a/contrib/docs/latex/mmedia/sndrter.tex
+++ b/contrib/docs/latex/mmedia/sndrter.tex
@@ -6,8 +6,8 @@
 
 \section{\class{wxSoundRouterStream}}\label{wxsoundrouterstream}
 
-
-Codec router class
+This is the router "codec" class. It should do codec routing when the device
+driver does not deal with a format.
 
 \wxheading{Derived from}
 
@@ -17,43 +17,21 @@ Codec router class
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-
 \membersection{wxSoundRouterStream::wxSoundRouterStream}\label{wxsoundrouterstreamwxsoundrouterstream}
-
 \func{}{wxSoundRouterStream}{\param{wxSoundStream\& }{sndio}}
 
+\helpref{wxSoundCodec}{wxsoundcodec}
 
-\membersection{wxSoundRouterStream::\destruct{wxSoundRouterStream}}\label{wxsoundrouterstreamdtor}
 
+\membersection{wxSoundRouterStream::\destruct{wxSoundRouterStream}}\label{wxsoundrouterstreamdtor}
 \func{}{\destruct{wxSoundRouterStream}}{\void}
 
-
-\membersection{wxSoundRouterStream::Read}\label{wxsoundrouterstreamread}
-
-\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}}
-
-
-\membersection{wxSoundRouterStream::Write}\label{wxsoundrouterstreamwrite}
-
-\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}}
-
+Destructor.
 
 \membersection{wxSoundRouterStream::SetSoundFormat}\label{wxsoundrouterstreamsetsoundformat}
-
 \func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}}
 
-
-\membersection{wxSoundRouterStream::StartProduction}\label{wxsoundrouterstreamstartproduction}
-
-\func{bool}{StartProduction}{\param{int }{evt}}
-
-
-\membersection{wxSoundRouterStream::StopProduction}\label{wxsoundrouterstreamstopproduction}
-
-\func{bool}{StopProduction}{\void}
-
-
-\membersection{wxSoundRouterStream::GetBestSize}\label{wxsoundrouterstreamgetbestsize}
-
-\constfunc{wxUint32}{GetBestSize}{\void}
-
+SetSoundFormat will first try to setup the device driver with the specified
+format. If this fails, it will try to find a codec which will convert the
+input format to a valid format for the device driver. It uses an internal
+codec database.