VolumeAutomation.PointGetParams method |
|
Remarks
Obtains parameters for the given volume point.
For details about using Volume Automation refer to the How to manage Volume Automation tutorial.
Syntax
[Visual Basic] Public Function PointGetParams ( nPlayerIndex as Int16, strVolumePointName as String, Byref fPosition as Single, Byref fVolumeLevel as Single, Byref nCurveType as enumVolumeCurves ) as enumErrorCodes |
[C#] public enumErrorCodes PointGetParams ( Int16 nPlayerIndex, string strVolumePointName, ref float fPosition, ref float fVolumeLevel, ref enumVolumeCurves nCurveType ); |
[C++] public: enumErrorCodes PointGetParams ( Int16 nPlayerIndex, string strVolumePointName, float __gc *fPosition, float __gc *fVolumeLevel, enumVolumeCurves __gc *nCurveType ); |
Parameter |
Description |
||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
nPlayerIndex |
Number representing the zero-based index of the involved player |
||||||||||||||||||||||||
strVolumePointName |
String representing the friendly name of the volume point to remove: this name must be identical to the corresponding one used for adding the volume point through the VolumeAutomation.PointAdd method. |
||||||||||||||||||||||||
fPosition |
Reference that, on return from the method call, will contain the position of the volume point expressed in the same unit set into the VolumeAutomation.PositionUnit property |
||||||||||||||||||||||||
fVolumeLevel |
Reference that, on return from the method call, will contain the volume level expressed in the same unit set into the VolumeAutomation.ScaleType property |
||||||||||||||||||||||||
nCurveType |
Reference that, on return from the method call, will contain the type of curve applied to reach the next volume point. Supported values are the following:
|
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. |