summaryrefslogtreecommitdiff
path: root/meta/3rd/love2d/library/love/video.lua
blob: 2a93dd227e2cd2a6be9b96a69479595e3e0f855b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
---@meta

---
---This module is responsible for decoding, controlling, and streaming video files.
---
---It can't draw the videos, see love.graphics.newVideo and Video objects for that.
---
---@class love.video
love.video = {}

---
---Creates a new VideoStream. Currently only Ogg Theora video files are supported. VideoStreams can't draw videos, see love.graphics.newVideo for that.
---
---@overload fun(file: love.File):love.VideoStream
---@param filename string # The file path to the Ogg Theora video file.
---@return love.VideoStream videostream # A new VideoStream.
function love.video.newVideoStream(filename) end

---
---An object which decodes, streams, and controls Videos.
---
---@class love.VideoStream: love.Object
local VideoStream = {}

---
---Gets the filename of the VideoStream.
---
---@return string filename # The filename of the VideoStream
function VideoStream:getFilename() end

---
---Gets whether the VideoStream is playing.
---
---@return boolean playing # Whether the VideoStream is playing.
function VideoStream:isPlaying() end

---
---Pauses the VideoStream.
---
function VideoStream:pause() end

---
---Plays the VideoStream.
---
function VideoStream:play() end

---
---Rewinds the VideoStream. Synonym to VideoStream:seek(0).
---
function VideoStream:rewind() end

---
---Sets the current playback position of the VideoStream.
---
---@param offset number # The time in seconds since the beginning of the VideoStream.
function VideoStream:seek(offset) end

---
---Gets the current playback position of the VideoStream.
---
---@return number seconds # The number of seconds sionce the beginning of the VideoStream.
function VideoStream:tell() end