PlayListItemVolAutomPointParamsGet method |
|
Remarks
Obtains parameters of an existing volume point of a playlist's item. The volume point can have been previously added through the PlayListItemVolAutomPointAdd method or as a result of a playlist loading through the PlayListLoad method.
For further details about playlists management see the How to create and manage a playlist tutorial.
For details about using Volume Automation refer to the How to manage Volume Automation tutorial.
Syntax
[Visual Basic] Public Function PlayListItemVolAutomPointParamsGet ( nPlayerIndex as Int16, nItemIndex as Int16, strVolumePointName as String, nPositionUnit as enumVolumeAutomationPosUnits, ByRef fPosition as Single, nVolumeScaleType as enumVolumeScales, ByRef fVolumeLevel as Single, ByRef nCurveType as enumVolumeCurves, ByRef nLeftX as Int16, ByRef nLeftY as Int16, ByRef nRightX as Int16, ByRef nRightY as Int16 ) as enumErrorCodes |
[C#] public enumErrorCodes PlayListItemVolAutomPointParamsGet ( Int16 nPlayerIndex, Int16 nItemIndex, string strVolumePointName, enumVolumeAutomationPosUnits nPositionUnit, float fPosition, enumVolumeScales nVolumeScaleType, float fVolumeLevel, enumVolumeCurves nCurveType, ref Int16 nLeftX, ref Int16 nLeftY, ref Int16 nRightX, ref Int16 nRightY ); |
[C++] public: enumErrorCodes PlayListItemVolAutomPointParamsGet ( Int16 nPlayerIndex, Int16 nItemIndex, string strVolumePointName, enumVolumeAutomationPosUnits nPositionUnit, float fPosition, enumVolumeScales nVolumeScaleType, float fVolumeLevel, enumVolumeCurves nCurveType, Int16 __gc *nLeftX, Int16 __gc *nLeftY, Int16 __gc *nRightX, Int16 __gc *nRightY ); |
Parameter |
Description |
|||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||
nPlayerIndex |
Number representing the zero-based index of the involved player |
|||||||||||||||||||||||||||
nItemIndex |
Number representing the zero-based index of the item inside the playlist. The number of available items can be obtained using the PlayListGetCount method. |
|||||||||||||||||||||||||||
strVolumePointName |
String representing the friendly name of the volume point to modify |
|||||||||||||||||||||||||||
nPositionUnit |
The unit used to define positions of volume points. Supported values are the following:
|
|||||||||||||||||||||||||||
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 nPositionUnit parameter. |
|||||||||||||||||||||||||||
nVolumeScaleType |
The volume scaling type. Supported values are the following:
|
|||||||||||||||||||||||||||
fVolumeLevel |
Reference that, on return from the method call, will contain the volume level expressed in the same unit set into the nVolumeScaleType parameter. |
|||||||||||||||||||||||||||
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:
|
|||||||||||||||||||||||||||
nLeftX |
Reference that, on return from the method call, will contain the horizontal position, expressed in percentage of the designer's area, of the left control point. This parameter can be ignored when the nCurveType parameter above is set to a value different from VOLUME_CURVE_CUSTOM. |
|||||||||||||||||||||||||||
nLeftY |
Reference that, on return from the method call, will contain the vertical position, expressed in percentage of the designer's area, of the left control point. This parameter can be ignored when the nCurveType parameter above is set to a value different from VOLUME_CURVE_CUSTOM. |
|||||||||||||||||||||||||||
nRightX |
Reference that, on return from the method call, will contain the horizontal position, expressed in percentage of the designer's area, of the right control point. This parameter can be ignored when the nCurveType parameter above is set to a value different from VOLUME_CURVE_CUSTOM. |
|||||||||||||||||||||||||||
nRightY |
Reference that, on return from the method call, will contain the vertical position, expressed in percentage of the designer's area, of the right control point This parameter can be ignored when the nCurveType parameter above is set to a value different from VOLUME_CURVE_CUSTOM. |
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. |