Doc edits; adding mmedia.rsp; added STC BC++ makefiles
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6693 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -3,19 +3,21 @@
|
||||
% /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}
|
||||
wxObject
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
{\small \begin{verbatim}
|
||||
{\small
|
||||
\begin{verbatim}
|
||||
typedef struct wxCDtime {
|
||||
wxUint8 track
|
||||
\end{verbatim}}
|
||||
};
|
||||
\end{verbatim}
|
||||
}
|
||||
{\small \begin{verbatim}
|
||||
typedef enum { PLAYING, PAUSED, STOPPED } CDstatus
|
||||
\end{verbatim}}
|
||||
|
@@ -6,8 +6,6 @@
|
||||
|
||||
\section{\class{wxCDAudioLinux}}\label{wxcdaudiolinux}
|
||||
|
||||
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxCDAudio}{wxcdaudio}
|
||||
@@ -16,17 +14,12 @@
|
||||
|
||||
\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}
|
||||
|
@@ -14,10 +14,14 @@
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
{\small \begin{verbatim}
|
||||
{\small
|
||||
\begin{verbatim}
|
||||
typedef struct CDAW\_Internal {
|
||||
MCIDEVICEID dev\_id
|
||||
\end{verbatim}}
|
||||
};
|
||||
\end{verbatim}
|
||||
}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
@@ -25,9 +29,6 @@ typedef struct CDAW\_Internal {
|
||||
|
||||
\func{}{wxCDAudioWin}{\void}
|
||||
|
||||
|
||||
\membersection{wxCDAudioWin::wxCDAudioWin}\label{wxcdaudiowinwxcdaudiowin}
|
||||
|
||||
\func{}{wxCDAudioWin}{\param{const char* }{dev\_name}}
|
||||
|
||||
|
||||
|
@@ -17,7 +17,6 @@ No base class
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
|
||||
\membersection{CDtoc::CDtoc}\label{cdtoccdtoc}
|
||||
|
||||
\func{}{CDtoc}{\param{wxCDtime\& }{tot\_tm}, \param{wxCDtime* }{trks\_tm}, \param{wxCDtime* }{trks\_pos}}
|
||||
@@ -62,16 +61,10 @@ Returns the total time
|
||||
|
||||
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}}
|
||||
|
||||
|
||||
|
@@ -1,8 +1,8 @@
|
||||
chapter{Class reference}\label{classref}
|
||||
\chapter{Class reference}\label{classref}
|
||||
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
|
||||
\setfooter{\thepage}{}{}{}{}{\thepage}
|
||||
|
||||
These are the main mmedia classes.
|
||||
These are the main Mmedia classes.
|
||||
|
||||
\input cdaudio.tex
|
||||
\input cdaudlnx.tex
|
||||
|
@@ -10,9 +10,9 @@
|
||||
\input psbox.tex
|
||||
\parindent 0pt
|
||||
\parskip 11pt
|
||||
\title{Object Graphics Library 3.0}
|
||||
\author{Julian Smart}
|
||||
\date{September 1998}
|
||||
\title{MMedia for wxWindows}
|
||||
\author{Guilhem Lavaux}
|
||||
\date{March 2000}
|
||||
|
||||
\makeindex
|
||||
\begin{document}
|
||||
|
@@ -1,17 +0,0 @@
|
||||
[OPTIONS]
|
||||
BMROOT=d:\wx2\wxwind~1\docs\latex\ogl ; Assume that bitmaps are where the source is
|
||||
TITLE=OGL Manual
|
||||
CONTENTS=Contents
|
||||
COMPRESS=HIGH
|
||||
|
||||
[FILES]
|
||||
ogl.rtf
|
||||
|
||||
[CONFIG]
|
||||
CreateButton("Up", "&Up", "JumpId(`ogl.hlp', `Contents')")
|
||||
BrowseButtons()
|
||||
|
||||
[MAP]
|
||||
|
||||
[BITMAPS]
|
||||
|
Binary file not shown.
Before Width: | Height: | Size: 86 KiB |
Binary file not shown.
Before Width: | Height: | Size: 7.0 KiB |
@@ -1,3 +1,6 @@
|
||||
\chapter{OGLEdit: a sample OGL application}\label{ogledit}%
|
||||
\chapter{MMboard: a sample MMedia application}\label{mmboard}%
|
||||
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
|
||||
\setfooter{\thepage}{}{}{}{}{\thepage}
|
||||
|
||||
To be written.
|
||||
|
||||
|
@@ -205,10 +205,9 @@ 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.
|
||||
|
||||
the error with
|
||||
\helpref{wxSoundStream::GetError}{wxsoundstreamgeterror}. See
|
||||
\helpref{wxSoundStream errors section}{wxsoundstream} for more details.
|
||||
|
||||
\wxheading{Note}
|
||||
|
||||
@@ -248,7 +247,7 @@ Each callback has its callback data.
|
||||
|
||||
\func{bool}{StartProduction}{\param{int }{evt}}
|
||||
|
||||
StartProduction starts the sound streaming. {\it evt} may be one of
|
||||
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
|
||||
@@ -257,32 +256,39 @@ 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.
|
||||
|
||||
|
@@ -1,4 +1,3 @@
|
||||
; Last change: JS 8 Sep 98 2:54 pm
|
||||
runTwice = yes
|
||||
titleFontSize = 12
|
||||
authorFontSize = 10
|
||||
@@ -9,11 +8,11 @@ headerRule = yes
|
||||
footerRule = yes
|
||||
useHeadingStyles = yes
|
||||
listItemIndent=40
|
||||
generateHPJ = no
|
||||
generateHPJ = yes
|
||||
htmlBrowseButtons = bitmap
|
||||
winHelpVersion = 3
|
||||
winHelpContents = yes
|
||||
winHelpTitle = "OGL Manual"
|
||||
winHelpTitle = "MMedia Manual"
|
||||
truncateFilenames = yes
|
||||
combineSubSections = yes
|
||||
\overview [2] {\rtfonly{See also }\settransparency{on}\sethotspotcolour{off}\sethotspotunderline{on}\winhelponly{\image{}{books.bmp}\settransparency{off}}
|
||||
|
@@ -1,4 +1,4 @@
|
||||
\chapter{Topic overviews}
|
||||
\chapter{Topic overviews}\label{overviews}
|
||||
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
|
||||
\setfooter{\thepage}{}{}{}{}{\thepage}
|
||||
|
||||
@@ -6,3 +6,5 @@ The following sections describe particular topics.
|
||||
|
||||
\section{MMedia extension overview}\label{mmedoverview}
|
||||
|
||||
To be written.
|
||||
|
||||
|
@@ -9,7 +9,7 @@ Classes definition
|
||||
|
||||
\wxheading{Derived from}
|
||||
|
||||
\helpref{wxObject}{wxobject}
|
||||
wxObject
|
||||
|
||||
\wxheading{Data structures}
|
||||
|
||||
|
@@ -19,9 +19,10 @@ Class definition
|
||||
{\small \begin{verbatim}
|
||||
typedef struct VIDW\_Internal {
|
||||
MCIDEVICEID m\_dev\_id
|
||||
};
|
||||
\end{verbatim}}
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\latexignore{\rtfignore{\wxheading{Members}}}
|
||||
|
||||
\membersection{wxVideoWindows::OpenFile}\label{wxvideowindowsopenfile}
|
||||
|
||||
|
Reference in New Issue
Block a user