opensolaris man page for mlib_signalwhitenoise_s16

mlib_SignalWhiteNoise_S16(3MLIB)			    mediaLib Library Functions				  mlib_SignalWhiteNoise_S16(3MLIB)

NAME
       mlib_SignalWhiteNoise_S16 - white noise generation

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

       mlib_status mlib_SignalWhiteNoise_S16(mlib_s16 *wnoise,
	    void *state, mlib_s32 n);

DESCRIPTION
       The mlib_SignalWhiteNoise_S16() function generates one packet of white noise and updates the internal state.

PARAMETERS
       The function takes the following arguments:

       wnoise	 Generated white noise 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_SignalWhiteNoiseFree_S16(3MLIB), mlib_SignalWhiteNoiseInit_S16(3MLIB), attributes(5)

SunOS 5.11							    2 Mar 2007					  mlib_SignalWhiteNoise_S16(3MLIB)