|
VolumeAutomation.PointIsEnabled method |
  
|
|
VolumeAutomation.PointIsEnabled method |
|
Remarks
Checks if a volume point is enabled or disabled. A volume point can be enabled or disabled through the VolumeAutomation.PointEnable method.
For details about using Volume Automation refer to the How to manage Volume Automation tutorial.
Syntax
[Visual Basic] Public Function PointIsEnabled ( nPlayerIndex as Int16, strVolumePointName as String ) as Boolean |
[C#] public bool PointIsEnabled ( Int16 nPlayerIndex, string strVolumePointName ); |
[C++] public: bool PointIsEnabled ( Int16 nPlayerIndex, string strVolumePointName ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the involved player |
strVolumePointName |
String representing the friendly name of the volume point of interest: this name must be identical to the corresponding one used for adding the volume point through the VolumeAutomation.PointAdd method.. |
Return value
Value |
Meaning |
|
|
false |
Volume point is disabled |
true |
Volume point is enabled |
