Copyright © 2005-2018 MultiMedia Soft

Effects.SoundDirectionSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets the sound's playback direction. This method doesn't have any effect if reversed sound management has not been enabled by a previously call to the SoundDirectionEnable method.

The current playback direction can be obtained through the SoundDirectionGet method.

It's important to note that calling one of the following methods will force the setting of the forward direction of the playing sound: StopSound, RewindSound and ForwardSound.

 

See the How to apply special effects to a playing sound section for further details.

 

 

Syntax

 

[Visual Basic]

Public Function SoundDirectionSet (

nPlayerIndex as Int16,

nDirection as Int16

) as enumErrorCodes


 

[C#]

public enumErrorCodes SoundDirectionSet (

Int16 nPlayerIndex,

Int16 nDirection

);


 

[C++]

public: enumErrorCodes SoundDirectionSet (

Int16 nPlayerIndex,

Int16 nDirection

);


 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

nDirection

he current playback direction.

Supported values are the following:

Mnemonic constant

Value

Meaning

DIRECTION_FORWARD

0

Sound is played in normal forward direction

DIRECTION_REVERSE

1

Sound is played in reverse direction

 

 

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.