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