Copyright © 2001-2018 MultiMedia Soft

Effects.SoundDirectionGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the current sound's playback direction. The playback direction can be modified through the Effects.SoundDirectionSet method.

 

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

 

 

Syntax

 

[Visual Basic]

control.Effects.SoundDirectionGet (

nPlayer as Integer,

nDirection as enumSoundDirections

) as enumSoundDirections


 

[C++]

short control.Effects.SoundDirectionGet (

short nPlayer,

long *nDirection

);


 

 

Parameter

Description

 

 

nPlayer

Number representing the zero-based index of the involved player

nDirection

Reference that, on return from the method call, will contain the 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.ERR_NOERROR (0)

The call was successful.