git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

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