Copyright © 2005-2016 MultiMedia Soft

Effects.CompressorIsApplied method

Previous pageReturn to chapter overviewNext page

Remarks

 

Verifies if the compressor effect has been applied to the given player through the Effects.CompressorApply method.

 

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

 

 

Syntax

 

[Visual Basic]

Public CompressorIsApplied (

nPlayerIndex as integer,

ByRef bApplied as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes CompressorIsApplied (

short nPlayerIndex,

ref bool bApplied

);


 

[C++]

public: enumErrorCodes CompressorIsApplied (

short nPlayerIndex,

bool __gc *bApplied

);


 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

bApplied

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

Supported values are the following:

Mnemonic constant

Meaning

false

The effect has not been applied

true

The effect has been applied

 

 

Return value

 

Value

Meaning

 

 

false

The given effect has not been applied

true

The given effect has been applied