Remarks
Modifies the position of the play head line. The current position can be obtained through the TracksBoard.PlayHeadPositionGet method.
For details about the use of the TracksBoard refer to the How to use the TracksBoard to visually compose songs tutorial.
For further details about methods of the TracksBoard refer to the TracksBoard class section.
Syntax
[Visual Basic]
Public Function PlayHeadPositionGet (
bPlayHeadAvailable as Boolean,
nPosInMs as Int32
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes PlayHeadPositionGet (
bool bPlayHeadAvailable,
Int32 nPosInMs
);
|
|
[C++]
public: enumErrorCodes PlayHeadPositionGet (
bool bPlayHeadAvailable,
Int32 nPosInMs
);
|
|
Parameter
|
Description
|
|
|
bPlayHeadAvailable
|
Boolean value representing the flag for play head line availability.
Supported values are the following:
Value
|
Meaning
|
false
|
Hides the play head line. In this case the value passed to the nPosInMs parameter is ignored.
|
true
|
Displays the play head line at the position passed to the nPosInMs parameter
|
|
nPosInMs
|
The play head line position, expressed in milliseconds
|
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
|
|
