]> git.saurik.com Git - wxWidgets.git/blame - contrib/docs/latex/mmedia/vidxanm.tex
corrected version number extraction
[wxWidgets.git] / contrib / docs / latex / mmedia / vidxanm.tex
CommitLineData
e8482f24
GL
1%
2% automatically generated by HelpGen from
3% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/vidxanm.h at 26/Feb/00 14:52:06
4%
5
6
7\section{\class{wxVideoXANIM}}\label{wxvideoxanim}
8
9
10
11Class definition
12
13\wxheading{Derived from}
14
15\helpref{wxVideoBaseDriver}{wxvideobasedriver}
16
17\wxheading{Data structures}
18
19{\small \begin{verbatim}
20typedef struct wxXANIMinternal {
21 Display *xanim\_dpy
22\end{verbatim}}
23\latexignore{\rtfignore{\wxheading{Members}}}
24
25
26\membersection{wxVideoXANIM::wxVideoXANIM}\label{wxvideoxanimwxvideoxanim}
27
28\func{}{wxVideoXANIM}{\void}
29
30
31\membersection{wxVideoXANIM::wxVideoXANIM}\label{wxvideoxanimwxvideoxanim}
32
33\func{}{wxVideoXANIM}{\param{wxInputStream\& }{str}}
34
35
36\membersection{wxVideoXANIM::wxVideoXANIM}\label{wxvideoxanimwxvideoxanim}
37
38\func{}{wxVideoXANIM}{\param{const wxString\& }{filename}}
39
40
41\membersection{wxVideoXANIM::\destruct{wxVideoXANIM}}\label{wxvideoxanimdtor}
42
43\func{}{\destruct{wxVideoXANIM}}{\void}
44
45
46\membersection{wxVideoXANIM::Play}\label{wxvideoxanimplay}
47
48\func{bool}{Play}{\void}
49
50
51\membersection{wxVideoXANIM::Pause}\label{wxvideoxanimpause}
52
53\func{bool}{Pause}{\void}
54
55
56\membersection{wxVideoXANIM::Resume}\label{wxvideoxanimresume}
57
58\func{bool}{Resume}{\void}
59
60
61\membersection{wxVideoXANIM::Stop}\label{wxvideoxanimstop}
62
63\func{bool}{Stop}{\void}
64
65
66\membersection{wxVideoXANIM::SetVolume}\label{wxvideoxanimsetvolume}
67
68\func{bool}{SetVolume}{\param{wxUint8 }{vol}}
69
70
71\membersection{wxVideoXANIM::SetSize}\label{wxvideoxanimsetsize}
72
73\func{bool}{SetSize}{\param{wxSize }{size}}
74
75
76\membersection{wxVideoXANIM::GetSize}\label{wxvideoxanimgetsize}
77
78\constfunc{bool}{GetSize}{\param{wxSize\& }{size}}
79
80
81\membersection{wxVideoXANIM::GetMovieCodec}\label{wxvideoxanimgetmoviecodec}
82
83\constfunc{wxString}{GetMovieCodec}{\void}
84
85Return the video codec name
86
87
88\membersection{wxVideoXANIM::GetAudioCodec}\label{wxvideoxanimgetaudiocodec}
89
90\constfunc{wxString}{GetAudioCodec}{\void}
91
92Return the audio codec name
93
94
95\membersection{wxVideoXANIM::GetSampleRate}\label{wxvideoxanimgetsamplerate}
96
97\constfunc{wxUint32}{GetSampleRate}{\void}
98
99Return misc info about audio
100
101
102\membersection{wxVideoXANIM::GetChannels}\label{wxvideoxanimgetchannels}
103
104\constfunc{wxUint8}{GetChannels}{\void}
105
106
107\membersection{wxVideoXANIM::GetBPS}\label{wxvideoxanimgetbps}
108
109\constfunc{wxUint8}{GetBPS}{\void}
110
111
112\membersection{wxVideoXANIM::GetFrameRate}\label{wxvideoxanimgetframerate}
113
114\constfunc{double}{GetFrameRate}{\void}
115
116Return frame rate
117
118
119\membersection{wxVideoXANIM::GetNbFrames}\label{wxvideoxanimgetnbframes}
120
121\constfunc{wxUint32}{GetNbFrames}{\void}
122
123Return number of frames in the movie
124
125
126\membersection{wxVideoXANIM::IsCapable}\label{wxvideoxanimiscapable}
127
128\constfunc{bool}{IsCapable}{\param{wxVideoType }{v\_type}}
129
130
131\membersection{wxVideoXANIM::AttachOutput}\label{wxvideoxanimattachoutput}
132
133\func{bool}{AttachOutput}{\param{wxWindow\& }{output}}
134
135
136\membersection{wxVideoXANIM::DetachOutput}\label{wxvideoxanimdetachoutput}
137
138\func{void}{DetachOutput}{\void}
139
140
141\membersection{wxVideoXANIM::IsPaused}\label{wxvideoxanimispaused}
142
143\constfunc{bool}{IsPaused}{\void}
144
145
146\membersection{wxVideoXANIM::IsStopped}\label{wxvideoxanimisstopped}
147
148\constfunc{bool}{IsStopped}{\void}
149
150
151\membersection{wxVideoXANIM::RestartXANIM}\label{wxvideoxanimrestartxanim}
152
153\func{bool}{RestartXANIM}{\void}
154
155Start the subprocess with the right parameters
156
157
158\membersection{wxVideoXANIM::SendCommand}\label{wxvideoxanimsendcommand}
159
160\func{bool}{SendCommand}{\param{const char* }{command}, \param{char** }{ret = NULL}, \param{wxUint32* }{size = NULL}}
161
162Send a command to the subprocess
163
164
165\membersection{wxVideoXANIM::CollectInfo}\label{wxvideoxanimcollectinfo}
166
167\func{bool}{CollectInfo}{\void}
168
169Collect informations from XAnim
170