BB FlashBack SDK: FBPlayer

SetUserPause

Description

Sets a custom pause using the provided pause identification number at the requested frame number.

Syntax

[C#/C++]
public void SetUserPause(long frameNum, long pauseID)

[VB.NET]
Public Overridable Sub SetUserPause(ByVal FrameNum As Integer, ByVal PauseID As Integer)

Parameters

Parameter Description
FrameNum Required. An integer value indicating the frame number that will contain the custom pause.
PauseID Required. An integer value providing the pause identification number for the custom pause.

Remarks

Custom pauses are very useful in enabling sophisticated navigation of movies. Below are some example applications of custom pauses:

  • Set a custom pause at the last frame of a movie to be notified that playing is complete.

  • To play a movie between two particular frames, set a custom pause at the ending frame, and when this pause is reached, seek to the starting frame.

Set custom pauses using the SetUserPause method and monitor the OnPause event for notification that it has been reached during playback.

See Also

RemoveUserPause  FrameWithUserPause  GetFrameUserPauseID  RemoveUserPauses