From 84899251f1d98b6a787311baac74801287517571 Mon Sep 17 00:00:00 2001 From: Guilhem Lavaux Date: Sun, 5 Mar 2000 16:05:53 +0000 Subject: [PATCH] Removed wxMMedia classes doc from the main wx doc git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6457 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/cdaudio.tex | 22 --- docs/latex/wx/cdaudlnx.tex | 73 ---------- docs/latex/wx/cdaudwin.tex | 77 ---------- docs/latex/wx/cdtoc.tex | 118 --------------- docs/latex/wx/classes.tex | 16 --- docs/latex/wx/sndaiff.tex | 68 --------- docs/latex/wx/sndbase.tex | 288 ------------------------------------- docs/latex/wx/sndcodec.tex | 39 ----- docs/latex/wx/sndesd.tex | 64 --------- docs/latex/wx/sndfg72x.tex | 87 ----------- docs/latex/wx/sndfile.tex | 217 ---------------------------- docs/latex/wx/sndfpcm.tex | 104 -------------- docs/latex/wx/sndfrmt.tex | 69 --------- docs/latex/wx/sndfulaw.tex | 74 ---------- docs/latex/wx/sndg72x.tex | 54 ------- docs/latex/wx/sndoss.tex | 71 --------- docs/latex/wx/sndpcm.tex | 48 ------- docs/latex/wx/sndrter.tex | 59 -------- docs/latex/wx/sndulaw.tex | 49 ------- docs/latex/wx/sndwave.tex | 91 ------------ docs/latex/wx/sndwin.tex | 140 ------------------ docs/latex/wx/vidbase.tex | 173 ---------------------- docs/latex/wx/vidxanm.tex | 170 ---------------------- 23 files changed, 2171 deletions(-) delete mode 100644 docs/latex/wx/cdaudio.tex delete mode 100644 docs/latex/wx/cdaudlnx.tex delete mode 100644 docs/latex/wx/cdaudwin.tex delete mode 100644 docs/latex/wx/cdtoc.tex delete mode 100644 docs/latex/wx/sndaiff.tex delete mode 100644 docs/latex/wx/sndbase.tex delete mode 100644 docs/latex/wx/sndcodec.tex delete mode 100644 docs/latex/wx/sndesd.tex delete mode 100644 docs/latex/wx/sndfg72x.tex delete mode 100644 docs/latex/wx/sndfile.tex delete mode 100644 docs/latex/wx/sndfpcm.tex delete mode 100644 docs/latex/wx/sndfrmt.tex delete mode 100644 docs/latex/wx/sndfulaw.tex delete mode 100644 docs/latex/wx/sndg72x.tex delete mode 100644 docs/latex/wx/sndoss.tex delete mode 100644 docs/latex/wx/sndpcm.tex delete mode 100644 docs/latex/wx/sndrter.tex delete mode 100644 docs/latex/wx/sndulaw.tex delete mode 100644 docs/latex/wx/sndwave.tex delete mode 100644 docs/latex/wx/sndwin.tex delete mode 100644 docs/latex/wx/vidbase.tex delete mode 100644 docs/latex/wx/vidxanm.tex diff --git a/docs/latex/wx/cdaudio.tex b/docs/latex/wx/cdaudio.tex deleted file mode 100644 index 65d06f80f4..0000000000 --- a/docs/latex/wx/cdaudio.tex +++ /dev/null @@ -1,22 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/cdbase.h at 26/Feb/00 14:52:12 -% - - -\section{\class{wxCDAudio}}\label{wxcdaudio} - -\wxheading{Derived from} - -\helpref{wxObject}{wxobject} - -\wxheading{Data structures} - -{\small \begin{verbatim} -typedef struct wxCDtime { - wxUint8 track -\end{verbatim}} -{\small \begin{verbatim} -typedef enum { PLAYING, PAUSED, STOPPED } CDstatus -\end{verbatim}} - diff --git a/docs/latex/wx/cdaudlnx.tex b/docs/latex/wx/cdaudlnx.tex deleted file mode 100644 index 286116b229..0000000000 --- a/docs/latex/wx/cdaudlnx.tex +++ /dev/null @@ -1,73 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/cdunix.h at 26/Feb/00 14:52:10 -% - - -\section{\class{wxCDAudioLinux}}\label{wxcdaudiolinux} - - - -\wxheading{Derived from} - -\helpref{wxCDAudio}{wxcdaudio} - -\wxheading{Data structures} - -\latexignore{\rtfignore{\wxheading{Members}}} - - -\membersection{wxCDAudioLinux::wxCDAudioLinux}\label{wxcdaudiolinuxwxcdaudiolinux} - -\func{}{wxCDAudioLinux}{\void} - - -\membersection{wxCDAudioLinux::wxCDAudioLinux}\label{wxcdaudiolinuxwxcdaudiolinux} - -\func{}{wxCDAudioLinux}{\param{const char* }{dev\_name}} - - -\membersection{wxCDAudioLinux::\destruct{wxCDAudioLinux}}\label{wxcdaudiolinuxdtor} - -\func{}{\destruct{wxCDAudioLinux}}{\void} - - -\membersection{wxCDAudioLinux::Play}\label{wxcdaudiolinuxplay} - -\func{bool}{Play}{\param{const wxCDtime\& }{beg\_time}, \param{const wxCDtime\& }{end\_time}} - - -\membersection{wxCDAudioLinux::Pause}\label{wxcdaudiolinuxpause} - -\func{bool}{Pause}{\void} - - -\membersection{wxCDAudioLinux::Resume}\label{wxcdaudiolinuxresume} - -\func{bool}{Resume}{\void} - - -\membersection{wxCDAudioLinux::GetStatus}\label{wxcdaudiolinuxgetstatus} - -\func{CDstatus}{GetStatus}{\void} - - -\membersection{wxCDAudioLinux::GetTime}\label{wxcdaudiolinuxgettime} - -\func{wxCDtime}{GetTime}{\void} - - -\membersection{wxCDAudioLinux::GetToc}\label{wxcdaudiolinuxgettoc} - -\func{CDtoc\&}{GetToc}{\void} - - -\membersection{wxCDAudioLinux::Ok}\label{wxcdaudiolinuxok} - -\constfunc{bool}{Ok}{\void} - - -\membersection{wxCDAudioLinux::OpenDevice}\label{wxcdaudiolinuxopendevice} - -\func{void}{OpenDevice}{\param{const char* }{dev\_name}} - diff --git a/docs/latex/wx/cdaudwin.tex b/docs/latex/wx/cdaudwin.tex deleted file mode 100644 index 81e2219a14..0000000000 --- a/docs/latex/wx/cdaudwin.tex +++ /dev/null @@ -1,77 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/cdwin.h at 26/Feb/00 14:52:15 -% - - -\section{\class{wxCDAudioWin}}\label{wxcdaudiowin} - - - -\wxheading{Derived from} - -\helpref{wxCDAudio}{wxcdaudio} - -\wxheading{Data structures} - -{\small \begin{verbatim} -typedef struct CDAW\_Internal { - MCIDEVICEID dev\_id -\end{verbatim}} -\latexignore{\rtfignore{\wxheading{Members}}} - - -\membersection{wxCDAudioWin::wxCDAudioWin}\label{wxcdaudiowinwxcdaudiowin} - -\func{}{wxCDAudioWin}{\void} - - -\membersection{wxCDAudioWin::wxCDAudioWin}\label{wxcdaudiowinwxcdaudiowin} - -\func{}{wxCDAudioWin}{\param{const char* }{dev\_name}} - - -\membersection{wxCDAudioWin::\destruct{wxCDAudioWin}}\label{wxcdaudiowindtor} - -\func{}{\destruct{wxCDAudioWin}}{\void} - - -\membersection{wxCDAudioWin::Play}\label{wxcdaudiowinplay} - -\func{bool}{Play}{\param{const wxCDtime\& }{beg\_time}, \param{const wxCDtime\& }{end\_time}} - - -\membersection{wxCDAudioWin::Pause}\label{wxcdaudiowinpause} - -\func{bool}{Pause}{\void} - - -\membersection{wxCDAudioWin::Resume}\label{wxcdaudiowinresume} - -\func{bool}{Resume}{\void} - - -\membersection{wxCDAudioWin::GetStatus}\label{wxcdaudiowingetstatus} - -\func{CDstatus}{GetStatus}{\void} - - -\membersection{wxCDAudioWin::GetTime}\label{wxcdaudiowingettime} - -\func{wxCDtime}{GetTime}{\void} - - -\membersection{wxCDAudioWin::GetToc}\label{wxcdaudiowingettoc} - -\func{const CDtoc\&}{GetToc}{\void} - - -\membersection{wxCDAudioWin::Ok}\label{wxcdaudiowinok} - -\constfunc{bool}{Ok}{\void} - - -\membersection{wxCDAudioWin::PrepareToc}\label{wxcdaudiowinpreparetoc} - -\func{void}{PrepareToc}{\void} - diff --git a/docs/latex/wx/cdtoc.tex b/docs/latex/wx/cdtoc.tex deleted file mode 100644 index 465c495c33..0000000000 --- a/docs/latex/wx/cdtoc.tex +++ /dev/null @@ -1,118 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/cdbase.h at 26/Feb/00 14:52:12 -% - - -\section{\class{CDtoc}}\label{cdtoc} - - -Table of contents manager - -\wxheading{Derived from} - -No base class - -\wxheading{Data structures} - -\latexignore{\rtfignore{\wxheading{Members}}} - - -\membersection{CDtoc::CDtoc}\label{cdtoccdtoc} - -\func{}{CDtoc}{\param{wxCDtime\& }{tot\_tm}, \param{wxCDtime* }{trks\_tm}, \param{wxCDtime* }{trks\_pos}} - - -\membersection{CDtoc::GetTrackTime}\label{cdtocgettracktime} - -\constfunc{wxCDtime}{GetTrackTime}{\param{wxUint8 }{track}} - -Returns the length of the specified track -track: track to get length - - -\membersection{CDtoc::GetTrackPos}\label{cdtocgettrackpos} - -\constfunc{wxCDtime}{GetTrackPos}{\param{wxUint8 }{track}} - -Returns the position of the specified track -track: track to get position - - -\membersection{CDtoc::GetTotalTime}\label{cdtocgettotaltime} - -\constfunc{wxCDtime}{GetTotalTime}{\void} - -Returns the total time - - -\membersection{wxCDAudio::wxCDAudio}\label{wxcdaudiowxcdaudio} - -\func{}{wxCDAudio}{\void} - - -\membersection{wxCDAudio::\destruct{wxCDAudio}}\label{wxcdaudiodtor} - -\func{}{\destruct{wxCDAudio}}{\void} - - -\membersection{wxCDAudio::Play}\label{wxcdaudioplay} - -\func{bool}{Play}{\param{const wxCDtime\& }{beg\_play}, \param{const wxCDtime\& }{end\_play}} - -Play audio at the specified position - - -\membersection{wxCDAudio::Play}\label{wxcdaudioplay} - -\func{bool}{Play}{\param{const wxCDtime\& }{beg\_play}} - -Play audio from the specified to the end of the CD audio - - -\membersection{wxCDAudio::Play}\label{wxcdaudioplay} - -\func{bool}{Play}{\param{wxUint8 }{beg\_track}, \param{wxUint8 }{end\_track = 0}} - - -\membersection{wxCDAudio::Pause}\label{wxcdaudiopause} - -\func{bool}{Pause}{\void} - -Pause the audio playing - - -\membersection{wxCDAudio::Resume}\label{wxcdaudioresume} - -\func{bool}{Resume}{\void} - -Resume a paused audio playing - - -\membersection{wxCDAudio::GetStatus}\label{wxcdaudiogetstatus} - -\func{CDstatus}{GetStatus}{\void} - -Get the current CD status - - -\membersection{wxCDAudio::GetTime}\label{wxcdaudiogettime} - -\func{wxCDtime}{GetTime}{\void} - -Get the current playing time - - -\membersection{wxCDAudio::GetToc}\label{wxcdaudiogettoc} - -\func{const CDtoc\&}{GetToc}{\void} - -Returns the table of contents - - -\membersection{wxCDAudio::Ok}\label{wxcdaudiook} - -\constfunc{bool}{Ok}{\void} - -CD ok - diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index 417138ebac..6f1a24c213 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -229,22 +229,6 @@ \input sckaddr.tex \input socket.tex \input strmsock.tex -\input sndaiff.tex -\input sndfile.tex -\input sndfg72x.tex -\input sndfrmt.tex -\input sndfpcm.tex -\input sndfulaw.tex -\input sndbase.tex -\input sndcodec.tex -\input sndesd.tex -\input sndg72x.tex -\input sndoss.tex -\input sndpcm.tex -\input sndulaw.tex -\input sndrter.tex -\input sndwin.tex -\input sndwave.tex \input spinbutt.tex \input splitevt.tex \input splitter.tex diff --git a/docs/latex/wx/sndaiff.tex b/docs/latex/wx/sndaiff.tex deleted file mode 100644 index fc909dd23a..0000000000 --- a/docs/latex/wx/sndaiff.tex +++ /dev/null @@ -1,68 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndaiff.h at 26/Feb/00 14:52:29 -% - -\section{\class{wxSoundAiff}}\label{wxsoundaiff} - -AIFF codec - -\wxheading{Derived from} - -\helpref{wxSoundFileStream}{wxsoundfilestream} - -\wxheading{Data structures} - -\latexignore{\rtfignore{\wxheading{Members}}} - - -\membersection{wxSoundAiff::wxSoundAiff}\label{wxsoundaiffwxsoundaiff} - -\func{}{wxSoundAiff}{\param{wxInputStream\& }{stream}, \param{wxSoundStream\& }{io\_sound}} - -\func{}{wxSoundAiff}{\param{wxOutputStream\& }{stream}, \param{wxSoundStream\& }{io\_sound}} - -\membersection{wxSoundAiff::\destruct{wxSoundAiff}}\label{wxsoundaiffdtor} - -\func{}{\destruct{wxSoundAiff}}{\void} - - -\membersection{wxSoundAiff::CanRead}\label{wxsoundaiffcanread} - -\func{bool}{CanRead}{\void} - - -\membersection{wxSoundAiff::GetCodecName}\label{wxsoundaiffgetcodecname} - -\constfunc{wxString}{GetCodecName}{\void} - - -\membersection{wxSoundAiff::PrepareToPlay}\label{wxsoundaiffpreparetoplay} - -\func{bool}{PrepareToPlay}{\void} - - -\membersection{wxSoundAiff::PrepareToRecord}\label{wxsoundaiffpreparetorecord} - -\func{bool}{PrepareToRecord}{\param{wxUint32 }{time}} - - -\membersection{wxSoundAiff::FinishRecording}\label{wxsoundaifffinishrecording} - -\func{bool}{FinishRecording}{\void} - - -\membersection{wxSoundAiff::RepositionStream}\label{wxsoundaiffrepositionstream} - -\func{bool}{RepositionStream}{\param{wxUint32 }{position}} - - -\membersection{wxSoundAiff::GetData}\label{wxsoundaiffgetdata} - -\func{wxUint32}{GetData}{\param{void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundAiff::PutData}\label{wxsoundaiffputdata} - -\func{wxUint32}{PutData}{\param{const void* }{buffer}, \param{wxUint32 }{len}} - diff --git a/docs/latex/wx/sndbase.tex b/docs/latex/wx/sndbase.tex deleted file mode 100644 index 73e9ab84b9..0000000000 --- a/docs/latex/wx/sndbase.tex +++ /dev/null @@ -1,288 +0,0 @@ -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%% Name: sndbase.tex -%% Purpose: wxMMedia docs -%% Author: Guilhem Lavaux -%% Modified by: -%% Created: 2000 -%% RCS-ID: $Id$ -%% Copyright: (c) wxWindows team -%% Licence: wxWindows licence -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\section{\class{wxSoundStream}}\label{wxsoundstream} - -Base class for sound streams - -\wxheading{Derived from} - -No base class - -\wxheading{Include files} - - - -\wxheading{Data structures} - -%% -%% wxSoundStream errors -%% - -\wxheading{wxSoundStream errors} - -\twocolwidtha{7cm} -\begin{twocollist}\itemsep=0pt -\twocolitem{{\bf wxSOUND\_NOERR}}{No error occured} -\twocolitem{{\bf wxSOUND\_IOERR}}{An input/output error occured, it may concern -either a driver or a file} -\twocolitem{{\bf wxSOUND\_INVFRMT}}{The sound format passed to the function is -invalid. Generally, it means that you passed out of range values to the codec -stream or you don't pass the right sound format object to the right sound codec -stream.} -\twocolitem{{\bf wxSOUND\_INVDEV}}{Invalid device. Generally, it means that the -sound stream didn't manage to open the device driver due to an invalid parameter -or to the fact that sound is not supported on this computer.} -\twocolitem{{\bf wxSOUND\_NOEXACT}}{No exact matching sound codec has been found for -this sound format. It means that the sound driver didn't manage to setup the sound -card with the specified values.} -\twocolitem{{\bf wxSOUND\_NOCODEC}}{No matching codec has been found. Generally, it -may happen when you call wxSoundRouterStream::SetSoundFormat().} -\twocolitem{{\bf wxSOUND\_MEMERR}}{Not enough memory.} -\end{twocollist} - -%% -%% C callback -%% - -\wxheading{C callback for wxSound event} - -When a sound event is generated, it may either call the internal sound event -processor (which can be inherited) or call a C function. Its definition is: - -\begin{verbatim} - typedef void (*wxSoundCallback)(wxSoundStream *stream, int evt, - void *cdata); -\end{verbatim} - -The {\bf stream} parameter represents the current wxSoundStream. - -The {\bf evt} parameter represents the sound event which is the cause of the calling. (See \helpref{wxSound events}{wxsoundstream}). - -The {\bf cdata} parameter represents the user callback data which were specified -when the user called \helpref{wxSoundStream::Register}{wxsoundstreamregister}. - -{\it Note:} There are two other ways to catch sound events: you can inherit the -sound stream and redefine \helpref{wxSoundStream::OnSoundEvent}{wxsoundstreamonsoundevent}, or you can reroute the events to another sound stream using \helpref{wxSoundStream::SetEventHandler}{wxsoundstreamseteventhandler}. - -%% -%% wxSoundStream streaming mode -%% - -\wxheading{wxSound streaming mode} - -The wxSoundStream object can work in three different modes. These modes are specified -at the call to \helpref{wxSoundStream::StartProduction}{wxsoundstreamstartproduction} -and cannot be changed until you call -\helpref{wxSoundStream::StopProduction}{wxsoundstreamstopproduction}. - -The {\bf wxSOUND\_INPUT} mode is the recording mode. It generates {\bf wxSOUND\_INPUT} -events and you cannot use wxSoundStream::Write(). - -The {\bf wxSOUND\_OUTPUT} mode is the playing mode. It generates {\bf wxSOUND\_OUTPUT} -events and you cannot use wxSoundStream::Read(). - -The {\bf wxSOUND\_DUPLEX} mode activates the full duplex mode. The full duplex requires -you to make synchronous call to \helpref{wxSoundStream::Read}{wxsoundstreamread} and -\helpref{wxSoundStream::Write}{wxsoundstreamwrite}. This means that you must be -careful with realtime problems. Each time you call Read you must call Write. - -%% -%% wxSoundStream events -%% - -\wxheading{wxSoundStream events} - -The sound events are generated when the sound driver (or the sound stream) completes -a previous sound buffer. There are two possible sound events and two meanings. - -The {\bf wxSOUND\_INPUT} event is generated when the sound stream has a new input -buffer ready to be read. You know that you can read a buffer of the size -\helpref{GetBestSize()}{wxsoundstreamgetbestsize} without blocking. - -The {\bf wxSOUND\_OUTPUT} event is generated when the sound stream has completed a -previous buffer. This buffer has been sent to the sound driver and it is ready to -process a new buffer. Consequently, \helpref{Write}{wxsoundstreamwrite} will not -block too. - -\latexignore{\rtfignore{\wxheading{Members}}} - -%% Ctor && Dtor - -\membersection{wxSoundStream::wxSoundStream}\label{wxsoundstreamwxsoundstream} - -\func{}{wxSoundStream}{\void} - -Default constructor. - -\membersection{wxSoundStream::\destruct{wxSoundStream}}\label{wxsoundstreamdtor} - -\func{}{\destruct{wxSoundStream}}{\void} - -Destructor. The destructor stops automatically all started production and destroys -any temporary buffer. - -%% -%% Read -%% - -\membersection{wxSoundStream::Read}\label{wxsoundstreamread} - -\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}} - -Reads {\it len} bytes from the sound stream. This call may block the user so -use it carefully when you need to intensively refresh the GUI. You may be -interested by sound events: see \helpref{wxSoundStream::OnSoundEvent}{wxsoundstreamonsoundevent}. - -It is better to use the size returned by \helpref{wxSoundStream::GetBestSize}{wxsoundstreamgetbestsize}: this may improve performance or accuracy of the -sound event system. - -\wxheading{Parameters} - -\docparam{len}{{\it len} is expressed in bytes. If you need to do conversions between bytes -and seconds use wxSoundFormat. -See \helpref{wxSoundFormatBase}{wxsoundformatbase}, \helpref{wxSoundStream::GetSoundFormat}{wxsoundstreamgetsoundformat}.} - -\docparam{data}{Data in \it{buffer} are coded using the sound format attached to this sound -stream. The format is specified with -\helpref{SetSoundFormat}{wxsoundstreamsetsoundformat}.} - -%% -%% Write -%% - -\membersection{wxSoundStream::Write}\label{wxsoundstreamwrite} - -\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}} - -Writes \it{len} bytes to the sound stream. This call may block the user so -use it carefully. You may be interested by sound events: see -\helpref{wxSoundStream::OnSoundEvent}{wxsoundstreamonsoundevent}. - -It is better to use the size returned by \helpref{wxSoundStream::GetBestSize}{wxsoundstreamgetbestsize}: this may improve performance or accuracy of the -sound event system. - -\wxheading{Parameters} - -\docparam{len}{This is expressed in bytes. If you need to do conversions between bytes -and seconds use wxSoundFormat. -See \helpref{wxSoundFormatBase}{wxsoundformatbase}, \helpref{wxSoundStream::GetSoundFormat}{wxsoundstreamgetsoundformat}.} - -\docparam{buffer}{Data in \it{buffer} are coded using the sound format attached to this sound -stream. The format is specified with -\helpref{SetSoundFormat}{wxsoundstreamsetsoundformat}.} - -%% -%% GetBestSize -%% - -\membersection{wxSoundStream::GetBestSize}\label{wxsoundstreamgetbestsize} - -\constfunc{wxUint32}{GetBestSize}{\void} - -This function returns the best size for IO calls. The best size provides you -a good alignment for data to be written (or read) to (or from) the sound stream. -So, when, for example, a sound event is sent, you are sure the sound stream -will not block for this buffer size. - -%% -%% wxSoundStream:SetSoundFormat -%% - -\membersection{wxSoundStream::SetSoundFormat}\label{wxsoundstreamsetsoundformat} - -\func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}} - -SetSoundFormat is one of the key function of the wxSoundStream object. -It specifies the sound format the user needs. SetSoundFormat tries to -apply the format to the current sound stream (it can be a sound file or a -sound driver). Then, either it manages to apply it and it returns {\bf TRUE}, -or it could not and it returns {\bf FALSE}. In this case, you must check -the error with -\helpref{wxSoundStream::GetError}{wxsoundstreamgeterror}. See -\helpref{wxSoundStream errors section}{wxsoundstreamerrors} for more details. - - -\wxheading{Note} - -The {\bf format} object can be destroyed after the call. The object does not need it. - -\wxheading{Note} - -If the error is {\bf wxSOUND\_NOTEXACT}, the stream tries to find the best -approaching format and setups it. You can check the format which it applied -with \helpref{wxSoundStream::GetSoundFormat}{wxsoundstreamgetsoundformat}. - -%% -%% GetSoundFormat -%% -\membersection{wxSoundStream::GetSoundFormat}\label{wxsoundstreamgetsoundformat} -\constfunc{wxSoundFormatBase\&}{GetSoundFormat}{\void} - -It returns a reference to the current sound format of the stream represented by a -wxSoundFormatBase object. This object {\it must not} be destroyed by anyone except -the stream itself. - -%% -%% SetCallback -%% -\membersection{wxSoundStream::SetCallback}\label{wxsoundstreamregister} - -\func{void}{Register}{\param{int }{evt}, \param{wxSoundCallback }{cbk}, \param{void* }{cdata}} - -It installs a C callback for wxSoundStream events. The C callbacks are still -useful to avoid hard inheritance. You can install only one callback per event. -Each callback has its callback data. - -%% -%% StartProduction -%% -\membersection{wxSoundStream::StartProduction}\label{wxsoundstreamstartproduction} - -\func{bool}{StartProduction}{\param{int }{evt}} - -StartProduction starts the sound streaming. {\it evt} may be one of -{\bf wxSOUND\_INPUT}, {\bf wxSOUND\_OUTPUT} or {\bf wxSOUND\_DUPLEX}. -You cannot specify several flags at the same time. Starting the production -may automaticaly in position of buffer underrun (only in the case you activated -recording). Actually this may happen the sound IO queue is too short. -It is also advised that you fill quickly enough the sound IO queue when the -driver requests it (through a wxSoundEvent). - -\membersection{wxSoundStream::StopProduction}\label{wxsoundstreamstopproduction} -\func{bool}{StopProduction}{\void} - -I stops the async notifier and the sound streaming straightly. - -\membersection{wxSoundStream::SetEventHandler}\label{wxsoundstreamseteventhandler} -\func{void}{SetEventHandler}{\param{wxSoundStream* }{handler}} - -Sets the event handler: if it is non-null, all events are routed to it. - -\membersection{wxSoundStream::GetError}\label{wxsoundstreamgeterror} -\constfunc{wxSoundError}{GetError}{\void} - -It returns the last error which occured. - -\membersection{wxSoundStream::GetLastAccess}\label{wxsoundstreamgetlastaccess} -\constfunc{wxUint32}{GetLastAccess}{\void} - -It returns the number of bytes which were effectively written to/read from the sound stream. - -\membersection{wxSoundStream::QueueFilled}\label{wxsoundstreamqueuefilled} -\constfunc{bool}{QueueFilled}{\void} - -It returns whether the sound IO queue is full. When it is full, the next IO call will block -until the IO queue has at least one empty entry. - -\membersection{wxSoundStream::OnSoundEvent}\label{wxsoundstreamonsoundevent} -\func{void}{OnSoundEvent}{\param{int }{evt}} - -It is called by the wxSoundStream when a new sound event occured. diff --git a/docs/latex/wx/sndcodec.tex b/docs/latex/wx/sndcodec.tex deleted file mode 100644 index d836c0b728..0000000000 --- a/docs/latex/wx/sndcodec.tex +++ /dev/null @@ -1,39 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndcodec.h at 26/Feb/00 14:26:29 -% - -\section{\class{wxSoundStreamCodec}}\label{wxsoundstreamcodec} - -\wxheading{Derived from} - -\helpref{wxSoundStream}{wxsoundstream} - -\wxheading{Data structures} - -\latexignore{\rtfignore{\wxheading{Members}}} - -\membersection{wxSoundStreamCodec::wxSoundStreamCodec}\label{wxsoundstreamcodecwxsoundstreamcodec} - -\func{}{wxSoundStreamCodec}{\param{wxSoundStream\& }{snd\_io}} - - -\membersection{wxSoundStreamCodec::\destruct{wxSoundStreamCodec}}\label{wxsoundstreamcodecdtor} - -\func{}{\destruct{wxSoundStreamCodec}}{\void} - - -\membersection{wxSoundStreamCodec::StartProduction}\label{wxsoundstreamcodecstartproduction} - -\func{bool}{StartProduction}{\param{int }{evt}} - - -\membersection{wxSoundStreamCodec::StopProduction}\label{wxsoundstreamcodecstopproduction} - -\func{bool}{StopProduction}{\void} - - -\membersection{wxSoundStreamCodec::GetBestSize}\label{wxsoundstreamcodecgetbestsize} - -\constfunc{wxUint32}{GetBestSize}{\void} - diff --git a/docs/latex/wx/sndesd.tex b/docs/latex/wx/sndesd.tex deleted file mode 100644 index 4d860e2025..0000000000 --- a/docs/latex/wx/sndesd.tex +++ /dev/null @@ -1,64 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndesd.h at 26/Feb/00 14:26:56 -% - -\section{\class{wxSoundStreamESD}}\label{wxsoundstreamesd} - -ESD output class - -\wxheading{Derived from} - -\helpref{wxSoundStream}{wxsoundstream} - -\wxheading{Data structures} - -\latexignore{\rtfignore{\wxheading{Members}}} - - -\membersection{wxSoundStreamESD::wxSoundStreamESD}\label{wxsoundstreamesdwxsoundstreamesd} - -\func{}{wxSoundStreamESD}{\param{const wxString\& }{hostname = "localhost"}} - - -\membersection{wxSoundStreamESD::\destruct{wxSoundStreamESD}}\label{wxsoundstreamesddtor} - -\func{}{\destruct{wxSoundStreamESD}}{\void} - - -\membersection{wxSoundStreamESD::Read}\label{wxsoundstreamesdread} - -\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundStreamESD::Write}\label{wxsoundstreamesdwrite} - -\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundStreamESD::SetSoundFormat}\label{wxsoundstreamesdsetsoundformat} - -\func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}} - - -\membersection{wxSoundStreamESD::StartProduction}\label{wxsoundstreamesdstartproduction} - -\func{bool}{StartProduction}{\param{int }{evt}} - - -\membersection{wxSoundStreamESD::StopProduction}\label{wxsoundstreamesdstopproduction} - -\func{bool}{StopProduction}{\void} - - -\membersection{wxSoundStreamESD::WakeUpEvt}\label{wxsoundstreamesdwakeupevt} - -\func{void}{WakeUpEvt}{\param{int }{evt}} - -You should not call this. - - -\membersection{wxSoundStreamESD::QueueFilled}\label{wxsoundstreamesdqueuefilled} - -\constfunc{bool}{QueueFilled}{\void} - diff --git a/docs/latex/wx/sndfg72x.tex b/docs/latex/wx/sndfg72x.tex deleted file mode 100644 index 46d97f6f72..0000000000 --- a/docs/latex/wx/sndfg72x.tex +++ /dev/null @@ -1,87 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndg72x.h at 26/Feb/00 14:52:19 -% - - -\section{\class{wxSoundFormatG72X}}\label{wxsoundformatg72x} - - -G72X format - -\wxheading{Derived from} - -\helpref{wxSoundFormatBase}{wxsoundformatbase} - -\wxheading{Data structures} - -{\small \begin{verbatim} -typedef enum { - wxSOUND\_G721, - wxSOUND\_G723\_24, - wxSOUND\_G723\_40 -} wxSoundG72XType -\end{verbatim}} - -{\small \begin{verbatim} -typedef struct g72x\_state g72state -\end{verbatim}} - -This fixes a bug in Mingw95 - -\latexignore{\rtfignore{\wxheading{Members}}} - -\membersection{wxSoundFormatG72X::wxSoundFormatG72X}\label{wxsoundformatg72xwxsoundformatg72x} - -\func{}{wxSoundFormatG72X}{\void} - - -\membersection{wxSoundFormatG72X::\destruct{wxSoundFormatG72X}}\label{wxsoundformatg72xdtor} - -\func{}{\destruct{wxSoundFormatG72X}}{\void} - - -\membersection{wxSoundFormatG72X::SetG72XType}\label{wxsoundformatg72xsetg72xtype} - -\func{void}{SetG72XType}{\param{wxSoundG72XType }{type}} - - -\membersection{wxSoundFormatG72X::GetG72XType}\label{wxsoundformatg72xgetg72xtype} - -\constfunc{wxSoundG72XType}{GetG72XType}{\void} - - -\membersection{wxSoundFormatG72X::SetSampleRate}\label{wxsoundformatg72xsetsamplerate} - -\func{void}{SetSampleRate}{\param{wxUint32 }{srate}} - - -\membersection{wxSoundFormatG72X::GetSampleRate}\label{wxsoundformatg72xgetsamplerate} - -\constfunc{wxUint32}{GetSampleRate}{\void} - - -\membersection{wxSoundFormatG72X::GetType}\label{wxsoundformatg72xgettype} - -\constfunc{wxSoundFormatType}{GetType}{\void} - - -\membersection{wxSoundFormatG72X::Clone}\label{wxsoundformatg72xclone} - -\constfunc{wxSoundFormatBase*}{Clone}{\void} - - -\membersection{wxSoundFormatG72X::GetTimeFromBytes}\label{wxsoundformatg72xgettimefrombytes} - -\constfunc{wxUint32}{GetTimeFromBytes}{\param{wxUint32 }{bytes}} - - -\membersection{wxSoundFormatG72X::GetBytesFromTime}\label{wxsoundformatg72xgetbytesfromtime} - -\constfunc{wxUint32}{GetBytesFromTime}{\param{wxUint32 }{time}} - - -\membersection{wxSoundFormatG72X::operator!=}\label{wxsoundformatg72xoperatorneq} - -\constfunc{bool}{operator!=}{\param{const wxSoundFormatBase\& }{frmt2}} - diff --git a/docs/latex/wx/sndfile.tex b/docs/latex/wx/sndfile.tex deleted file mode 100644 index 83eba90301..0000000000 --- a/docs/latex/wx/sndfile.tex +++ /dev/null @@ -1,217 +0,0 @@ -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%% Name: sndfile.tex -%% Purpose: wxMMedia docs -%% Author: Guilhem Lavaux -%% 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. 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}} - -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} - -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. - -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). - -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. - -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} - -\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. -Several things must be done before calling them. -Users should use Play(), ... - - -\membersection{wxSoundFileStream::StopProduction}\label{wxsoundfilestreamstopproduction} - -\func{bool}{StopProduction}{\void} - - -\membersection{wxSoundFileStream::GetLength}\label{wxsoundfilestreamgetlength} - -\func{wxUint32}{GetLength}{\void} - -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} - - -\membersection{wxSoundFileStream::SetPosition}\label{wxsoundfilestreamsetposition} - -\func{wxUint32}{SetPosition}{\param{wxUint32 }{new\_position}} - - -\membersection{wxSoundFileStream::Read}\label{wxsoundfilestreamread} - -\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}} - -These two functions use the sound format specified by GetSoundFormat(). -All samples must be encoded in that format. - - -\membersection{wxSoundFileStream::Write}\label{wxsoundfilestreamwrite} - -\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundFileStream::SetSoundFormat}\label{wxsoundfilestreamsetsoundformat} - -\func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}} - -This function set the sound format of the file. !! It must be used only -when you are in output mode (concerning the file) !! If you are in -input mode (concerning the file) you can't use this function to modify -the format of the samples returned by Read() ! -For this action, you must use wxSoundRouterStream applied to wxSoundFileStream. - - -\membersection{wxSoundFileStream::GetCodecName}\label{wxsoundfilestreamgetcodecname} - -\constfunc{wxString}{GetCodecName}{\void} - -This function returns the Codec name. This is useful for those who want to build -a player (But also in some other case). - - -\membersection{wxSoundFileStream::CanRead}\label{wxsoundfilestreamcanread} - -\func{bool}{CanRead}{\void} - -You should use this function to test whether this file codec can read -the stream you passed to it. - - -\membersection{wxSoundFileStream::PrepareToPlay}\label{wxsoundfilestreampreparetoplay} - -\func{bool}{PrepareToPlay}{\void} - - -\membersection{wxSoundFileStream::PrepareToRecord}\label{wxsoundfilestreampreparetorecord} - -\func{bool}{PrepareToRecord}{\param{wxUint32 }{time}} - - -\membersection{wxSoundFileStream::FinishRecording}\label{wxsoundfilestreamfinishrecording} - -\func{bool}{FinishRecording}{\void} - - -\membersection{wxSoundFileStream::RepositionStream}\label{wxsoundfilestreamrepositionstream} - -\func{bool}{RepositionStream}{\param{wxUint32 }{position}} - - -\membersection{wxSoundFileStream::FinishPreparation}\label{wxsoundfilestreamfinishpreparation} - -\func{void}{FinishPreparation}{\param{wxUint32 }{len}} - - -\membersection{wxSoundFileStream::GetData}\label{wxsoundfilestreamgetdata} - -\func{wxUint32}{GetData}{\param{void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundFileStream::PutData}\label{wxsoundfilestreamputdata} - -\func{wxUint32}{PutData}{\param{const void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundFileStream::OnSoundEvent}\label{wxsoundfilestreamonsoundevent} - -\func{void}{OnSoundEvent}{\param{int }{evt}} - diff --git a/docs/latex/wx/sndfpcm.tex b/docs/latex/wx/sndfpcm.tex deleted file mode 100644 index 9c14d08a9e..0000000000 --- a/docs/latex/wx/sndfpcm.tex +++ /dev/null @@ -1,104 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndpcm.h at 26/Feb/00 14:26:33 -% - - -\section{\class{wxSoundFormatPcm}}\label{wxsoundformatpcm} - - -PCM specification class - -\wxheading{Derived from} - -\helpref{wxSoundFormatBase}{wxsoundformatbase} - -\wxheading{Data structures} - -\latexignore{\rtfignore{\wxheading{Members}}} - - -\membersection{wxSoundFormatPcm::wxSoundFormatPcm}\label{wxsoundformatpcmwxsoundformatpcm} - -\func{}{wxSoundFormatPcm}{\param{wxUint32 }{srate = 22500}, \param{wxUint8 }{bps = 8}, \param{wxUint16 }{channels = 2}, \param{bool }{sign = TRUE}, \param{int }{order = wxLITTLE\_ENDIAN}} - - -\membersection{wxSoundFormatPcm::\destruct{wxSoundFormatPcm}}\label{wxsoundformatpcmdtor} - -\func{}{\destruct{wxSoundFormatPcm}}{\void} - - -\membersection{wxSoundFormatPcm::SetSampleRate}\label{wxsoundformatpcmsetsamplerate} - -\func{void}{SetSampleRate}{\param{wxUint32 }{srate}} - - -\membersection{wxSoundFormatPcm::SetBPS}\label{wxsoundformatpcmsetbps} - -\func{void}{SetBPS}{\param{wxUint8 }{bps}} - - -\membersection{wxSoundFormatPcm::SetChannels}\label{wxsoundformatpcmsetchannels} - -\func{void}{SetChannels}{\param{wxUint16 }{nchannels}} - - -\membersection{wxSoundFormatPcm::SetOrder}\label{wxsoundformatpcmsetorder} - -\func{void}{SetOrder}{\param{int }{order}} - - -\membersection{wxSoundFormatPcm::Signed}\label{wxsoundformatpcmsigned} - -\func{void}{Signed}{\param{bool }{sign}} - - -\membersection{wxSoundFormatPcm::GetSampleRate}\label{wxsoundformatpcmgetsamplerate} - -\constfunc{wxUint32}{GetSampleRate}{\void} - - -\membersection{wxSoundFormatPcm::GetBPS}\label{wxsoundformatpcmgetbps} - -\constfunc{wxUint8}{GetBPS}{\void} - - -\membersection{wxSoundFormatPcm::GetChannels}\label{wxsoundformatpcmgetchannels} - -\constfunc{wxUint16}{GetChannels}{\void} - - -\membersection{wxSoundFormatPcm::GetOrder}\label{wxsoundformatpcmgetorder} - -\constfunc{int}{GetOrder}{\void} - - -\membersection{wxSoundFormatPcm::Signed}\label{wxsoundformatpcmgetsigned} - -\constfunc{bool}{Signed}{\void} - - -\membersection{wxSoundFormatPcm::GetType}\label{wxsoundformatpcmgettype} - -\constfunc{wxSoundFormatType}{GetType}{\void} - - -\membersection{wxSoundFormatPcm::Clone}\label{wxsoundformatpcmclone} - -\constfunc{wxSoundFormatBase*}{Clone}{\void} - - -\membersection{wxSoundFormatPcm::GetTimeFromBytes}\label{wxsoundformatpcmgettimefrombytes} - -\constfunc{wxUint32}{GetTimeFromBytes}{\param{wxUint32 }{bytes}} - - -\membersection{wxSoundFormatPcm::GetBytesFromTime}\label{wxsoundformatpcmgetbytesfromtime} - -\constfunc{wxUint32}{GetBytesFromTime}{\param{wxUint32 }{time}} - - -\membersection{wxSoundFormatPcm::operator!}\label{wxsoundformatpcmoperatornot} - -\constfunc{bool}{operator!}{\param{const wxSoundFormatBase\& }{frmt2}} - diff --git a/docs/latex/wx/sndfrmt.tex b/docs/latex/wx/sndfrmt.tex deleted file mode 100644 index 388afc7fcd..0000000000 --- a/docs/latex/wx/sndfrmt.tex +++ /dev/null @@ -1,69 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndbase.h at 26/Feb/00 14:23:29 -% - - -\section{\class{wxSoundFormatBase}}\label{wxsoundformatbase} - - -Base class for sound format specification - -\wxheading{Derived from} - -No base class - -\wxheading{Data structures} - -{\small \begin{verbatim} -typedef enum { - wxSOUND\_NOFORMAT, - wxSOUND\_PCM, - wxSOUND\_ULAW, - wxSOUND\_G72X, - wxSOUND\_MSADPCM -} wxSoundFormatType -\end{verbatim}} - -wxSoundFormatType: it specifies the format family of the sound data -which will be passed to the stream. - -\latexignore{\rtfignore{\wxheading{Members}}} - -\membersection{wxSoundFormatBase::wxSoundFormatBase}\label{wxsoundformatbasewxsoundformatbase} - -\func{}{wxSoundFormatBase}{\void} - - -\membersection{wxSoundFormatBase::\destruct{wxSoundFormatBase}}\label{wxsoundformatbasedtor} - -\func{}{\destruct{wxSoundFormatBase}}{\void} - - -\membersection{wxSoundFormatBase::GetType}\label{wxsoundformatbasegettype} - -\constfunc{wxSoundFormatType}{GetType}{\void} - -It returns a "standard" format type. - - -\membersection{wxSoundFormatBase::Clone}\label{wxsoundformatbaseclone} - -\constfunc{wxSoundFormatBase*}{Clone}{\void} - -It clones the current format. - - -\membersection{wxSoundFormatBase::GetTimeFromBytes}\label{wxsoundformatbasegettimefrombytes} - -\constfunc{wxUint32}{GetTimeFromBytes}{\param{wxUint32 }{bytes}} - - -\membersection{wxSoundFormatBase::GetBytesFromTime}\label{wxsoundformatbasegetbytesfromtime} - -\constfunc{wxUint32}{GetBytesFromTime}{\param{wxUint32 }{time}} - - -\membersection{wxSoundFormatBase::operator!=}\label{wxsoundformatbaseoperatorneq} - -\constfunc{bool}{operator!=}{\param{const wxSoundFormatBase\& }{frmt2}} diff --git a/docs/latex/wx/sndfulaw.tex b/docs/latex/wx/sndfulaw.tex deleted file mode 100644 index 538257137f..0000000000 --- a/docs/latex/wx/sndfulaw.tex +++ /dev/null @@ -1,74 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndulaw.h at 26/Feb/00 14:52:25 -% - - -\section{\class{wxSoundFormatUlaw}}\label{wxsoundformatulaw} - - -ULAW format - -\wxheading{Derived from} - -\helpref{wxSoundFormatBase}{wxsoundformatbase} - -\wxheading{Data structures} - -\latexignore{\rtfignore{\wxheading{Members}}} - - -\membersection{wxSoundFormatUlaw::wxSoundFormatUlaw}\label{wxsoundformatulawwxsoundformatulaw} - -\func{}{wxSoundFormatUlaw}{\void} - - -\membersection{wxSoundFormatUlaw::\destruct{wxSoundFormatUlaw}}\label{wxsoundformatulawdtor} - -\func{}{\destruct{wxSoundFormatUlaw}}{\void} - - -\membersection{wxSoundFormatUlaw::SetSampleRate}\label{wxsoundformatulawsetsamplerate} - -\func{void}{SetSampleRate}{\param{wxUint32 }{srate}} - - -\membersection{wxSoundFormatUlaw::GetSampleRate}\label{wxsoundformatulawgetsamplerate} - -\constfunc{wxUint32}{GetSampleRate}{\void} - - -\membersection{wxSoundFormatUlaw::SetChannels}\label{wxsoundformatulawsetchannels} - -\func{void}{SetChannels}{\param{wxUint8 }{channels}} - - -\membersection{wxSoundFormatUlaw::GetChannels}\label{wxsoundformatulawgetchannels} - -\constfunc{wxUint8}{GetChannels}{\void} - - -\membersection{wxSoundFormatUlaw::GetType}\label{wxsoundformatulawgettype} - -\constfunc{wxSoundFormatType}{GetType}{\void} - - -\membersection{wxSoundFormatUlaw::Clone}\label{wxsoundformatulawclone} - -\constfunc{wxSoundFormatBase*}{Clone}{\void} - - -\membersection{wxSoundFormatUlaw::GetTimeFromBytes}\label{wxsoundformatulawgettimefrombytes} - -\constfunc{wxUint32}{GetTimeFromBytes}{\param{wxUint32 }{bytes}} - - -\membersection{wxSoundFormatUlaw::GetBytesFromTime}\label{wxsoundformatulawgetbytesfromtime} - -\constfunc{wxUint32}{GetBytesFromTime}{\param{wxUint32 }{time}} - - -\membersection{wxSoundFormatUlaw::operator!=}\label{wxsoundformatulawoperatorneq} - -\constfunc{bool}{operator!=}{\param{const wxSoundFormatBase\& }{frmt2}} - diff --git a/docs/latex/wx/sndg72x.tex b/docs/latex/wx/sndg72x.tex deleted file mode 100644 index a9e61779a9..0000000000 --- a/docs/latex/wx/sndg72x.tex +++ /dev/null @@ -1,54 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndg72x.h at 26/Feb/00 14:52:19 -% - - -\section{\class{wxSoundStreamG72X}}\label{wxsoundstreamg72x} - - -ULAW converter class - -\wxheading{Derived from} - -\helpref{wxSoundStreamCodec}{wxsoundstreamcodec} - -\wxheading{Data structures} - -\latexignore{\rtfignore{\wxheading{Members}}} - - -\membersection{wxSoundStreamG72X::wxSoundStreamG72X}\label{wxsoundstreamg72xwxsoundstreamg72x} - -\func{}{wxSoundStreamG72X}{\param{wxSoundStream\& }{sndio}} - - -\membersection{wxSoundStreamG72X::\destruct{wxSoundStreamG72X}}\label{wxsoundstreamg72xdtor} - -\func{}{\destruct{wxSoundStreamG72X}}{\void} - - -\membersection{wxSoundStreamG72X::Read}\label{wxsoundstreamg72xread} - -\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundStreamG72X::Write}\label{wxsoundstreamg72xwrite} - -\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundStreamG72X::SetSoundFormat}\label{wxsoundstreamg72xsetsoundformat} - -\func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}} - - -\membersection{wxSoundStreamG72X::PutBits}\label{wxsoundstreamg72xputbits} - -\func{void}{PutBits}{\param{wxUint8 }{bits}} - - -\membersection{wxSoundStreamG72X::GetBits}\label{wxsoundstreamg72xgetbits} - -\func{wxUint8}{GetBits}{\void} - diff --git a/docs/latex/wx/sndoss.tex b/docs/latex/wx/sndoss.tex deleted file mode 100644 index f086ca0bf1..0000000000 --- a/docs/latex/wx/sndoss.tex +++ /dev/null @@ -1,71 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndoss.h at 26/Feb/00 14:26:53 -% - - -\section{\class{wxSoundStreamOSS}}\label{wxsoundstreamoss} - - -OSS output class - -\wxheading{Derived from} - -\helpref{wxSoundStream}{wxsoundstream} - -\wxheading{Data structures} - -\latexignore{\rtfignore{\wxheading{Members}}} - - -\membersection{wxSoundStreamOSS::wxSoundStreamOSS}\label{wxsoundstreamosswxsoundstreamoss} - -\func{}{wxSoundStreamOSS}{\param{const wxString\& }{dev\_name = \_T("/dev/dsp")}} - - -\membersection{wxSoundStreamOSS::\destruct{wxSoundStreamOSS}}\label{wxsoundstreamossdtor} - -\func{}{\destruct{wxSoundStreamOSS}}{\void} - - -\membersection{wxSoundStreamOSS::Read}\label{wxsoundstreamossread} - -\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundStreamOSS::Write}\label{wxsoundstreamosswrite} - -\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundStreamOSS::GetBestSize}\label{wxsoundstreamossgetbestsize} - -\constfunc{wxUint32}{GetBestSize}{\void} - - -\membersection{wxSoundStreamOSS::SetSoundFormat}\label{wxsoundstreamosssetsoundformat} - -\func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}} - - -\membersection{wxSoundStreamOSS::StartProduction}\label{wxsoundstreamossstartproduction} - -\func{bool}{StartProduction}{\param{int }{evt}} - - -\membersection{wxSoundStreamOSS::StopProduction}\label{wxsoundstreamossstopproduction} - -\func{bool}{StopProduction}{\void} - - -\membersection{wxSoundStreamOSS::QueueFilled}\label{wxsoundstreamossqueuefilled} - -\constfunc{bool}{QueueFilled}{\void} - - -\membersection{wxSoundStreamOSS::WakeUpEvt}\label{wxsoundstreamosswakeupevt} - -\func{void}{WakeUpEvt}{\param{int }{evt}} - -You should not call this. - diff --git a/docs/latex/wx/sndpcm.tex b/docs/latex/wx/sndpcm.tex deleted file mode 100644 index 6e392208e6..0000000000 --- a/docs/latex/wx/sndpcm.tex +++ /dev/null @@ -1,48 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndcpcm.h at 26/Feb/00 14:26:35 -% - - -\section{\class{wxSoundStreamPcm}}\label{wxsoundstreampcm} - - -PCM converter class - -\wxheading{Derived from} - -\helpref{wxSoundStreamCodec}{wxsoundstreamcodec} - -\wxheading{Data structures} - -{\small \begin{verbatim} -typedef void (*ConverterType)(const char *buf\_in, char *buf\_out, wxUint32 len) ConverterType -\end{verbatim}} - -\latexignore{\rtfignore{\wxheading{Members}}} - - -\membersection{wxSoundStreamPcm::wxSoundStreamPcm}\label{wxsoundstreampcmwxsoundstreampcm} - -\func{}{wxSoundStreamPcm}{\param{wxSoundStream\& }{sndio}} - - -\membersection{wxSoundStreamPcm::\destruct{wxSoundStreamPcm}}\label{wxsoundstreampcmdtor} - -\func{}{\destruct{wxSoundStreamPcm}}{\void} - - -\membersection{wxSoundStreamPcm::Read}\label{wxsoundstreampcmread} - -\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundStreamPcm::Write}\label{wxsoundstreampcmwrite} - -\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundStreamPcm::SetSoundFormat}\label{wxsoundstreampcmsetsoundformat} - -\func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}} - diff --git a/docs/latex/wx/sndrter.tex b/docs/latex/wx/sndrter.tex deleted file mode 100644 index 67d39bce7b..0000000000 --- a/docs/latex/wx/sndrter.tex +++ /dev/null @@ -1,59 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndfile.h at 26/Feb/00 14:26:42 -% - - -\section{\class{wxSoundRouterStream}}\label{wxsoundrouterstream} - - -Codec router class - -\wxheading{Derived from} - -\helpref{wxSoundStreamCodec}{wxsoundstreamcodec} - -\wxheading{Data structures} - -\latexignore{\rtfignore{\wxheading{Members}}} - - -\membersection{wxSoundRouterStream::wxSoundRouterStream}\label{wxsoundrouterstreamwxsoundrouterstream} - -\func{}{wxSoundRouterStream}{\param{wxSoundStream\& }{sndio}} - - -\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}} - - -\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} - diff --git a/docs/latex/wx/sndulaw.tex b/docs/latex/wx/sndulaw.tex deleted file mode 100644 index d091d63f30..0000000000 --- a/docs/latex/wx/sndulaw.tex +++ /dev/null @@ -1,49 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndulaw.h at 26/Feb/00 14:52:25 -% - - -\section{\class{wxSoundStreamUlaw}}\label{wxsoundstreamulaw} - - -ULAW converter class - -\wxheading{Derived from} - -\helpref{wxSoundStreamCodec}{wxsoundstreamcodec} - -\wxheading{Data structures} - -\latexignore{\rtfignore{\wxheading{Members}}} - - -\membersection{wxSoundStreamUlaw::wxSoundStreamUlaw}\label{wxsoundstreamulawwxsoundstreamulaw} - -\func{}{wxSoundStreamUlaw}{\param{wxSoundStream\& }{sndio}} - - -\membersection{wxSoundStreamUlaw::\destruct{wxSoundStreamUlaw}}\label{wxsoundstreamulawdtor} - -\func{}{\destruct{wxSoundStreamUlaw}}{\void} - - -\membersection{wxSoundStreamUlaw::Read}\label{wxsoundstreamulawread} - -\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundStreamUlaw::Write}\label{wxsoundstreamulawwrite} - -\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundStreamUlaw::SetSoundFormat}\label{wxsoundstreamulawsetsoundformat} - -\func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}} - - -\membersection{wxSoundStreamUlaw::GetBestSize}\label{wxsoundstreamulawgetbestsize} - -\constfunc{wxUint32}{GetBestSize}{\void} - diff --git a/docs/latex/wx/sndwave.tex b/docs/latex/wx/sndwave.tex deleted file mode 100644 index f3c72f0b4e..0000000000 --- a/docs/latex/wx/sndwave.tex +++ /dev/null @@ -1,91 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndwav.h at 26/Feb/00 14:26:40 -% - - -\section{\class{wxSoundWave}}\label{wxsoundwave} - - -WAVE codec - -\wxheading{Derived from} - -\helpref{wxSoundFileStream}{wxsoundfilestream} - -\wxheading{Data structures} - -\latexignore{\rtfignore{\wxheading{Members}}} - - -\membersection{wxSoundWave::wxSoundWave}\label{wxsoundwavewxsoundwave} - -\func{}{wxSoundWave}{\param{wxInputStream\& }{stream}, \param{wxSoundStream\& }{io\_sound}} - -\func{}{wxSoundWave}{\param{wxOutputStream\& }{stream}, \param{wxSoundStream\& }{io\_sound}} - - -\membersection{wxSoundWave::\destruct{wxSoundWave}}\label{wxsoundwavedtor} - -\func{}{\destruct{wxSoundWave}}{\void} - - -\membersection{wxSoundWave::CanRead}\label{wxsoundwavecanread} - -\func{bool}{CanRead}{\void} - - -\membersection{wxSoundWave::GetCodecName}\label{wxsoundwavegetcodecname} - -\constfunc{wxString}{GetCodecName}{\void} - - -\membersection{wxSoundWave::PrepareToPlay}\label{wxsoundwavepreparetoplay} - -\func{bool}{PrepareToPlay}{\void} - - -\membersection{wxSoundWave::PrepareToRecord}\label{wxsoundwavepreparetorecord} - -\func{bool}{PrepareToRecord}{\param{wxUint32 }{time}} - - -\membersection{wxSoundWave::FinishRecording}\label{wxsoundwavefinishrecording} - -\func{bool}{FinishRecording}{\void} - - -\membersection{wxSoundWave::RepositionStream}\label{wxsoundwaverepositionstream} - -\func{bool}{RepositionStream}{\param{wxUint32 }{position}} - - -\membersection{wxSoundWave::GetData}\label{wxsoundwavegetdata} - -\func{wxUint32}{GetData}{\param{void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundWave::PutData}\label{wxsoundwaveputdata} - -\func{wxUint32}{PutData}{\param{const void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundWave::HandleOutputPCM}\label{wxsoundwavehandleoutputpcm} - -\func{bool}{HandleOutputPCM}{\param{wxDataInputStream\& }{data}, \param{wxUint16 }{channels}, \param{wxUint32 }{sample\_fq}, \param{wxUint32 }{byte\_p\_sec}, \param{wxUint16 }{byte\_p\_spl}, \param{wxUint16 }{bits\_p\_spl}} - - -\membersection{wxSoundWave::HandleOutputG721}\label{wxsoundwavehandleoutputg721} - -\func{bool}{HandleOutputG721}{\param{wxDataInputStream\& }{data}, \param{wxUint16 }{channels}, \param{wxUint32 }{sample\_fq}, \param{wxUint32 }{byte\_p\_sec}, \param{wxUint16 }{byte\_p\_spl}, \param{wxUint16 }{bits\_p\_spl}} - - -\membersection{wxSoundWave::HandleInputPCM}\label{wxsoundwavehandleinputpcm} - -\func{wxSoundFormatBase*}{HandleInputPCM}{\param{wxDataOutputStream\& }{data}} - - -\membersection{wxSoundWave::HandleInputG72X}\label{wxsoundwavehandleinputg72x} - -\func{wxSoundFormatBase*}{HandleInputG72X}{\param{wxDataOutputStream\& }{data}} - diff --git a/docs/latex/wx/sndwin.tex b/docs/latex/wx/sndwin.tex deleted file mode 100644 index b0fafe8bef..0000000000 --- a/docs/latex/wx/sndwin.tex +++ /dev/null @@ -1,140 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndwin.h at 26/Feb/00 14:26:51 -% - - -\section{\class{wxSoundStreamWin}}\label{wxsoundstreamwin} - -\wxheading{Derived from} - -\helpref{wxSoundStream}{wxsoundstream} - -\wxheading{Data structures} - -{\small \begin{verbatim} -typedef struct \_wxSoundInternal wxSoundInternal -\end{verbatim}} - -{\small \begin{verbatim} -typedef struct \_wxSoundInfoHeader wxSoundInfoHeader -\end{verbatim}} -\latexignore{\rtfignore{\wxheading{Members}}} - - -\membersection{wxSoundStreamWin::wxSoundStreamWin}\label{wxsoundstreamwinwxsoundstreamwin} - -\func{}{wxSoundStreamWin}{\void} - - -\membersection{wxSoundStreamWin::\destruct{wxSoundStreamWin}}\label{wxsoundstreamwindtor} - -\func{}{\destruct{wxSoundStreamWin}}{\void} - - -\membersection{wxSoundStreamWin::Write}\label{wxsoundstreamwinwrite} - -\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundStreamWin::Read}\label{wxsoundstreamwinread} - -\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}} - - -\membersection{wxSoundStreamWin::SetSoundFormat}\label{wxsoundstreamwinsetsoundformat} - -\func{bool}{SetSoundFormat}{\param{wxSoundFormatBase\& }{base}} - - -\membersection{wxSoundStreamWin::StartProduction}\label{wxsoundstreamwinstartproduction} - -\func{bool}{StartProduction}{\param{int }{evt}} - - -\membersection{wxSoundStreamWin::StopProduction}\label{wxsoundstreamwinstopproduction} - -\func{bool}{StopProduction}{\void} - - -\membersection{wxSoundStreamWin::QueueFilled}\label{wxsoundstreamwinqueuefilled} - -\constfunc{bool}{QueueFilled}{\void} - - -\membersection{wxSoundStreamWin::NotifyDoneBuffer}\label{wxsoundstreamwinnotifydonebuffer} - -\func{void}{NotifyDoneBuffer}{\param{wxUint32 }{dev\_handle}, \param{int }{flag}} - -Internal but defined as public - - -\membersection{wxSoundStreamWin::GetBestSize}\label{wxsoundstreamwingetbestsize} - -\constfunc{wxUint32}{GetBestSize}{\void} - - -\membersection{wxSoundStreamWin::CreateSndWindow}\label{wxsoundstreamwincreatesndwindow} - -\func{void}{CreateSndWindow}{\void} - - -\membersection{wxSoundStreamWin::DestroySndWindow}\label{wxsoundstreamwindestroysndwindow} - -\func{void}{DestroySndWindow}{\void} - - -\membersection{wxSoundStreamWin::OpenDevice}\label{wxsoundstreamwinopendevice} - -\func{bool}{OpenDevice}{\param{int }{mode}} - - -\membersection{wxSoundStreamWin::CloseDevice}\label{wxsoundstreamwinclosedevice} - -\func{void}{CloseDevice}{\void} - - -\membersection{wxSoundStreamWin::AllocHeader}\label{wxsoundstreamwinallocheader} - -\func{wxSoundInfoHeader*}{AllocHeader}{\param{int }{mode}} - - -\membersection{wxSoundStreamWin::FreeHeader}\label{wxsoundstreamwinfreeheader} - -\func{void}{FreeHeader}{\param{wxSoundInfoHeader* }{header}, \param{int }{mode}} - - -\membersection{wxSoundStreamWin::AllocHeaders}\label{wxsoundstreamwinallocheaders} - -\func{bool}{AllocHeaders}{\param{int }{mode}} - - -\membersection{wxSoundStreamWin::FreeHeaders}\label{wxsoundstreamwinfreeheaders} - -\func{void}{FreeHeaders}{\param{int }{mode}} - - -\membersection{wxSoundStreamWin::WaitFor}\label{wxsoundstreamwinwaitfor} - -\func{void}{WaitFor}{\param{wxSoundInfoHeader* }{info}} - - -\membersection{wxSoundStreamWin::AddToQueue}\label{wxsoundstreamwinaddtoqueue} - -\func{bool}{AddToQueue}{\param{wxSoundInfoHeader* }{info}} - - -\membersection{wxSoundStreamWin::ClearHeader}\label{wxsoundstreamwinclearheader} - -\func{void}{ClearHeader}{\param{wxSoundInfoHeader* }{info}} - - -\membersection{wxSoundStreamWin::NextFragmentOutput}\label{wxsoundstreamwinnextfragmentoutput} - -\func{wxSoundInfoHeader*}{NextFragmentOutput}{\void} - - -\membersection{wxSoundStreamWin::NextFragmentInput}\label{wxsoundstreamwinnextfragmentinput} - -\func{wxSoundInfoHeader*}{NextFragmentInput}{\void} - diff --git a/docs/latex/wx/vidbase.tex b/docs/latex/wx/vidbase.tex deleted file mode 100644 index 09b7744412..0000000000 --- a/docs/latex/wx/vidbase.tex +++ /dev/null @@ -1,173 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/vidbase.h at 26/Feb/00 14:51:56 -% - -\section{\class{wxVideoBaseDriver}}\label{wxvideobasedriver} - -Classes definition - -\wxheading{Derived from} - -\helpref{wxObject}{wxobject} - -\wxheading{Data structures} - -{\small \begin{verbatim} -typedef enum { - wxVIDEO\_MSAVI, - wxVIDEO\_MPEG, - wxVIDEO\_QT, - wxVIDEO\_GIF, - wxVIDEO\_JMOV, - wxVIDEO\_FLI, - wxVIDEO\_IFF, - wxVIDEO\_SGI, - wxVIDEO\_MPEG2 -} wxVideoType -\end{verbatim}} - -wxMMedia2 (video) types -\latexignore{\rtfignore{\wxheading{Members}}} - - -\membersection{wxVideoBaseDriver::wxVideoBaseDriver}\label{wxvideobasedriverwxvideobasedriver} - -\func{}{wxVideoBaseDriver}{\void} - -Ctors - - -\membersection{wxVideoBaseDriver::wxVideoBaseDriver}\label{wxvideobasedriverwxvideobasedriver} - -\func{}{wxVideoBaseDriver}{\param{wxInputStream\& }{str}} - - -\membersection{wxVideoBaseDriver::wxVideoBaseDriver}\label{wxvideobasedriverwxvideobasedriver} - -\func{}{wxVideoBaseDriver}{\param{const wxString\& }{filename}} - - -\membersection{wxVideoBaseDriver::\destruct{wxVideoBaseDriver}}\label{wxvideobasedriverdtor} - -\func{}{\destruct{wxVideoBaseDriver}}{\void} - -Dtor - - -\membersection{wxVideoBaseDriver::Play}\label{wxvideobasedriverplay} - -\func{bool}{Play}{\void} - -Usual functions ... They all return FALSE in case of errors. - - -\membersection{wxVideoBaseDriver::Stop}\label{wxvideobasedriverstop} - -\func{bool}{Stop}{\void} - - -\membersection{wxVideoBaseDriver::Pause}\label{wxvideobasedriverpause} - -\func{bool}{Pause}{\void} - - -\membersection{wxVideoBaseDriver::Resume}\label{wxvideobasedriverresume} - -\func{bool}{Resume}{\void} - - -\membersection{wxVideoBaseDriver::SetSize}\label{wxvideobasedriversetsize} - -\func{bool}{SetSize}{\param{wxSize }{size}} - -Size management - - -\membersection{wxVideoBaseDriver::GetSize}\label{wxvideobasedrivergetsize} - -\constfunc{bool}{GetSize}{\param{wxSize\& }{size}} - - -\membersection{wxVideoBaseDriver::IsCapable}\label{wxvideobasedriveriscapable} - -\constfunc{bool}{IsCapable}{\param{wxVideoType }{WXUNUSED(v\_type)}} - -Test the capability of the driver to handle the specified type - - -\membersection{wxVideoBaseDriver::GetMovieCodec}\label{wxvideobasedrivergetmoviecodec} - -\constfunc{wxString}{GetMovieCodec}{\void} - -Return the video codec name - - -\membersection{wxVideoBaseDriver::GetAudioCodec}\label{wxvideobasedrivergetaudiocodec} - -\constfunc{wxString}{GetAudioCodec}{\void} - -Return the audio codec name - - -\membersection{wxVideoBaseDriver::GetSampleRate}\label{wxvideobasedrivergetsamplerate} - -\constfunc{wxUint32}{GetSampleRate}{\void} - -Return misc info about audio - - -\membersection{wxVideoBaseDriver::GetChannels}\label{wxvideobasedrivergetchannels} - -\constfunc{wxUint8}{GetChannels}{\void} - - -\membersection{wxVideoBaseDriver::GetBPS}\label{wxvideobasedrivergetbps} - -\constfunc{wxUint8}{GetBPS}{\void} - - -\membersection{wxVideoBaseDriver::GetFrameRate}\label{wxvideobasedrivergetframerate} - -\constfunc{double}{GetFrameRate}{\void} - -Return frame rate - - -\membersection{wxVideoBaseDriver::GetNbFrames}\label{wxvideobasedrivergetnbframes} - -\constfunc{wxUint32}{GetNbFrames}{\void} - -Return number of frames - - -\membersection{wxVideoBaseDriver::OnFinished}\label{wxvideobasedriveronfinished} - -\func{void}{OnFinished}{\void} - -Called when the movie finished - - -\membersection{wxVideoBaseDriver::AttachOutput}\label{wxvideobasedriverattachoutput} - -\func{bool}{AttachOutput}{\param{wxWindow\& }{output}} - -Attaches the video output to a window. The video will be shown in that window. - - -\membersection{wxVideoBaseDriver::DetachOutput}\label{wxvideobasedriverdetachoutput} - -\func{void}{DetachOutput}{\void} - - -\membersection{wxVideoBaseDriver::IsPaused}\label{wxvideobasedriverispaused} - -\constfunc{bool}{IsPaused}{\void} - -They return the state of the movie. - - -\membersection{wxVideoBaseDriver::IsStopped}\label{wxvideobasedriverisstopped} - -\constfunc{bool}{IsStopped}{\void} - diff --git a/docs/latex/wx/vidxanm.tex b/docs/latex/wx/vidxanm.tex deleted file mode 100644 index bc8f280f6e..0000000000 --- a/docs/latex/wx/vidxanm.tex +++ /dev/null @@ -1,170 +0,0 @@ -% -% automatically generated by HelpGen from -% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/vidxanm.h at 26/Feb/00 14:52:06 -% - - -\section{\class{wxVideoXANIM}}\label{wxvideoxanim} - - - -Class definition - -\wxheading{Derived from} - -\helpref{wxVideoBaseDriver}{wxvideobasedriver} - -\wxheading{Data structures} - -{\small \begin{verbatim} -typedef struct wxXANIMinternal { - Display *xanim\_dpy -\end{verbatim}} -\latexignore{\rtfignore{\wxheading{Members}}} - - -\membersection{wxVideoXANIM::wxVideoXANIM}\label{wxvideoxanimwxvideoxanim} - -\func{}{wxVideoXANIM}{\void} - - -\membersection{wxVideoXANIM::wxVideoXANIM}\label{wxvideoxanimwxvideoxanim} - -\func{}{wxVideoXANIM}{\param{wxInputStream\& }{str}} - - -\membersection{wxVideoXANIM::wxVideoXANIM}\label{wxvideoxanimwxvideoxanim} - -\func{}{wxVideoXANIM}{\param{const wxString\& }{filename}} - - -\membersection{wxVideoXANIM::\destruct{wxVideoXANIM}}\label{wxvideoxanimdtor} - -\func{}{\destruct{wxVideoXANIM}}{\void} - - -\membersection{wxVideoXANIM::Play}\label{wxvideoxanimplay} - -\func{bool}{Play}{\void} - - -\membersection{wxVideoXANIM::Pause}\label{wxvideoxanimpause} - -\func{bool}{Pause}{\void} - - -\membersection{wxVideoXANIM::Resume}\label{wxvideoxanimresume} - -\func{bool}{Resume}{\void} - - -\membersection{wxVideoXANIM::Stop}\label{wxvideoxanimstop} - -\func{bool}{Stop}{\void} - - -\membersection{wxVideoXANIM::SetVolume}\label{wxvideoxanimsetvolume} - -\func{bool}{SetVolume}{\param{wxUint8 }{vol}} - - -\membersection{wxVideoXANIM::SetSize}\label{wxvideoxanimsetsize} - -\func{bool}{SetSize}{\param{wxSize }{size}} - - -\membersection{wxVideoXANIM::GetSize}\label{wxvideoxanimgetsize} - -\constfunc{bool}{GetSize}{\param{wxSize\& }{size}} - - -\membersection{wxVideoXANIM::GetMovieCodec}\label{wxvideoxanimgetmoviecodec} - -\constfunc{wxString}{GetMovieCodec}{\void} - -Return the video codec name - - -\membersection{wxVideoXANIM::GetAudioCodec}\label{wxvideoxanimgetaudiocodec} - -\constfunc{wxString}{GetAudioCodec}{\void} - -Return the audio codec name - - -\membersection{wxVideoXANIM::GetSampleRate}\label{wxvideoxanimgetsamplerate} - -\constfunc{wxUint32}{GetSampleRate}{\void} - -Return misc info about audio - - -\membersection{wxVideoXANIM::GetChannels}\label{wxvideoxanimgetchannels} - -\constfunc{wxUint8}{GetChannels}{\void} - - -\membersection{wxVideoXANIM::GetBPS}\label{wxvideoxanimgetbps} - -\constfunc{wxUint8}{GetBPS}{\void} - - -\membersection{wxVideoXANIM::GetFrameRate}\label{wxvideoxanimgetframerate} - -\constfunc{double}{GetFrameRate}{\void} - -Return frame rate - - -\membersection{wxVideoXANIM::GetNbFrames}\label{wxvideoxanimgetnbframes} - -\constfunc{wxUint32}{GetNbFrames}{\void} - -Return number of frames in the movie - - -\membersection{wxVideoXANIM::IsCapable}\label{wxvideoxanimiscapable} - -\constfunc{bool}{IsCapable}{\param{wxVideoType }{v\_type}} - - -\membersection{wxVideoXANIM::AttachOutput}\label{wxvideoxanimattachoutput} - -\func{bool}{AttachOutput}{\param{wxWindow\& }{output}} - - -\membersection{wxVideoXANIM::DetachOutput}\label{wxvideoxanimdetachoutput} - -\func{void}{DetachOutput}{\void} - - -\membersection{wxVideoXANIM::IsPaused}\label{wxvideoxanimispaused} - -\constfunc{bool}{IsPaused}{\void} - - -\membersection{wxVideoXANIM::IsStopped}\label{wxvideoxanimisstopped} - -\constfunc{bool}{IsStopped}{\void} - - -\membersection{wxVideoXANIM::RestartXANIM}\label{wxvideoxanimrestartxanim} - -\func{bool}{RestartXANIM}{\void} - -Start the subprocess with the right parameters - - -\membersection{wxVideoXANIM::SendCommand}\label{wxvideoxanimsendcommand} - -\func{bool}{SendCommand}{\param{const char* }{command}, \param{char** }{ret = NULL}, \param{wxUint32* }{size = NULL}} - -Send a command to the subprocess - - -\membersection{wxVideoXANIM::CollectInfo}\label{wxvideoxanimcollectinfo} - -\func{bool}{CollectInfo}{\void} - -Collect informations from XAnim -