Query: mlib_signalsinewaveinit_f32
OS: opensolaris
Section: 3mlib
Links: opensolaris man pages all man pages forum categories
Format:Original Unix Latex Style Formatted with HTML and a Horizontal Scroll Bar
mlib_SignalSineWaveInit_F32(3MLIB) mediaLib Library Functions mlib_SignalSineWaveInit_F32(3MLIB)NAMEmlib_SignalSineWaveInit_F32 - sine wave generationSYNOPSIScc [ flag... ] file... -lmlib [ library... ] #include <mlib.h> mlib_status mlib_SignalSineWaveInit_F32(void **state, mlib_f32 mag, mlib_f32 freq, mlib_f32 phase);DESCRIPTIONThe mlib_SignalSineWaveInit_F32() function allocates memory for an internal state structure and converts the parameters of the wave to an internal representation.PARAMETERSThe function takes the following arguments: state Internal state structure. mag Magnitude of sine wave to be generated, in Q15 format. freq Angular frequency of the sine wave to be generated, measured in radians per sample. phase Start phase of the sine wave to be generated, measured in radians.RETURN VALUESThe function returns MLIB_SUCCESS if successful. Otherwise it returns MLIB_FAILURE.ATTRIBUTESSee attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Committed | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+SEE ALSOattributes(5) SunOS 5.11 2 Mar 2007 mlib_SignalSineWaveInit_F32(3MLIB)