dmDVAudioEncoderSetParams(3dm)

NAME
     dmDVAudioEncoderSetParams - set DV Audio encoder parameter values


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

     DMstatus dmDVAudioEncoderSetParams(DMDVaudioencoder handle,
                                   DMparams *params)


PARAMETER
     handle   DMDVaudioencoder structure, created by
              dmDVAudioEncoderCreate(3dm).


     params   list of parameters to configure the audio encoder.  Null (0)
              value ok.


RETURNED VALUE
     Returns DM_SUCCESS or DM_FAILURE.


DESCRIPTION
     dmDVAudioEncoderSetParams(3dm) sets state of the DV audio encoder to the
     values specified in params.  Unrecognized parameters are ignored.


     The parameters that params can have specified are defined in
     dmedia/dm_audioutil.h:

     DM_DVAUDIO_FORMAT - required, either DM_DVAUDIO_NTSC or DM_DVAUDIO_PAL
     DM_DVAUDIO_TYPE - not required, either DM_DVAUDIO_DV or
     DM_DVAUDIO_DVCPRO, defaults to DM_DVAUDIO_DV
     DM_AUDIO_CHANNELS - required, number of channels of audio (1 or 2) If
     f3DM_DVAUDIO_TYPE is DM_DVAUDIO_DVCPRO, this must be 2.
     DM_AUDIO_WIDTH - should always be 16
     DM_MEDIUM - should always be DM_AUDIO
     DM_AUDIO_RATE - required, the sample rate in floating point (ex: 48000.0)
     If the DM_DVAUDIO_TYPE is DM_DVAUDIO_DVCPRO, only 48 kHz is supported.
     If the DM_DVAUDIO_TYPE is DM_DVAUDIO_DV, both 32 kHz and 48 kHz are
     supported.
     DM_DVAUDIO_LOCK_MODE - not required, non-zero if audio is locked
     according to the DV audio specification.  Zero if it is not locked.
     Defaults to locked audio.
SEE ALSO
     dmDVAudioEncoderCreate(3dm), dmDVAudioEncode(3dm),
     dmDVAudioEncoderGetParams(3dm).