PlayListItemVolAutomPointRemove method |
|
Remarks
Removes a volume point from an item of the playlist. The volume point can have been previously added through the PlayListItemVolAutomPointAdd method or as a result of a playlist loading through the PlayListLoad method.
This method will return an error if the playlist has not been created with the PlayListCreateEx method or loaded with the PlayListLoad or PlayListLoadSync methods, all having the nMode parameter set to PLAYLIST_AUTOMATION_MODE.
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 PlayListItemVolAutomPointRemove ( nPlayerIndex as Int16, nItemIndex as Int16, strVolumePointName as String ) as enumErrorCodes |
[C#] public enumErrorCodes PlayListItemVolAutomPointRemove ( Int16 nPlayerIndex, Int16 nItemIndex, string strVolumePointName ); |
[C++] public: enumErrorCodes PlayListItemVolAutomPointRemove ( Int16 nPlayerIndex, Int16 nItemIndex, string strVolumePointName ); |
Parameter |
Description |
|
|
nPlayer |
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 remove. |
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. |