git.saurik.com Git - wxWidgets.git/blame_incremental - contrib/docs/latex/mmedia/vidbase.tex

... / ...

Commit	Line	Data
	1	%
	2	% automatically generated by HelpGen from
	3	% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/vidbase.h at 26/Feb/00 14:51:56
	4	%
	5
	6	\section{\class{wxVideoBaseDriver}}\label{wxvideobasedriver}
	7
	8	Classes definition
	9
	10	\wxheading{Derived from}
	11
	12	wxObject
	13
	14	\wxheading{Data structures}
	15
	16	{\small \begin{verbatim}
	17	typedef enum {
	18	wxVIDEO\_MSAVI,
	19	wxVIDEO\_MPEG,
	20	wxVIDEO\_QT,
	21	wxVIDEO\_GIF,
	22	wxVIDEO\_JMOV,
	23	wxVIDEO\_FLI,
	24	wxVIDEO\_IFF,
	25	wxVIDEO\_SGI,
	26	wxVIDEO\_MPEG2
	27	} wxVideoType
	28	\end{verbatim}}
	29
	30	wxMMedia2 (video) types
	31	\latexignore{\rtfignore{\wxheading{Members}}}
	32
	33
	34	\membersection{wxVideoBaseDriver::wxVideoBaseDriver}\label{wxvideobasedriverwxvideobasedriver}
	35
	36	\func{}{wxVideoBaseDriver}{\void}
	37
	38	Ctors
	39
	40
	41	\membersection{wxVideoBaseDriver::wxVideoBaseDriver}\label{wxvideobasedriverwxvideobasedriver}
	42
	43	\func{}{wxVideoBaseDriver}{\param{wxInputStream\& }{str}}
	44
	45
	46	\membersection{wxVideoBaseDriver::wxVideoBaseDriver}\label{wxvideobasedriverwxvideobasedriver}
	47
	48	\func{}{wxVideoBaseDriver}{\param{const wxString\& }{filename}}
	49
	50
	51	\membersection{wxVideoBaseDriver::\destruct{wxVideoBaseDriver}}\label{wxvideobasedriverdtor}
	52
	53	\func{}{\destruct{wxVideoBaseDriver}}{\void}
	54
	55	Dtor
	56
	57
	58	\membersection{wxVideoBaseDriver::Play}\label{wxvideobasedriverplay}
	59
	60	\func{bool}{Play}{\void}
	61
	62	Usual functions ... They all return FALSE in case of errors.
	63
	64
	65	\membersection{wxVideoBaseDriver::Stop}\label{wxvideobasedriverstop}
	66
	67	\func{bool}{Stop}{\void}
	68
	69
	70	\membersection{wxVideoBaseDriver::Pause}\label{wxvideobasedriverpause}
	71
	72	\func{bool}{Pause}{\void}
	73
	74
	75	\membersection{wxVideoBaseDriver::Resume}\label{wxvideobasedriverresume}
	76
	77	\func{bool}{Resume}{\void}
	78
	79
	80	\membersection{wxVideoBaseDriver::SetSize}\label{wxvideobasedriversetsize}
	81
	82	\func{bool}{SetSize}{\param{wxSize }{size}}
	83
	84	Size management
	85
	86
	87	\membersection{wxVideoBaseDriver::GetSize}\label{wxvideobasedrivergetsize}
	88
	89	\constfunc{bool}{GetSize}{\param{wxSize\& }{size}}
	90
	91
	92	\membersection{wxVideoBaseDriver::IsCapable}\label{wxvideobasedriveriscapable}
	93
	94	\constfunc{bool}{IsCapable}{\param{wxVideoType }{WXUNUSED(v\_type)}}
	95
	96	Test the capability of the driver to handle the specified type
	97
	98
	99	\membersection{wxVideoBaseDriver::GetMovieCodec}\label{wxvideobasedrivergetmoviecodec}
	100
	101	\constfunc{wxString}{GetMovieCodec}{\void}
	102
	103	Return the video codec name
	104
	105
	106	\membersection{wxVideoBaseDriver::GetAudioCodec}\label{wxvideobasedrivergetaudiocodec}
	107
	108	\constfunc{wxString}{GetAudioCodec}{\void}
	109
	110	Return the audio codec name
	111
	112
	113	\membersection{wxVideoBaseDriver::GetSampleRate}\label{wxvideobasedrivergetsamplerate}
	114
	115	\constfunc{wxUint32}{GetSampleRate}{\void}
	116
	117	Return misc info about audio
	118
	119
	120	\membersection{wxVideoBaseDriver::GetChannels}\label{wxvideobasedrivergetchannels}
	121
	122	\constfunc{wxUint8}{GetChannels}{\void}
	123
	124
	125	\membersection{wxVideoBaseDriver::GetBPS}\label{wxvideobasedrivergetbps}
	126
	127	\constfunc{wxUint8}{GetBPS}{\void}
	128
	129
	130	\membersection{wxVideoBaseDriver::GetFrameRate}\label{wxvideobasedrivergetframerate}
	131
	132	\constfunc{double}{GetFrameRate}{\void}
	133
	134	Return frame rate
	135
	136
	137	\membersection{wxVideoBaseDriver::GetNbFrames}\label{wxvideobasedrivergetnbframes}
	138
	139	\constfunc{wxUint32}{GetNbFrames}{\void}
	140
	141	Return number of frames
	142
	143
	144	\membersection{wxVideoBaseDriver::OnFinished}\label{wxvideobasedriveronfinished}
	145
	146	\func{void}{OnFinished}{\void}
	147
	148	Called when the movie finished
	149
	150
	151	\membersection{wxVideoBaseDriver::AttachOutput}\label{wxvideobasedriverattachoutput}
	152
	153	\func{bool}{AttachOutput}{\param{wxWindow\& }{output}}
	154
	155	Attaches the video output to a window. The video will be shown in that window.
	156
	157
	158	\membersection{wxVideoBaseDriver::DetachOutput}\label{wxvideobasedriverdetachoutput}
	159
	160	\func{void}{DetachOutput}{\void}
	161
	162
	163	\membersection{wxVideoBaseDriver::IsPaused}\label{wxvideobasedriverispaused}
	164
	165	\constfunc{bool}{IsPaused}{\void}
	166
	167	They return the state of the movie.
	168
	169
	170	\membersection{wxVideoBaseDriver::IsStopped}\label{wxvideobasedriverisstopped}
	171
	172	\constfunc{bool}{IsStopped}{\void}
	173