Manual Pages for UNIX Operating System command usage for man mlib_SignalSineWaveInit_S16

mediaLib Library Functions     mlib_SignalSineWaveInit_S16(3MLIB)



NAME
     mlib_SignalSineWaveInit_S16 - sine wave generation

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

     mlib_status mlib_SignalSineWaveInit_S16(void **state,
          mlib_s16 mag, mlib_f32 freq, mlib_f32 phase);


DESCRIPTION
     The mlib_SignalSineWaveInit_S16() function allocates  memory
     for  an internal state structure and converts the parameters
     of the wave to an internal representation.

PARAMETERS
     The function takes the following arguments:

     state    Internal state structure.


     mag      Magnitude of sine wave to be generated, in Q15 for-
              mat.


     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, meas-
              ured in radians.


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:














SunOS 5.11           Last change: 2 Mar 2007                    1






mediaLib Library Functions     mlib_SignalSineWaveInit_S16(3MLIB)



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


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











































SunOS 5.11           Last change: 2 Mar 2007                    2