Content-type: text/html Man page of mlib_SignalWhiteNoiseInit_S16

mlib_SignalWhiteNoiseInit_S16

Section: mediaLib Library Functions (3MLIB)
Updated: 2 Mar 2007
Index Return to Main Contents
 

NAME

mlib_SignalWhiteNoiseInit_S16 - white noise generation  

SYNOPSIS

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

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 attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE

Interface StabilityCommitted

MT-Level

 

SEE ALSO

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


 

Index

NAME
SYNOPSIS
DESCRIPTION
PARAMETERS
RETURN VALUES
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:38:06 GMT, October 02, 2010