]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/sndfile.tex
documented VFS handlers
[wxWidgets.git] / docs / latex / wx / sndfile.tex
CommitLineData
272c4453
GL
1%
2% automatically generated by HelpGen from
3% /home/guilhem/PROJECTS/wxWindows/utils/wxMMedia2/lib/sndfile.h at 26/Feb/00 14:26:42
4%
5
6
7\section{\class{wxSoundFileStream}}\label{wxsoundfilestream}
8
9
10Base class for file coders/decoders
11
12\wxheading{Derived from}
13
14\helpref{wxSoundStream}{wxsoundstream}
15
16\wxheading{Data structures}
17
18\latexignore{\rtfignore{\wxheading{Members}}}
19
20
21\membersection{wxSoundFileStream::wxSoundFileStream}\label{wxsoundfilestreamwxsoundfilestream}
22
23\func{}{wxSoundFileStream}{\param{wxInputStream\& }{stream}, \param{wxSoundStream\& }{io\_sound}}
24
25
26\membersection{wxSoundFileStream::wxSoundFileStream}\label{wxsoundfilestreamwxsoundfilestream}
27
28\func{}{wxSoundFileStream}{\param{wxOutputStream\& }{stream}, \param{wxSoundStream\& }{io\_sound}}
29
30
31\membersection{wxSoundFileStream::\destruct{wxSoundFileStream}}\label{wxsoundfilestreamdtor}
32
33\func{}{\destruct{wxSoundFileStream}}{\void}
34
35
36\membersection{wxSoundFileStream::Play}\label{wxsoundfilestreamplay}
37
38\func{bool}{Play}{\void}
39
40Usual sound file calls (Play, Stop, ...)
41
42
43\membersection{wxSoundFileStream::Record}\label{wxsoundfilestreamrecord}
44
45\func{bool}{Record}{\param{wxUint32 }{time}}
46
47
48\membersection{wxSoundFileStream::Stop}\label{wxsoundfilestreamstop}
49
50\func{bool}{Stop}{\void}
51
52
53\membersection{wxSoundFileStream::Pause}\label{wxsoundfilestreampause}
54
55\func{bool}{Pause}{\void}
56
57
58\membersection{wxSoundFileStream::Resume}\label{wxsoundfilestreamresume}
59
60\func{bool}{Resume}{\void}
61
62
63\membersection{wxSoundFileStream::IsStopped}\label{wxsoundfilestreamisstopped}
64
65\constfunc{bool}{IsStopped}{\void}
66
67Functions which return the current state
68
69
70\membersection{wxSoundFileStream::IsPaused}\label{wxsoundfilestreamispaused}
71
72\constfunc{bool}{IsPaused}{\void}
73
74
75\membersection{wxSoundFileStream::StartProduction}\label{wxsoundfilestreamstartproduction}
76
77\func{bool}{StartProduction}{\param{int }{evt}}
78
79A user should not call these two functions.
80Several things must be done before calling them.
81Users should use Play(), ...
82
83
84\membersection{wxSoundFileStream::StopProduction}\label{wxsoundfilestreamstopproduction}
85
86\func{bool}{StopProduction}{\void}
87
88
89\membersection{wxSoundFileStream::GetLength}\label{wxsoundfilestreamgetlength}
90
91\func{wxUint32}{GetLength}{\void}
92
93These three functions deals with the length, the position in the sound file.
94All the values are expressed in bytes. If you need the values expressed
95in terms of time, you have to use GetSoundFormat().GetTimeFromBytes(...)
96
97
98\membersection{wxSoundFileStream::GetPosition}\label{wxsoundfilestreamgetposition}
99
100\func{wxUint32}{GetPosition}{\void}
101
102
103\membersection{wxSoundFileStream::SetPosition}\label{wxsoundfilestreamsetposition}
104
105\func{wxUint32}{SetPosition}{\param{wxUint32 }{new\_position}}
106
107
108\membersection{wxSoundFileStream::Read}\label{wxsoundfilestreamread}
109
110\func{wxSoundStream\&}{Read}{\param{void* }{buffer}, \param{wxUint32 }{len}}
111
112These two functions use the sound format specified by GetSoundFormat().
113All samples must be encoded in that format.
114
115
116\membersection{wxSoundFileStream::Write}\label{wxsoundfilestreamwrite}
117
118\func{wxSoundStream\&}{Write}{\param{const void* }{buffer}, \param{wxUint32 }{len}}
119
120
121\membersection{wxSoundFileStream::SetSoundFormat}\label{wxsoundfilestreamsetsoundformat}
122
123\func{bool}{SetSoundFormat}{\param{const wxSoundFormatBase\& }{format}}
124
125This function set the sound format of the file. !! It must be used only
126when you are in output mode (concerning the file) !! If you are in
127input mode (concerning the file) you can't use this function to modify
128the format of the samples returned by Read() !
129For this action, you must use wxSoundRouterStream applied to wxSoundFileStream.
130
131
132\membersection{wxSoundFileStream::GetCodecName}\label{wxsoundfilestreamgetcodecname}
133
134\constfunc{wxString}{GetCodecName}{\void}
135
136This function returns the Codec name. This is useful for those who want to build
137a player (But also in some other case).
138
139
140\membersection{wxSoundFileStream::CanRead}\label{wxsoundfilestreamcanread}
141
142\func{bool}{CanRead}{\void}
143
144You should use this function to test whether this file codec can read
145the stream you passed to it.
146
147
148\membersection{wxSoundFileStream::PrepareToPlay}\label{wxsoundfilestreampreparetoplay}
149
150\func{bool}{PrepareToPlay}{\void}
151
152
153\membersection{wxSoundFileStream::PrepareToRecord}\label{wxsoundfilestreampreparetorecord}
154
155\func{bool}{PrepareToRecord}{\param{wxUint32 }{time}}
156
157
158\membersection{wxSoundFileStream::FinishRecording}\label{wxsoundfilestreamfinishrecording}
159
160\func{bool}{FinishRecording}{\void}
161
162
163\membersection{wxSoundFileStream::RepositionStream}\label{wxsoundfilestreamrepositionstream}
164
165\func{bool}{RepositionStream}{\param{wxUint32 }{position}}
166
167
168\membersection{wxSoundFileStream::FinishPreparation}\label{wxsoundfilestreamfinishpreparation}
169
170\func{void}{FinishPreparation}{\param{wxUint32 }{len}}
171
172
173\membersection{wxSoundFileStream::GetData}\label{wxsoundfilestreamgetdata}
174
175\func{wxUint32}{GetData}{\param{void* }{buffer}, \param{wxUint32 }{len}}
176
177
178\membersection{wxSoundFileStream::PutData}\label{wxsoundfilestreamputdata}
179
180\func{wxUint32}{PutData}{\param{const void* }{buffer}, \param{wxUint32 }{len}}
181
182
183\membersection{wxSoundFileStream::OnSoundEvent}\label{wxsoundfilestreamonsoundevent}
184
185\func{void}{OnSoundEvent}{\param{int }{evt}}
186