wxSoundFileStream doc updates (indeed, first write)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6425 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/sndfile.tex b/docs/latex/wx/sndfile.tex
index 348b696c3eddeff4e294d1a9a9c11eeb686d8a00..83eba9030140ce467e4d82efe106323da834c72b 100644 (file)
--- a/docs/latex/wx/sndfile.tex
+++ b/docs/latex/wx/sndfile.tex
@@ -1,75 +1,111 @@
-%
-% automatically generated by HelpGen from
-% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndfile.h at 26/Feb/00 14:26:42
-%
-
-
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        sndfile.tex
+%% Purpose:     wxMMedia docs
+%% Author:      Guilhem Lavaux <lavaux@easynet.fr>
+%% Modified by:
+%% Created:     2000
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWindows team
+%% Licence:     wxWindows licence
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \section{\class{wxSoundFileStream}}\label{wxsoundfilestream}
 
-
-Base class for file coders/decoders
+Base class for file coders/decoders. This class is not constructor (it is an abstract
+class).
 
 \wxheading{Derived from}
 
 \helpref{wxSoundStream}{wxsoundstream}
 
+\wxheading{Include file}
+
+wx/sndfile.h
+
 \wxheading{Data structures}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-
 \membersection{wxSoundFileStream::wxSoundFileStream}\label{wxsoundfilestreamwxsoundfilestream}
 
 \func{}{wxSoundFileStream}{\param{wxInputStream\& }{stream}, \param{wxSoundStream\& }{io\_sound}}
 
+It constructs a new file decoder object which will send 
+audio data to the specified sound stream. 
+The {\it stream} is the input stream to be decoded. The
+{\it io_sound} is the destination sound stream.
+Once it has been constructed, you cannot change any of
+the specified streams nor the direction of the stream.
+
+You will have access to the playback functions.
+
 \func{}{wxSoundFileStream}{\param{wxOutputStream\& }{stream}, \param{wxSoundStream\& }{io\_sound}}
 
-\membersection{wxSoundFileStream::\destruct{wxSoundFileStream}}\label{wxsoundfilestreamdtor}
+It constructs a new file coder object which will get
+data to be recorded from the specified sound stream.
+The {\it stream} is the output wxStream. The {\it io_sound}
+is the source sound stream of the audio data. Once
+it has been constructed, you cannot change any of
+the specified streams nor the direction of the stream.
 
+\membersection{wxSoundFileStream::\destruct{wxSoundFileStream}}\label{wxsoundfilestreamdtor}
 \func{}{\destruct{wxSoundFileStream}}{\void}
 
+It destroys the current sound file codec.
 
 \membersection{wxSoundFileStream::Play}\label{wxsoundfilestreamplay}
-
 \func{bool}{Play}{\void}
 
-Usual sound file calls (Play, Stop, ...)
-
+It starts playing the file. The playing begins, in background
+in nearly all cases, after the return of the function. The
+codec returns to a {\bf stopped} state when it reaches the
+end of the file.
+On success, it returns TRUE.
 
 \membersection{wxSoundFileStream::Record}\label{wxsoundfilestreamrecord}
-
 \func{bool}{Record}{\param{wxUint32 }{time}}
 
+It starts recording data from the sound stream and writing them
+to the output stream. You have to precise the recording length in
+parameter. This length is expressed in seconds. If you want to
+control the record length (using \helpref{Stop}{wxsoundfilestreamstop}),
+you can set it to wxSOUND_INFINITE_TIME.
 
-\membersection{wxSoundFileStream::Stop}\label{wxsoundfilestreamstop}
+On success, it returns TRUE.
 
+\membersection{wxSoundFileStream::Stop}\label{wxsoundfilestreamstop}
 \func{bool}{Stop}{\void}
 
+It stops either recording or playing. Whatever happens (even unexpected
+errors), the stream is stopped when the function returns. When you are
+in recording mode, the file headers are updated and flushed if possible
+(ie: if the output stream is seekable).
 
-\membersection{wxSoundFileStream::Pause}\label{wxsoundfilestreampause}
+On success, it returns TRUE.
 
+\membersection{wxSoundFileStream::Pause}\label{wxsoundfilestreampause}
 \func{bool}{Pause}{\void}
 
+The file codec tries to pause the stream: it means that it stops audio
+production but keep the file pointer at the place.
 
-\membersection{wxSoundFileStream::Resume}\label{wxsoundfilestreamresume}
+If the file codec is already paused, it returns FALSE.
 
+On success, it returns TREE.
+
+\membersection{wxSoundFileStream::Resume}\label{wxsoundfilestreamresume}
 \func{bool}{Resume}{\void}
 
+When the file codec has been paused using
+\helpref{Pause}{wxsoundfilestreampause}, you could be interrested in
+resuming it. This is the goal of this function.
 
 \membersection{wxSoundFileStream::IsStopped}\label{wxsoundfilestreamisstopped}
-
 \constfunc{bool}{IsStopped}{\void}
 
-Functions which return the current state
-
-
 \membersection{wxSoundFileStream::IsPaused}\label{wxsoundfilestreamispaused}
-
 \constfunc{bool}{IsPaused}{\void}
 
-
 \membersection{wxSoundFileStream::StartProduction}\label{wxsoundfilestreamstartproduction}
-
 \func{bool}{StartProduction}{\param{int }{evt}}
 
 A user should not call these two functions.
@@ -90,7 +126,6 @@ These three functions deals with the length, the position in the sound file.
 All the values are expressed in bytes. If you need the values expressed
 in terms of time, you have to use GetSoundFormat().GetTimeFromBytes(...)
 
-
 \membersection{wxSoundFileStream::GetPosition}\label{wxsoundfilestreamgetposition}
 
 \func{wxUint32}{GetPosition}{\void}