dmFS1016DecoderGetParams(3dm)

NAME
     dmFS1016DecoderGetParams - get FS1016 decoder parameter values


SYNOPSIS
     #include <dmedia/dm_audioutil.h>
     #include <dmedia/dm_audio.h>
     #include <dmedia/dm_params.h>

     DMstatus dmFS1016DecoderGetParams(DMFS1016decoder handle,
                                   DMparams *params)


PARAMETER
     handle   DMFS1016decoder structure, created by
              dmFS1016DecoderCreate(3dm).


     params   List of parameters for query.


RETURNED VALUE
     Returns DM_SUCCESS or DM_FAILURE.


DESCRIPTION
     dmFS1016DecoderGetParams(3dm) gets state of FS1016 decoder with params.


     The set of parameters of params for query are, defined in
     dmedia/dm_audioutil.h and dmedia/dm_audio.h:

     DM_AUDIO_BITRATE
     DM_AUDIO_CODEC_MAX_BYTES_PER_BLOCK
     DM_AUDIO_CODEC_FRAMES_PER_BLOCK
     DM_AUDIO_CODEC_FILTER_DELAY
     DM_FS1016_POSTFILTERING_FLAG
     DM_FS1016_HIGHPASS_FLAG


     The value for DM_AUDIO_BITRATE can be

     DM_FS1016_4800_BITS
     DM_FS1016_7200_BITS
     DM_FS1016_9600_BITS


     The value for DM_FS1016_POSTFILTERING_FLAG can be

     DM_FS1016_POSTFILTERING_YES
     DM_FS1016_POSTFILTERING_NO
     The value for DM_FS1016_HIGHPASS_FLAG can be

     DM_FS1016_HIGHPASS_YES
     DM_FS1016_HIGHPASS_NO


     The above values select a decoder with desired bitrate and with or
     without postfiltering and highpass filtering.  Cautious application of
     postfiltering at the decoder's output is recommended.  The human ear's
     masking properties are exploited to trade off speech distortion vs.
     quantizing noise.  In tandem coding scenarios, only one stage of
     postfiltering is recommended and multiple stages should be avoided.  The
     bitrate and decode mode are set by a call to
     dmFS1016DecoderSetParams(3dm). Without calling
     dmFS1016DecoderSetParams(3dm), decoder sets defaults to 4800 bits/s,
     DM_FS1016_POSTFILTERING_YES, and DM_FS1016_HIGHPASS_NO.



NOTE
SEE ALSO
     dmFS1016DecoderCreate(3dm), dmFS1016Decode(3dm),
     dmFS1016DecoderSetParams(3dm).