opensolaris man page for mlib_signalsinewave_s16

mlib_SignalSineWave_S16(3MLIB)				    mediaLib Library Functions				    mlib_SignalSineWave_S16(3MLIB)

NAME
       mlib_SignalSineWave_S16 - sine wave generation

SYNOPSIS
       cc [ flag... ] file... -lmlib [ library... ]
       #include <mlib.h>

       mlib_status mlib_SignalSineWave_S16(mlib_s16 *sine, void *state,
	    mlib_s32 n);

DESCRIPTION
       The mlib_SignalSineWave_S16() function generates one packet of sine wave and updates the internal state.

PARAMETERS
       The function takes the following arguments:

       sine	Generated sine wave array.

       state	Internal state structure.

       n	Length of the generated sine wave array in number of samples.

RETURN VALUES
       The function returns MLIB_SUCCESS if successful. Otherwise it returns MLIB_FAILURE.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Committed 		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       mlib_SignalSineWaveFree_S16(3MLIB), mlib_SignalSineWaveInit_S16(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007					    mlib_SignalSineWave_S16(3MLIB)