Remarks
Enables/disables the given cue point. You can know the status of a cue point by calling the CuePointsIsEnabled method.
See the How to add Triggers and Cue Points to a player section for further details about cue points.
Syntax
[Visual Basic]
control.CuePointsEnable (
nPlayer as Integer,
strCuePointName as String,
bEnable as enumBoolean
) as enumErrorCodes
|
|
[C++]
short control.CuePointsEnable (
short nPlayer,
LPCTSTR strCuePointName,
short bEnable
);
|
|
Parameter
|
Description
|
|
|
nPlayer
|
Number representing the zero-based index of the involved player
|
strCuePointName
|
String containing the unique name of the cue point as defined when the cue point was added through the CuePointsAdd method.
|
bEnable
|
Boolean value that specifies if the cue point must be enabled or disabled.
Supported values are the following:
Mnemonic constant
|
Value
|
Meaning
|
BOOL_FALSE
|
0
|
Disable cue point
|
BOOL_TRUE (default)
|
1
|
Enable cue point
|
|
Return value
Value
|
Meaning
|
|
|
Negative value
|
An error occurred (see the LastError property for further error details)
|
enumErrorCodes.ERR_NOERROR (0)
|
The method call was successful.
|
|
