Copyright © 2005-2018 MultiMedia Soft

Effects.PreAmplifierIsEnabled method

Previous pageReturn to chapter overviewNext page

Remarks

 

Verifies if the preamplifier has been enabled on the given player through the Effects.PreAmplifierEnable method.

 

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

 

Syntax

 

[Visual Basic]

Public Function PreAmplifierIsEnabled (

nPlayerIndex as Int16,

ByRef bEnabled as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes PreAmplifierIsEnabled (

Int16 nPlayerInde,

ref bool bEnabled

);


 

[C++]

public: enumErrorCodes PreAmplifierIsEnabled (

Int16 nPlayerInde,

bool __gc *bEnabled

);


 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

bEnabled

Reference that, on return from the method call, will contain the boolean value specifying if preamplifier is currently enabled.

Supported values are the following:

Mnemonic constant

Meaning

false (default)

Preamplifier is not enabled

true

Preamplifier is enabled

 

 

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.