dmDVAudioEncoderGetParams(3dm)                  dmDVAudioEncoderGetParams(3dm)



NAME
     dmDVAudioEncoderGetParams - get DV audio encoder parameter values


SYNOPSIS
     #include <dmedia/dmaudioutil.h>
     #include <dmedia/dmaudio.h>
     #include <dmedia/dmparams.h>

     DMstatus dmDVAudioEncoderGetParams(DMDVaudioencoder handle,
                                   DMparams *params)


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


     params   parameters returned from query


RETURNED VALUE
     Returns DMSUCCESS or DMFAILURE.


DESCRIPTION
     dmDVAudioEncoderGetParams(3dm) returns the state of the DV audio encoder
     in params.


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

     DMDVAUDIOFORMAT - either DM_DVAUDIO_NTSC or DM_DVAUDIO_PAL
     DMDVAUDIOTYPE - either DM_DVAUDIO_DV or DM_DVAUDIO_DVCPRO
     DMAUDIOCODECMAXBYTESPERBLOCK - either 120000 for NTSC or 144000 for
     PAL
     DMAUDIOCHANNELS - number of channels of audio (1 or 2 or 4)
     DMAUDIOWIDTH - will always be 16
     DMDVAUDIOCHANNELMODE - either DM_DVAUDIO_SD_2CH or DM_DVAUDIO_SD_4CH
     DMDVAUDIOCHANNELPOLICY - integer 1-19, described in dm_audioutil.h,
     which specify exactly how the audio is layed out inside the DIF frame.
     DMMEDIUM - will always be DM_AUDIO
     DMAUDIOBYTEORDER - will always be DM_AUDIO_BIG_ENDIAN
     DMAUDIOFORMAT - will always be DM_AUDIO_TWOS_COMPLEMENT
     DMAUDIORATE - the sample rate in floating point (ex: 48000.0)
     DMAUDIOCODECFRAMESPERBLOCK - the maximum number of samples this DIF
     frame could possibly contain
     DMDVAUDIOMINFRAMESPERBLOCK - the miniumum number of frames this DIF
     frame could possibly contain
     DMAUDIOCODECFILTERDELAY - always zero
     DMDVAUDIOLOCKMODE - non-zero if audio is locked according to the DV



                                                                        Page 1

dmDVAudioEncoderGetParams(3dm)                  dmDVAudioEncoderGetParams(3dm)



     audio specification.  Zero if it is not locked.


SEE ALSO
     dmDVAudioEncoderCreate(3dm), dmDVAudioEncoderSetParams(3dm),
     dmDVAudioEncode(3dm).

















































                                                                        Page 2