VideoStream

Description:

  An object which decodes, streams, and controls Videos.

release

Type: Function.

Description:

  Destroys the object's Lua reference. The object will be completely deleted if it's not referenced by any other LÖVE object or thread. This method can be used to immediately clean up resources without waiting for Lua's garbage collector.

Signature:

release: function(self: VideoStream): boolean

Returns:

Return Type	Description
boolean	True if the object was released by this call, false if it had been previously released.

type

Type: Function.

Description:

  Gets the type of the object as a string.

Signature:

type: function(self: VideoStream): string

Returns:

Return Type	Description
string	The type as a string.

Of

Type: Function.

Description:

  Checks whether an object is of a certain type. If the object has the type with the specified name in its hierarchy, this function will return true.

Signature:

typeOf: function(self: VideoStream, type_name: string): boolean

Parameters:

Parameter	Type	Description
type_name	string	The name of the type to check for.

Returns:

Return Type	Description
boolean	True if the object is of the specified type, false otherwise.

play

Type: Function.

Description:

  Plays the VideoStream.

Signature:

play: function(self: VideoStream)

pause

Type: Function.

Description:

  Pauses the VideoStream.

Signature:

pause: function(self: VideoStream)

seek

Type: Function.

Description:

  Sets the current playback position of the VideoStream.

Signature:

seek: function(self: VideoStream, seconds: number)

Parameters:

Parameter	Type	Description
seconds	number	The time in seconds since the beginning of the VideoStream.

rewind

Type: Function.

Description:

  Rewinds the VideoStream. Synonym to VideoStream:seek(0).

Signature:

rewind: function(self: VideoStream)

tell

Type: Function.

Description:

  Gets the current playback position of the VideoStream.

Signature:

tell: function(self: VideoStream): number

Returns:

Return Type	Description
number	The number of seconds sionce the beginning of the VideoStream.

isPlaying

Type: Function.

Description:

  Gets whether the VideoStream is playing.

Signature:

isPlaying: function(self: VideoStream): boolean

Returns:

Return Type	Description
boolean	Whether the VideoStream is playing.

getFilename

Type: Function.

Description:

  Gets the filename of the VideoStream.

Signature:

getFilename: function(self: VideoStream): string
	setSync: function(self: VideoStream, source?: Source)

Parameters:

Parameter	Type	Description
source	Source	The source parameter.

Returns:

Return Type	Description
string	The filename of the VideoStream