Skip to content

Commit 2ebeac4

Browse files
author
nadeko
committed
CI autodeploy
1 parent 557bf92 commit 2ebeac4

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

manual/master/index.html

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11795,11 +11795,12 @@ <h2>List of Input Commands</h2>
1179511795
triggered. <tt class="docutils literal">name</tt> is optional. If <tt class="docutils literal">name</tt> is not given or is an
1179611796
empty string, <tt class="docutils literal">KEYUP</tt> will be set on all keys. Otherwise, <tt class="docutils literal">KEYUP</tt> will
1179711797
only be set on the key specified by <tt class="docutils literal">name</tt>.</dd>
11798-
<dt><tt class="docutils literal">keybind &lt;name&gt; &lt;command&gt;</tt></dt>
11799-
<dd>Binds a key to an input command. <tt class="docutils literal">command</tt> must be a complete command
11798+
<dt><tt class="docutils literal">keybind &lt;name&gt; &lt;cmd&gt; [&lt;comment&gt;]</tt></dt>
11799+
<dd>Binds a key to an input command. <tt class="docutils literal">cmd</tt> must be a complete command
1180011800
containing all the desired arguments and flags. Both <tt class="docutils literal">name</tt> and
11801-
<tt class="docutils literal">command</tt> use the <tt class="docutils literal">input.conf</tt> naming scheme. This is primarily
11802-
useful for the client API.</dd>
11801+
<tt class="docutils literal">cmd</tt> use the <tt class="docutils literal">input.conf</tt> naming scheme. <tt class="docutils literal">comment</tt> is an optional
11802+
string which can be read as the <tt class="docutils literal">comment</tt> entry of <tt class="docutils literal"><span class="pre">input-bindings</span></tt>.
11803+
This is primarily useful for the client API.</dd>
1180311804
<dt><tt class="docutils literal"><span class="pre">audio-add</span> &lt;url&gt; [&lt;flags&gt; [&lt;title&gt; <span class="pre">[&lt;lang&gt;]]]</span></tt></dt>
1180411805
<dd>Load the given audio file. See <tt class="docutils literal"><span class="pre">sub-add</span></tt> command.</dd>
1180511806
<dt><tt class="docutils literal"><span class="pre">audio-remove</span> [&lt;id&gt;]</tt></dt>
@@ -12687,11 +12688,11 @@ <h2>Properties</h2>
1268712688
information. They can be manipulated with the <tt class="docutils literal">set</tt>/<tt class="docutils literal">add</tt>/<tt class="docutils literal">cycle</tt>
1268812689
commands, and retrieved with <tt class="docutils literal"><span class="pre">show-text</span></tt>, or anything else that uses property
1268912690
expansion. (See <a class="reference internal" href="#property-expansion">Property Expansion</a>.)</p>
12690-
<p>The property name is annotated with RW to indicate whether the property is
12691-
generally writable.</p>
1269212691
<p>If an option is referenced, the property will normally take/return exactly the
1269312692
same values as the option. In these cases, properties are merely a way to change
1269412693
an option at runtime.</p>
12694+
<p>Note that many properties are unavailable at startup. See <a class="reference internal" href="#details-on-the-script-initialization-and-lifecycle">Details on the script
12695+
initialization and lifecycle</a>.</p>
1269512696
</div>
1269612697
<div class="section" id="property-list">
1269712698
<h2>Property list</h2>
@@ -12752,8 +12753,7 @@ <h2>Property list</h2>
1275212753
<dd>Full path of the currently played file. Usually this is exactly the same
1275312754
string you pass on the mpv command line or the <tt class="docutils literal">loadfile</tt> command, even
1275412755
if it's a relative path. If you expect an absolute path, you will have to
12755-
determine it yourself, for example by using the <tt class="docutils literal"><span class="pre">working-directory</span></tt>
12756-
property.</dd>
12756+
determine it yourself, for example by using the <tt class="docutils literal"><span class="pre">normalize-path</span></tt> command.</dd>
1275712757
<dt><tt class="docutils literal"><span class="pre">stream-open-filename</span></tt></dt>
1275812758
<dd>The full path to the currently played media. This is different from
1275912759
<tt class="docutils literal">path</tt> only in special cases. In particular, if <tt class="docutils literal"><span class="pre">--ytdl=yes</span></tt> is used,
@@ -15618,7 +15618,8 @@ <h2>Details on the script initialization and lifecycle</h2>
1561815618
timers added with <tt class="docutils literal">mp.add_timeout</tt> or similar. Note that since the
1561915619
script starts execution concurrently with player initialization, some properties
1562015620
may not be populated with meaningful values until the relevant subsystems have
15621-
initialized.</p>
15621+
initialized. Rather than retrieving these properties at the top of scripts, you
15622+
should use <tt class="docutils literal">mp.observe_property</tt> or read them within event handlers.</p>
1562215623
<p>When the player quits, all scripts will be asked to terminate. This happens via
1562315624
a <tt class="docutils literal">shutdown</tt> event, which by default will make the event loop return. If your
1562415625
script got into an endless loop, mpv will probably behave fine during playback,

0 commit comments

Comments
 (0)