summaryrefslogtreecommitdiff
path: root/mpv/scripts/file-browser/modules/defs/mp/defaults.lua
blob: 5a86dceb98b61756b90a45e7b69bf98be6bb508d (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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
---@meta mp

---@class mp
local mp = {}

---@class AsyncReturn

---@class MPTimer
---@field stop fun(self: MPTimer)
---@field kill fun(self: MPTimer)
---@field resume fun(self: MPTimer)
---@field is_enabled fun(self: MPTimer): boolean
---@field timeout number
---@field oneshot boolean

---@class OSDOverlay
---@field data string
---@field res_x number
---@field res_y number
---@field z number
---@field update fun(self:OSDOverlay)
---@field remove fun(self: OSDOverlay)

---@class MPVSubprocessResult
---@field status number
---@field stdout string
---@field stderr string
---@field error_string ''|'killed'|'init'
---@field killed_by_us boolean

---@param key string
---@param name_or_fn string|function
---@param fn? async fun()
---@param flags? KeybindFlags
function mp.add_key_binding(key, name_or_fn, fn, flags) end

---@param key string
---@param name_or_fn string|function
---@param fn? async fun()
---@param flags? KeybindFlags
function mp.add_forced_key_binding(key, name_or_fn, fn, flags) end

---@param seconds number
---@param fn function
---@param disabled? boolean
---@return MPTimer
function mp.add_timeout(seconds, fn, disabled) end

---@param format 'ass-events'
---@return OSDOverlay
function mp.create_osd_overlay(format) end

---@param ... string
function mp.commandv(...) end

---@generic T
---@param t table
---@param def? T
---@return unknown|T result
---@return string? error
---@overload fun(t: table): (unknown|nil, string?)
function mp.command_native(t, def) end

---@nodiscard
---@param t table
---@param cb fun(success: boolean, result: unknown, error: string?)
---@return AsyncReturn
function mp.command_native_async(t, cb) end

---@param t AsyncReturn
function mp.abort_async_command(t) end

---@generic T
---@param name string
---@param def? T
---@return string|T
---@overload fun(name: string): string|nil
function mp.get_property(name, def) end

---@generic T
---@param name string
---@param def? T
---@return boolean|T
---@overload fun(name: string): boolean|nil
function mp.get_property_bool(name, def) end

---@generic T
---@param name string
---@param def? T
---@return number|T
---@overload fun(name: string): number|nil
function mp.get_property_number(name, def) end

---@generic T
---@param name string
---@param def? T
---@return unknown|T
---@overload fun(name: string): unknown|nil
function mp.get_property_native(name, def) end

---@return string|nil
function mp.get_script_directory() end

---@return string
function mp.get_script_name() end

---@param name string
---@param type 'native'|'bool'|'string'|'number'
---@param fn fun(name: string, v: unknown)
function mp.observe_property(name, type, fn) end

---@param name string
---@param fn function
---@return boolean
function mp.register_event(name, fn) end

---@param name string
---@param fn fun(...: string)
function mp.register_script_message(name, fn) end

---@param name string
function mp.remove_key_binding(name) end

---@param name string
---@param value string
---@return true? success # nil if error
---@return string? err
function mp.set_property(name, value) end

---@param name string
---@param value boolean
---@return true? success # nil if error
---@return string? err
function mp.set_property_bool(name, value) end

---@param name string
---@param value number
---@return true? success # nil if error
---@return string? err
function mp.set_property_number(name, value) end

---@param name string
---@param value any
---@return true? success # nil if error
---@return string? err
function mp.set_property_native(name, value) end

return mp