|
PlayListItemCuePointRemove method |
![]() ![]()
|
Remarks
Removes a cue point from an item of the playlist.
This method will return an error if the playlist has not been created with the PlayListCreate method or loaded with the PlayListLoad or PlayListLoadSync methods 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.
For further details about cue points see the How to add Triggers and Cue Points to a player tutorial.
Syntax
[Visual Basic] Public Function PlayListItemCuePointRemove ( nPlayerIndex as Int16, nItem as Int16, strCuePointName as string ) as enumErrorCodes |
[C#] public enumErrorCodes PlayListItemCuePointRemove ( Int16 nPlayerIndex, Int16 nItem, string strCuePointName ); |
[C++] public: enumErrorCodes PlayListItemCuePointRemove ( Int16 nPlayerIndex, Int16 nItem, string strCuePointName ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the involved player |
nItem |
Number representing the zero-based index of the item inside the playlist |
strCuePointName |
String containing the unique name that identifies the cue point: this name must be identical to the one used when the cue point was created through the PlayListItemCuePointAdd method. |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred (see the LastError property for further error details) |
enumErrorCodes.NOERROR (0) |
The method call was successful. |