|
PlayListItemVolAutomPointModify method |
  
|
|
PlayListItemVolAutomPointModify method |
|
Remarks
Modifies 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 PlayListItemVolAutomPointModify ( nPlayerIndex as Int16, nItemIndex as Int16, strVolumePointName as String, nPositionUnit as enumVolumeAutomationPosUnits, fPosition as Single, nVolumeScaleType as enumVolumeScales, fVolumeLevel as Single, nCurveType as enumVolumeCurves, nDesignerUniqueId as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes PlayListItemVolAutomPointModify ( Int16 nPlayerIndex, Int16 nItemIndex, string strVolumePointName, enumVolumeAutomationPosUnits nPositionUnit, float fPosition, enumVolumeScales nVolumeScaleType, float fVolumeLevel, enumVolumeCurves nCurveType, Int32 nDesignerUniqueId ); |
[C++] public: enumErrorCodes PlayListItemVolAutomPointModify ( Int16 nPlayerIndex, Int16 nItemIndex, string strVolumePointName, enumVolumeAutomationPosUnits nPositionUnit, float fPosition, enumVolumeScales nVolumeScaleType, float fVolumeLevel, enumVolumeCurves nCurveType, Int32 nDesignerUniqueId ); |
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 |
Position of the volume point expressed in the same unit set into the nPositionUnit parameter. Set this parameter to -1 if you need to leave the current position value unchanged. |
|||||||||||||||||||||||||||
nVolumeScaleType |
The volume scaling type. Supported values are the following:
|
|||||||||||||||||||||||||||
fVolumeLevel |
Volume level expressed in the same unit set into the nVolumeScaleType parameter. Set this parameter to -1 if you need to leave the current volume level unchanged. |
|||||||||||||||||||||||||||
nCurveType |
Type of curve applied to reach the next volume point. Set this parameter to -1 if you need to leave the current curve type unchanged. Supported values are the following:
|
|||||||||||||||||||||||||||
nDesignerUniqueId |
Unique identifier of the curve editor control containing custom curve settings to apply. This unique identifier is returned by a previous call to the VolumeAutomation.CurveDesigner.Create method.
The custom curve designer manages a windowed control, whose visual aspect can be defined programmatically, which allows designing volume curves based upon Bézier curves whose shape is defined through the manual positioning of 2 control points (displayed in cyan color on the graphic below). For further information about the use of the embedded CurveDesigner refer to the tutorial How to create custom volume curves.
|
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. |
