Copyright © 2005-2018 MultiMedia Soft

VolumeAutomation.PointEnable method

Previous pageReturn to chapter overviewNext page

Remarks

 

Enables/disables the given volume point. You can know if a volume point is enabled or disabled through the VolumeAutomation.PointIsEnabled method.

 

For details about using Volume Automation refer to the How to manage Volume Automation tutorial.

 

Syntax

 

[Visual Basic]

Public Function PointEnable (

nPlayerIndex as Int16,

strVolumePointName as String,

bEnable as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes PointEnable (

Int16 nPlayerIndex,

string strVolumePointName,

bool bEnable

);


 

[C++]

public: enumErrorCodes PointEnable (

Int16 nPlayerIndex,

string strVolumePointName,

bool bEnable

);


 

 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

strVolumePointName

String representing the friendly name of the volume point to enable/disable: this name must be identical to the corresponding one used for adding the volume point through the VolumeAutomation.PointAdd method..

bEnable

Boolean value that specifies if the volume point must be enabled or disabled.

Supported values are the following:

Mnemonic constant

Meaning

false

Disables the volume point

true

Enables the volume point

 

 

Return value

 

Value

Meaning

 

 

enumErrorCodes.NOERROR (0)

The method call was successful

Negative value

An error occurred: see the LastError property for further error details or for a list of the possible error values.