defaults.lua (3557B)
1 ---@meta mp 2 3 ---@class mp 4 local mp = {} 5 6 ---@class AsyncReturn 7 8 ---@class MPTimer 9 ---@field stop fun(self: MPTimer) 10 ---@field kill fun(self: MPTimer) 11 ---@field resume fun(self: MPTimer) 12 ---@field is_enabled fun(self: MPTimer): boolean 13 ---@field timeout number 14 ---@field oneshot boolean 15 16 ---@class OSDOverlay 17 ---@field data string 18 ---@field res_x number 19 ---@field res_y number 20 ---@field z number 21 ---@field update fun(self:OSDOverlay) 22 ---@field remove fun(self: OSDOverlay) 23 24 ---@class MPVSubprocessResult 25 ---@field status number 26 ---@field stdout string 27 ---@field stderr string 28 ---@field error_string ''|'killed'|'init' 29 ---@field killed_by_us boolean 30 31 ---@param key string 32 ---@param name_or_fn string|function 33 ---@param fn? async fun() 34 ---@param flags? KeybindFlags 35 function mp.add_key_binding(key, name_or_fn, fn, flags) end 36 37 ---@param key string 38 ---@param name_or_fn string|function 39 ---@param fn? async fun() 40 ---@param flags? KeybindFlags 41 function mp.add_forced_key_binding(key, name_or_fn, fn, flags) end 42 43 ---@param seconds number 44 ---@param fn function 45 ---@param disabled? boolean 46 ---@return MPTimer 47 function mp.add_timeout(seconds, fn, disabled) end 48 49 ---@param format 'ass-events' 50 ---@return OSDOverlay 51 function mp.create_osd_overlay(format) end 52 53 ---@param ... string 54 function mp.commandv(...) end 55 56 ---@generic T 57 ---@param t table 58 ---@param def? T 59 ---@return unknown|T result 60 ---@return string? error 61 ---@overload fun(t: table): (unknown|nil, string?) 62 function mp.command_native(t, def) end 63 64 ---@nodiscard 65 ---@param t table 66 ---@param cb fun(success: boolean, result: unknown, error: string?) 67 ---@return AsyncReturn 68 function mp.command_native_async(t, cb) end 69 70 ---@param t AsyncReturn 71 function mp.abort_async_command(t) end 72 73 ---@generic T 74 ---@param name string 75 ---@param def? T 76 ---@return string|T 77 ---@overload fun(name: string): string|nil 78 function mp.get_property(name, def) end 79 80 ---@generic T 81 ---@param name string 82 ---@param def? T 83 ---@return boolean|T 84 ---@overload fun(name: string): boolean|nil 85 function mp.get_property_bool(name, def) end 86 87 ---@generic T 88 ---@param name string 89 ---@param def? T 90 ---@return number|T 91 ---@overload fun(name: string): number|nil 92 function mp.get_property_number(name, def) end 93 94 ---@generic T 95 ---@param name string 96 ---@param def? T 97 ---@return unknown|T 98 ---@overload fun(name: string): unknown|nil 99 function mp.get_property_native(name, def) end 100 101 ---@return string|nil 102 function mp.get_script_directory() end 103 104 ---@return string 105 function mp.get_script_name() end 106 107 ---@param name string 108 ---@param type 'native'|'bool'|'string'|'number' 109 ---@param fn fun(name: string, v: unknown) 110 function mp.observe_property(name, type, fn) end 111 112 ---@param name string 113 ---@param fn function 114 ---@return boolean 115 function mp.register_event(name, fn) end 116 117 ---@param name string 118 ---@param fn fun(...: string) 119 function mp.register_script_message(name, fn) end 120 121 ---@param name string 122 function mp.remove_key_binding(name) end 123 124 ---@param name string 125 ---@param value string 126 ---@return true? success # nil if error 127 ---@return string? err 128 function mp.set_property(name, value) end 129 130 ---@param name string 131 ---@param value boolean 132 ---@return true? success # nil if error 133 ---@return string? err 134 function mp.set_property_bool(name, value) end 135 136 ---@param name string 137 ---@param value number 138 ---@return true? success # nil if error 139 ---@return string? err 140 function mp.set_property_number(name, value) end 141 142 ---@param name string 143 ---@param value any 144 ---@return true? success # nil if error 145 ---@return string? err 146 function mp.set_property_native(name, value) end 147 148 return mp