love.graphics.newVideo

Available since LÖVE 0.10.0
This function is not supported in earlier versions.

Creates a new drawable Video. Currently only Ogg Theora video files are supported.

This function can be slow if it is called repeatedly, such as from love.update or love.draw. If you need to use a specific resource often, create it once and store it somewhere it can be reused!

Function

Synopsis

video = love.graphics.newVideo( filename )

Arguments

string filename
The file path to the Ogg Theora video file.

Returns

Video video
A new Video.

Function

Synopsis

video = love.graphics.newVideo( videostream )

Arguments

VideoStream videostream
A video stream object.

Returns

Video video
A new Video.

Function

Available since LÖVE 11.0
This variant is not supported in earlier versions.

Synopsis

video = love.graphics.newVideo( filename, settings )

Arguments

string filename
The file path to the Ogg Theora video file (or VideoStream).
table settings
A table containing the following fields:
boolean audio (false)
Whether to try to load the video's audio into an audio Source. If not explicitly set to true or false, it will try without causing an error if the video has no audio.
number dpiscale (love.graphics.getDPIScale())
The DPI scale factor of the video.

Returns

Video video
A new Video.

Function

Available since LÖVE 0.10.0 and removed in LÖVE 11.0
This variant is not supported in earlier or later versions.

Synopsis

video = love.graphics.newVideo( filename, loadaudio )

Arguments

string filename
The file path to the Ogg Theora video file.
boolean loadaudio (nil)
Whether to try to load the video's audio into an audio Source. If not explicitly set to true or false, it will try without causing an error if the video has no audio.

Returns

Video video
A new Video.

Function

Available since LÖVE 0.10.0 and removed in LÖVE 11.0
This variant is not supported in earlier or later versions.

Synopsis

video = love.graphics.newVideo( videostream, loadaudio )

Arguments

VideoStream videostream
A video stream object.
boolean loadaudio (nil)
Whether to try to load the video's audio into an audio Source. If not explicitly set to true or false, it will try without causing an error if the video has no audio.

Returns

Video video
A new Video.

Examples

Load and play a video. 

function love.load()
    video = love.graphics.newVideo("myvideo.ogv")
    video:play()
end
 
function love.draw()
    love.graphics.draw(video, 0, 0)
end

See Also


© 2006–2020 LÖVE Development Team
Licensed under the GNU Free Documentation License, Version 1.3.
https://love2d.org/wiki/love.graphics.newVideo