LDicomWaveformGroup::LoadAudio

Show in webframe

#include "Ltdic.h"

L_UINT16 LDicomWaveformGroup::LoadAudio(pszFilename, uFlags = 0)

L_TCHAR* pszFilename;	/* file name */
L_UINT16 uFlags;	/* reserved for future use */

Inserts an audio (wave) file into the waveform group.

Parameter	Description
pszFilename	Name of the audio file to load.
uFlags	Reserved for future use. Pass 0.

Returns

0	The function was successful.
> 0	An error occurred. Refer to Return Codes.

Comments

This function is mainly intended to be used with 8-bit (mono and stereo) PCM, mu-Law and a-Law wave files. It can also be used with 16-bit (mono and stereo) PCM wave files, but in this case it will automatically convert them to 8-bit. Please note that this is a limitation in the DICOM standard and not in the function itself.

This function fails and returns DICOM_ERROR_FORMAT if the format of the input wave file is not PCM, mu-Law or a-Law.

This function is very useful when creating DICOM objects of type "Basic Voice Audio" (1.2.840.10008.5.1.4.1.1.9.4.1), which is typically used for report dictation. Two of the main constraints of this IOD are the sampling frequency, which should be 8000; and sample interpretation, which should be unsigned 8-bit linear, 8-bit mu-law or 8-bit A-law. For more information about this object, refer to "Basic Voice Audio Information Object Definition" and "Basic Voice Audio IOD Content Constraints" in the DICOM standard.

Required DLLs and Libraries

LTDIC

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application

Platforms

Win32, x64

See Also

Functions:	Class Members, LDicomWaveformGroup::SaveAudio
Topics:	Working with DICOM Waveforms

Example

This sample shows how to insert a wave stream into a dataset.

L_INT LDicomWaveformGroup_LoadAudioExample(LDicomDS &InputDS, L_TCHAR * pszInputWaveFileName) 
{
   L_INT                nRet;
   LDicomWaveformGroup  AudioWaveformGroup; 
         
   // Load an audio file into the waveform group. 
   nRet = AudioWaveformGroup.LoadAudio(pszInputWaveFileName,0);
   if(nRet != DICOM_SUCCESS)
      return nRet;
   // Insert the waveform group into the dataset
   nRet = InputDS.AddWaveformGroup(&AudioWaveformGroup, 0,ELEMENT_INDEX_MAX);
   if(nRet != DICOM_SUCCESS)
      return nRet;
   return DICOM_SUCCESS; 
}