COM Objects > SoundComposer object > Methods > SoundComposer.ItemSoundFileDownmixToMonoGet method

Remarks

Verifies if downmix will occur in order to store a stereo sound file into a mono channel of the stream. This setting can be modified through the SoundComposer.ItemSoundFileDownmixToMonoSet method.

For further details about sound composing see the the SoundComposer object and the How to compose a sound tutorial.

Syntax

[Visual Basic]

control.SoundComposer.ItemSoundFileDownmixToMonoGet (

nUniqueId as Long,

ByRef bDownMixToMono as enumBoolean

) as enumErrorCodes

[C++]

short control.SoundComposer.ItemSoundFileDownmixToMonoGet (

long nUniqueId,

short *bDownMixToMono

);

Parameter

Description

nUniqueId

The unique identifier of the sound file item previously returned by the call to one of the following methods: SoundComposer.ItemSoundFileAdd, SoundComposer.ItemSoundFileMemoryAdd, SoundComposer.ItemSoundFileRawAdd, SoundComposer.ItemSoundFileMemoryRawAdd, SoundComposer.ItemSoundFileFromEditorAdd,or SoundComposer.ItemSoundFileFromRecorderAdd.

bDownMixToMono

Reference that, on return from the method call, will contain the boolean flag specifying if there is the need of a downmix in order to store a stereo sound file into a mono channel of the stream.

Supported values are the following:

Mnemonic Value	Meaning
BOOL_FALSE	Keep stereo channels separated
BOOL_TRUE	Downmix stereo channels to mono

Return value

Value	Meaning

Negative value	An error occurred, check the LastError property value in order to get the error code
enumErrorCodes.ERR_NOERROR (0)	The method call was successful