BB FlashBack SDK: FBPlayer

GetMarkerInfoFromList

Description

Returns info on a marker, given its index in the markers list previously created by CreateMarkersList.

Syntax

[C#/C++]
public void GetMarkerInfoFromList (long index, long *id, long *frame, BSTR* text, Bool* result);

[VB.NET]
Public Sub GetMarkerInfoFromList (ByVal index As Integer, ByRef id As Integer, ByRef frame As Integer, ByRef text As String, ByRef result As Boolean)

Parameters

index (in) : index of the marker in the list.

id (out) : id of the marker.

frame (out) : frame that the marker is in.

text (out) : text label of the marker

result (out) : set to True if successful, False if not.

Remarks

CreateMarkersList must be called before GetMarkerInfoFromList.

The markers list should be freed up with FreeMarkersList after use.

Using CreateMarkersList to create a markers list and GetMarkersCountInList and GetMarkerInfoFromList to get marker info instead of MarkersCount and GetMarkerID/Text has performance benefits when the movie contains a large number of markers.

See Also

FBPlayer::CreateMarkersList  FBPlayer::GetMarkersCountInList  FBPlayer::FreeMarkersList