Manual Pages for UNIX Operating System command usage for man mlib_SignalWhiteNoiseInit_S16

mediaLib Library Functions   mlib_SignalWhiteNoiseInit_S16(3MLIB)



NAME
     mlib_SignalWhiteNoiseInit_S16 - white noise generation

SYNOPSIS
     cc [ flag... ] file... -lmlib [ library... ]
     #include 

     mlib_status mlib_SignalWhiteNoiseInit_S16(void **state,
          mlib_s16 mag, mlib_s16 seed);


DESCRIPTION
     The   mlib_SignalWhiteNoiseInit_S16()   function   allocates
     memory  for  an  internal  state  structure and converts the
     parameters into an internal representation.

PARAMETERS
     The function takes the following arguments:

     state    Internal state structure.


     mag      Magnitude of white noise to be  generated,  in  Q15
              format.


     seed     Seed value for the pseudorandom number generator.


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

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



     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Interface Stability         | Committed                   |
    |_____________________________|_____________________________|
    | MT-Level                    | MT-Safe                     |
    |_____________________________|_____________________________|


SEE ALSO
     mlib_SignalWhiteNoise_S16(3MLIB),
     mlib_SignalWhiteNoiseFree_S16(3MLIB), attributes(5)




SunOS 5.11           Last change: 2 Mar 2007                    1