IG_mult_audio_format

IG_mult_audio_format_get

In This Topic

This function retrieves the format of the audio in a multimedia instance.

Declaration:

	Copy Code
AT_ERRCOUNT ACCUAPI IG_mult_audio_format_get( HIGMULT hMult, LPAT_UINT lpSampleRate, LPAT_UINT lpBitsPerSample, LPAT_UINT lpChannels );

Arguments:

Name	Type	Description
hMult	HIGMULT	Multimedia instance handle.
lpSampleRate	LPAT_UINT	Number of samples per second.
lpBitsPerSample	LPAT_UINT	Number of bits per sample.
lpChannels	LPAT_UINT	Number of channels (1 = mono, 2 = stereo).

Return Value:

Returns the number of ImageGear errors that occurred during this function call. If there are no errors, the return value is IGE_SUCCESS.

Supported Raster Image Formats:

This function does not process image pixels.

Sample:

Media Player

Example:

	Copy Code
AT_ERRCOUNT nErrcount; /* Number of errors on stack / HIGMULT hMult; / Multimedia instance handle / AT_UINT nSampleRate; / Sample rate of audio / AT_UINT nBitsPerSample; / Bits per sample / AT_UINT nChannels; / Number of channels */ nErrcount = IG_mult_audio_format_get(hMult, &nSampleRate, &nBitsPerSample, &nChannels);

Copy Code

AT_ERRCOUNT nErrcount;  /* Number of errors on stack */
HIGMULT hMult;          /* Multimedia instance handle */
AT_UINT nSampleRate;    /* Sample rate of audio */
AT_UINT nBitsPerSample; /* Bits per sample */
AT_UINT nChannels;      /* Number of channels */
nErrcount = IG_mult_audio_format_get(hMult, &nSampleRate, &nBitsPerSample, &nChannels);

Remarks:

Note that audio retrieved using IG_mult_audio_get() is always in uncompressed PCM format. If the multimedia instance does not contain audio, an error will occur.

Get Product Support