dmDVAudioEncoderGetParams(3dm)dmDVAudioEncoderGetParams(3dm)NAMEdmDVAudioEncoderGetParams - get DV audio encoder parameter values
SYNOPSIS
#include <dmedia/dm_audioutil.h>
#include <dmedia/dm_audio.h>
#include <dmedia/dm_params.h>
DMstatus dmDVAudioEncoderGetParams(DMDVaudioencoder handle,
DMparams *params)
PARAMETER
handle DMDVaudioencoder structure, created by
dmDVAudioEncoderCreate(3dm).
params parameters returned from query
RETURNED VALUE
Returns DM_SUCCESS or DM_FAILURE.
DESCRIPTIONdmDVAudioEncoderGetParams(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:
DM_DVAUDIO_FORMAT - either DM_DVAUDIO_NTSC or DM_DVAUDIO_PAL
DM_DVAUDIO_TYPE - either DM_DVAUDIO_DV or DM_DVAUDIO_DVCPRO
DM_AUDIO_CODEC_MAX_BYTES_PER_BLOCK - either 120000 for NTSC or 144000 for
PAL
DM_AUDIO_CHANNELS - number of channels of audio (1 or 2 or 4)
DM_AUDIO_WIDTH - will always be 16
DM_DVAUDIO_CHANNEL_MODE - either DM_DVAUDIO_SD_2CH or DM_DVAUDIO_SD_4CH
DM_DVAUDIO_CHANNEL_POLICY - integer 1-19, described in dm_audioutil.h,
which specify exactly how the audio is layed out inside the DIF frame.
DM_MEDIUM - will always be DM_AUDIO
DM_AUDIO_BYTE_ORDER - will always be DM_AUDIO_BIG_ENDIAN
DM_AUDIO_FORMAT - will always be DM_AUDIO_TWOS_COMPLEMENT
DM_AUDIO_RATE - the sample rate in floating point (ex: 48000.0)
DM_AUDIO_CODEC_FRAMES_PER_BLOCK - the maximum number of samples this DIF
frame could possibly contain
DM_DVAUDIO_MIN_FRAMES_PER_BLOCK - the miniumum number of frames this DIF
frame could possibly contain
DM_AUDIO_CODEC_FILTER_DELAY - always zero
DM_DVAUDIO_LOCK_MODE - 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 ALSOdmDVAudioEncoderCreate(3dm), dmDVAudioEncoderSetParams(3dm),
dmDVAudioEncode(3dm).
Page 2
