Skip to content

class BinkPlayer (client-side)

Available since version: 0.3.4

Note

If you want to define your own shape (populate vertices manually), use 1st constructor.
To create a Sprite with default fixed rectangular shape (4 vertices) use 2nd constructor.

This class represents 2d video player visible on the screen.

Constructor

BinkPlayer(string txt)

Parameters:

  • string txt: the texture file to display.

Constructor

BinkPlayer(int x, int y, int width, int height, string txt)

Parameters:

  • int x: the x position in virtuals.
  • int y: the y position in virtuals.
  • int width: the width size in virtuals.
  • int height: the height size in virtuals.
  • string txt: the texture file to display.

Properties

bool loop

Represents true if video should be played from the start if it finishes, otherwise false.


bool paused

Represents true if video playback is currently paused, otherwise false.


bool alphaSupported (read-only)

Represents true if video supports alpha channel, otherwise false.


float volume

Represents the current video volume.


float duration (read-only)

Represents the total video duration in seconds.


float remainingTime (read-only)

Represents the remaining video time in seconds.


float currentTime

Represents the current video time in seconds.


Methods

play

This method plays the video.

void play()

stop

This method stops the video.

void stop()

Callbacks

No callbacks.