Remarks
Retrieves the position of the play head line. The current position can be modified through the TracksBoard.PlayHeadPositionSet 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 (
ByRef bPlayHeadAvailable as Boolean,
ByRef nPosInMs as Int32
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes PlayHeadPositionGet (
ref bool bPlayHeadAvailable,
ref Int32 nPosInMs
);
|
|
[C++]
public: enumErrorCodes PlayHeadPositionGet (
bool __gc *bPlayHeadAvailable,
Int32 __gc *nPosInMs
);
|
|
Parameter
|
Description
|
|
|
bPlayHeadAvailable
|
Reference that, after returning from the method call, will contain the flag for play head line availability.
Supported values are the following:
Value
|
Meaning
|
false
|
Play head line is currently unavailable
|
true
|
Play head line is currently available and its position is stored inside the nPosInMs parameter
|
|
nPosInMs
|
Reference that, after returning from the method call, will contain 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
|
|
