Classes > SoundComposerMan class > 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 SoundComposerMan class and the How to compose a sound tutorial.

Syntax

[Visual Basic]

Public Function ItemSoundFileDownmixToMonoGet (

nUniqueId as Int32,

ByRef bDownMixToMono as Boolean

) as enumErrorCodes

[C#]

public enumErrorCodes ItemSoundFileDownmixToMonoGet (

Int32 nUniqueId,

ref bool bDownMixToMono

);

[C++]

public: enumErrorCodes ItemSoundFileDownmixToMonoGet (

Int32 nUniqueId,

bool __gc *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
false	Keep stereo channels separated
true	Downmix stereo channels to mono

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumErrorCodes.NOERROR (0)	The method call was successful.