mirror of
https://github.com/NotAShelf/mpvrc.git
synced 2026-04-16 16:03:48 +00:00
357 lines
No EOL
34 KiB
HTML
357 lines
No EOL
34 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/lib.rs`."><title>lib.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-6c3ea77c.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mrc" data-themes="" data-resource-suffix="" data-rustdoc-version="1.86.0 (05f9846f8 2025-03-31)" data-channel="1.86.0" data-search-js="search-581efc7a.js" data-settings-js="settings-6dad6058.js" ><script src="../../static.files/storage-3a5871a4.js"></script><script defer src="../../static.files/src-script-b8d3f215.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-4d63596a.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">mrc/</div>lib.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! MRC
|
|
<a href=#2 id=2 data-nosnippet>2</a>//! A library for interacting with the MPV media player using its JSON IPC (Inter-Process Communication) protocol.
|
|
<a href=#3 id=3 data-nosnippet>3</a>//!
|
|
<a href=#4 id=4 data-nosnippet>4</a>//! This crate provides a set of utilities to communicate with MPV's IPC socket, enabling you to send commands
|
|
<a href=#5 id=5 data-nosnippet>5</a>//! and retrieve responses in a structured format.
|
|
<a href=#6 id=6 data-nosnippet>6</a>//!
|
|
<a href=#7 id=7 data-nosnippet>7</a>//! ## Features
|
|
<a href=#8 id=8 data-nosnippet>8</a>//!
|
|
<a href=#9 id=9 data-nosnippet>9</a>//! - Send commands to MPV's IPC socket
|
|
<a href=#10 id=10 data-nosnippet>10</a>//! - Retrieve responses in JSON format
|
|
<a href=#11 id=11 data-nosnippet>11</a>//! - Supports common MPV commands like `set_property`, `seek`, and `playlist-next`
|
|
<a href=#12 id=12 data-nosnippet>12</a>//! - Flexible socket path configuration
|
|
<a href=#13 id=13 data-nosnippet>13</a>//!
|
|
<a href=#14 id=14 data-nosnippet>14</a>//! ## Example Usage
|
|
<a href=#15 id=15 data-nosnippet>15</a>//! ```rust
|
|
<a href=#16 id=16 data-nosnippet>16</a>//! use serde_json::json;
|
|
<a href=#17 id=17 data-nosnippet>17</a>//! use tokio;
|
|
<a href=#18 id=18 data-nosnippet>18</a>//! use mrc::{send_ipc_command, playlist_next, set_property};
|
|
<a href=#19 id=19 data-nosnippet>19</a>//!
|
|
<a href=#20 id=20 data-nosnippet>20</a>//! #[tokio::main]
|
|
<a href=#21 id=21 data-nosnippet>21</a>//! async fn main() {
|
|
<a href=#22 id=22 data-nosnippet>22</a>//! let result = playlist_next(None).await;
|
|
<a href=#23 id=23 data-nosnippet>23</a>//! match result {
|
|
<a href=#24 id=24 data-nosnippet>24</a>//! Ok(response) => println!("Playlist moved to next: {:?}", response),
|
|
<a href=#25 id=25 data-nosnippet>25</a>//! Err(err) => eprintln!("Error: {:?}", err),
|
|
<a href=#26 id=26 data-nosnippet>26</a>//! }
|
|
<a href=#27 id=27 data-nosnippet>27</a>//!
|
|
<a href=#28 id=28 data-nosnippet>28</a>//! let property_result = set_property("volume", &json!(50), None).await;
|
|
<a href=#29 id=29 data-nosnippet>29</a>//! match property_result {
|
|
<a href=#30 id=30 data-nosnippet>30</a>//! Ok(response) => println!("Volume set: {:?}", response),
|
|
<a href=#31 id=31 data-nosnippet>31</a>//! Err(err) => eprintln!("Error: {:?}", err),
|
|
<a href=#32 id=32 data-nosnippet>32</a>//! }
|
|
<a href=#33 id=33 data-nosnippet>33</a>//! }
|
|
<a href=#34 id=34 data-nosnippet>34</a>//! ```
|
|
<a href=#35 id=35 data-nosnippet>35</a>//!
|
|
<a href=#36 id=36 data-nosnippet>36</a>//! ## Constants
|
|
<a href=#37 id=37 data-nosnippet>37</a>//!
|
|
<a href=#38 id=38 data-nosnippet>38</a>//! ### `SOCKET_PATH`
|
|
<a href=#39 id=39 data-nosnippet>39</a>//! Default path for the MPV IPC socket: `/tmp/mpvsocket`
|
|
<a href=#40 id=40 data-nosnippet>40</a>//!
|
|
<a href=#41 id=41 data-nosnippet>41</a>//! ## Functions
|
|
<a href=#42 id=42 data-nosnippet>42</a>
|
|
<a href=#43 id=43 data-nosnippet>43</a></span><span class="kw">use </span>serde_json::{json, Value};
|
|
<a href=#44 id=44 data-nosnippet>44</a><span class="kw">use </span>std::io::{<span class="self">self</span>};
|
|
<a href=#45 id=45 data-nosnippet>45</a><span class="kw">use </span>tokio::io::{AsyncReadExt, AsyncWriteExt};
|
|
<a href=#46 id=46 data-nosnippet>46</a><span class="kw">use </span>tokio::net::UnixStream;
|
|
<a href=#47 id=47 data-nosnippet>47</a><span class="kw">use </span>tracing::{debug, error};
|
|
<a href=#48 id=48 data-nosnippet>48</a>
|
|
<a href=#49 id=49 data-nosnippet>49</a><span class="kw">pub const </span>SOCKET_PATH: <span class="kw-2">&</span>str = <span class="string">"/tmp/mpvsocket"</span>;
|
|
<a href=#50 id=50 data-nosnippet>50</a>
|
|
<a href=#51 id=51 data-nosnippet>51</a><span class="doccomment">/// Sends a generic IPC command to the specified socket and returns the parsed response data.
|
|
<a href=#52 id=52 data-nosnippet>52</a>///
|
|
<a href=#53 id=53 data-nosnippet>53</a>/// # Arguments
|
|
<a href=#54 id=54 data-nosnippet>54</a>/// - `command`: The name of the command to send to MPV.
|
|
<a href=#55 id=55 data-nosnippet>55</a>/// - `args`: A slice of `Value` arguments to include in the command.
|
|
<a href=#56 id=56 data-nosnippet>56</a>/// - `socket_path`: An optional custom path to the MPV IPC socket. If `None`, the default path is used.
|
|
<a href=#57 id=57 data-nosnippet>57</a>///
|
|
<a href=#58 id=58 data-nosnippet>58</a>/// # Returns
|
|
<a href=#59 id=59 data-nosnippet>59</a>/// A `Result` containing an `Option<Value>` with the parsed response data if successful.
|
|
<a href=#60 id=60 data-nosnippet>60</a>///
|
|
<a href=#61 id=61 data-nosnippet>61</a>/// # Errors
|
|
<a href=#62 id=62 data-nosnippet>62</a>/// Returns an error if the connection to the socket fails or if the response cannot be parsed.
|
|
<a href=#63 id=63 data-nosnippet>63</a></span><span class="kw">pub async fn </span>send_ipc_command(
|
|
<a href=#64 id=64 data-nosnippet>64</a> command: <span class="kw-2">&</span>str,
|
|
<a href=#65 id=65 data-nosnippet>65</a> args: <span class="kw-2">&</span>[Value],
|
|
<a href=#66 id=66 data-nosnippet>66</a> socket_path: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>,
|
|
<a href=#67 id=67 data-nosnippet>67</a>) -> io::Result<<span class="prelude-ty">Option</span><Value>> {
|
|
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">let </span>socket_path = socket_path.unwrap_or(SOCKET_PATH);
|
|
<a href=#69 id=69 data-nosnippet>69</a> <span class="macro">debug!</span>(
|
|
<a href=#70 id=70 data-nosnippet>70</a> <span class="string">"Sending IPC command: {} with arguments: {:?}"</span>,
|
|
<a href=#71 id=71 data-nosnippet>71</a> command, args
|
|
<a href=#72 id=72 data-nosnippet>72</a> );
|
|
<a href=#73 id=73 data-nosnippet>73</a>
|
|
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">match </span>UnixStream::connect(socket_path).<span class="kw">await </span>{
|
|
<a href=#75 id=75 data-nosnippet>75</a> <span class="prelude-val">Ok</span>(<span class="kw-2">mut </span>socket) => {
|
|
<a href=#76 id=76 data-nosnippet>76</a> <span class="macro">debug!</span>(<span class="string">"Connected to socket at {}"</span>, socket_path);
|
|
<a href=#77 id=77 data-nosnippet>77</a>
|
|
<a href=#78 id=78 data-nosnippet>78</a> <span class="kw">let </span><span class="kw-2">mut </span>command_array = <span class="macro">vec!</span>[<span class="macro">json!</span>(command)];
|
|
<a href=#79 id=79 data-nosnippet>79</a> command_array.extend_from_slice(args);
|
|
<a href=#80 id=80 data-nosnippet>80</a> <span class="kw">let </span>message = <span class="macro">json!</span>({ <span class="string">"command"</span>: command_array });
|
|
<a href=#81 id=81 data-nosnippet>81</a> <span class="kw">let </span>message_str = <span class="macro">format!</span>(<span class="string">"{}\n"</span>, serde_json::to_string(<span class="kw-2">&</span>message)<span class="question-mark">?</span>);
|
|
<a href=#82 id=82 data-nosnippet>82</a> <span class="macro">debug!</span>(<span class="string">"Serialized message to send with newline: {}"</span>, message_str);
|
|
<a href=#83 id=83 data-nosnippet>83</a>
|
|
<a href=#84 id=84 data-nosnippet>84</a> socket.write_all(message_str.as_bytes()).<span class="kw">await</span><span class="question-mark">?</span>;
|
|
<a href=#85 id=85 data-nosnippet>85</a> socket.flush().<span class="kw">await</span><span class="question-mark">?</span>;
|
|
<a href=#86 id=86 data-nosnippet>86</a> <span class="macro">debug!</span>(<span class="string">"Message sent and flushed"</span>);
|
|
<a href=#87 id=87 data-nosnippet>87</a>
|
|
<a href=#88 id=88 data-nosnippet>88</a> <span class="kw">let </span><span class="kw-2">mut </span>response = <span class="macro">vec!</span>[<span class="number">0</span>; <span class="number">1024</span>];
|
|
<a href=#89 id=89 data-nosnippet>89</a> <span class="kw">let </span>n = socket.read(<span class="kw-2">&mut </span>response).<span class="kw">await</span><span class="question-mark">?</span>;
|
|
<a href=#90 id=90 data-nosnippet>90</a> <span class="kw">let </span>response_str = String::from_utf8_lossy(<span class="kw-2">&</span>response[..n]);
|
|
<a href=#91 id=91 data-nosnippet>91</a> <span class="macro">debug!</span>(<span class="string">"Raw response: {}"</span>, response_str);
|
|
<a href=#92 id=92 data-nosnippet>92</a>
|
|
<a href=#93 id=93 data-nosnippet>93</a> <span class="kw">match </span>serde_json::from_str::<Value>(<span class="kw-2">&</span>response_str) {
|
|
<a href=#94 id=94 data-nosnippet>94</a> <span class="prelude-val">Ok</span>(json_response) => {
|
|
<a href=#95 id=95 data-nosnippet>95</a> <span class="macro">debug!</span>(<span class="string">"Parsed IPC response: {:?}"</span>, json_response);
|
|
<a href=#96 id=96 data-nosnippet>96</a> <span class="prelude-val">Ok</span>(json_response.get(<span class="string">"data"</span>).cloned())
|
|
<a href=#97 id=97 data-nosnippet>97</a> }
|
|
<a href=#98 id=98 data-nosnippet>98</a>
|
|
<a href=#99 id=99 data-nosnippet>99</a> <span class="prelude-val">Err</span>(e) => {
|
|
<a href=#100 id=100 data-nosnippet>100</a> <span class="macro">error!</span>(<span class="string">"Failed to parse response: {}"</span>, e);
|
|
<a href=#101 id=101 data-nosnippet>101</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>)
|
|
<a href=#102 id=102 data-nosnippet>102</a> }
|
|
<a href=#103 id=103 data-nosnippet>103</a> }
|
|
<a href=#104 id=104 data-nosnippet>104</a> }
|
|
<a href=#105 id=105 data-nosnippet>105</a>
|
|
<a href=#106 id=106 data-nosnippet>106</a> <span class="prelude-val">Err</span>(e) => {
|
|
<a href=#107 id=107 data-nosnippet>107</a> <span class="macro">error!</span>(<span class="string">"Failed to connect to MPV socket: {}"</span>, e);
|
|
<a href=#108 id=108 data-nosnippet>108</a> <span class="prelude-val">Err</span>(e)
|
|
<a href=#109 id=109 data-nosnippet>109</a> }
|
|
<a href=#110 id=110 data-nosnippet>110</a> }
|
|
<a href=#111 id=111 data-nosnippet>111</a>}
|
|
<a href=#112 id=112 data-nosnippet>112</a>
|
|
<a href=#113 id=113 data-nosnippet>113</a><span class="doccomment">/// Represents common MPV commands.
|
|
<a href=#114 id=114 data-nosnippet>114</a>///
|
|
<a href=#115 id=115 data-nosnippet>115</a>/// This enum provides variants for frequently used MPV commands, which can be converted to their
|
|
<a href=#116 id=116 data-nosnippet>116</a>/// string equivalents using the `as_str` method.
|
|
<a href=#117 id=117 data-nosnippet>117</a>///
|
|
<a href=#118 id=118 data-nosnippet>118</a>/// # Errors
|
|
<a href=#119 id=119 data-nosnippet>119</a>/// Returns an error if the connection to the socket fails or the command execution encounters issues.
|
|
<a href=#120 id=120 data-nosnippet>120</a></span><span class="attr">#[derive(Debug)]
|
|
<a href=#121 id=121 data-nosnippet>121</a></span><span class="kw">pub enum </span>MpvCommand {
|
|
<a href=#122 id=122 data-nosnippet>122</a> <span class="doccomment">/// Sets a property to a specified value in MPV.
|
|
<a href=#123 id=123 data-nosnippet>123</a> </span>SetProperty,
|
|
<a href=#124 id=124 data-nosnippet>124</a> <span class="doccomment">/// Moves to the next item in the playlist.
|
|
<a href=#125 id=125 data-nosnippet>125</a> </span>PlaylistNext,
|
|
<a href=#126 id=126 data-nosnippet>126</a> <span class="doccomment">/// Moves to the previous item in the playlist.
|
|
<a href=#127 id=127 data-nosnippet>127</a> </span>PlaylistPrev,
|
|
<a href=#128 id=128 data-nosnippet>128</a> <span class="doccomment">/// Seeks to a specific time in the current media.
|
|
<a href=#129 id=129 data-nosnippet>129</a> </span>Seek,
|
|
<a href=#130 id=130 data-nosnippet>130</a> <span class="doccomment">/// Quits the MPV application.
|
|
<a href=#131 id=131 data-nosnippet>131</a> </span>Quit,
|
|
<a href=#132 id=132 data-nosnippet>132</a> <span class="doccomment">/// Moves an item in the playlist from one index to another.
|
|
<a href=#133 id=133 data-nosnippet>133</a> </span>PlaylistMove,
|
|
<a href=#134 id=134 data-nosnippet>134</a> <span class="doccomment">/// Removes an item from the playlist.
|
|
<a href=#135 id=135 data-nosnippet>135</a> </span>PlaylistRemove,
|
|
<a href=#136 id=136 data-nosnippet>136</a> <span class="doccomment">/// Clears all items from the playlist.
|
|
<a href=#137 id=137 data-nosnippet>137</a> </span>PlaylistClear,
|
|
<a href=#138 id=138 data-nosnippet>138</a> <span class="doccomment">/// Retrieves the value of a property in MPV.
|
|
<a href=#139 id=139 data-nosnippet>139</a> </span>GetProperty,
|
|
<a href=#140 id=140 data-nosnippet>140</a> <span class="doccomment">/// Loads a file into MPV.
|
|
<a href=#141 id=141 data-nosnippet>141</a> </span>LoadFile,
|
|
<a href=#142 id=142 data-nosnippet>142</a>}
|
|
<a href=#143 id=143 data-nosnippet>143</a>
|
|
<a href=#144 id=144 data-nosnippet>144</a><span class="kw">impl </span>MpvCommand {
|
|
<a href=#145 id=145 data-nosnippet>145</a> <span class="doccomment">/// Converts MPV commands to their string equivalents.
|
|
<a href=#146 id=146 data-nosnippet>146</a> ///
|
|
<a href=#147 id=147 data-nosnippet>147</a> /// # Returns
|
|
<a href=#148 id=148 data-nosnippet>148</a> /// A string slice representing the command.
|
|
<a href=#149 id=149 data-nosnippet>149</a> </span><span class="attr">#[must_use]
|
|
<a href=#150 id=150 data-nosnippet>150</a> </span><span class="kw">pub const fn </span>as_str(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str {
|
|
<a href=#151 id=151 data-nosnippet>151</a> <span class="kw">match </span><span class="self">self </span>{
|
|
<a href=#152 id=152 data-nosnippet>152</a> <span class="self">Self</span>::SetProperty => <span class="string">"set_property"</span>,
|
|
<a href=#153 id=153 data-nosnippet>153</a> <span class="self">Self</span>::PlaylistNext => <span class="string">"playlist-next"</span>,
|
|
<a href=#154 id=154 data-nosnippet>154</a> <span class="self">Self</span>::PlaylistPrev => <span class="string">"playlist-prev"</span>,
|
|
<a href=#155 id=155 data-nosnippet>155</a> <span class="self">Self</span>::Seek => <span class="string">"seek"</span>,
|
|
<a href=#156 id=156 data-nosnippet>156</a> <span class="self">Self</span>::Quit => <span class="string">"quit"</span>,
|
|
<a href=#157 id=157 data-nosnippet>157</a> <span class="self">Self</span>::PlaylistMove => <span class="string">"playlist-move"</span>,
|
|
<a href=#158 id=158 data-nosnippet>158</a> <span class="self">Self</span>::PlaylistRemove => <span class="string">"playlist-remove"</span>,
|
|
<a href=#159 id=159 data-nosnippet>159</a> <span class="self">Self</span>::PlaylistClear => <span class="string">"playlist-clear"</span>,
|
|
<a href=#160 id=160 data-nosnippet>160</a> <span class="self">Self</span>::GetProperty => <span class="string">"get_property"</span>,
|
|
<a href=#161 id=161 data-nosnippet>161</a> <span class="self">Self</span>::LoadFile => <span class="string">"loadfile"</span>,
|
|
<a href=#162 id=162 data-nosnippet>162</a> }
|
|
<a href=#163 id=163 data-nosnippet>163</a> }
|
|
<a href=#164 id=164 data-nosnippet>164</a>}
|
|
<a href=#165 id=165 data-nosnippet>165</a>
|
|
<a href=#166 id=166 data-nosnippet>166</a><span class="doccomment">/// Sends the `set_property` command to MPV to change a property value.
|
|
<a href=#167 id=167 data-nosnippet>167</a>///
|
|
<a href=#168 id=168 data-nosnippet>168</a>/// # Arguments
|
|
<a href=#169 id=169 data-nosnippet>169</a>/// - `property`: The name of the property to set.
|
|
<a href=#170 id=170 data-nosnippet>170</a>/// - `value`: The new value to assign to the property.
|
|
<a href=#171 id=171 data-nosnippet>171</a>/// - `socket_path`: An optional custom socket path.
|
|
<a href=#172 id=172 data-nosnippet>172</a>///
|
|
<a href=#173 id=173 data-nosnippet>173</a>/// # Returns
|
|
<a href=#174 id=174 data-nosnippet>174</a>/// A `Result` containing the response data.
|
|
<a href=#175 id=175 data-nosnippet>175</a>///
|
|
<a href=#176 id=176 data-nosnippet>176</a>/// # Errors
|
|
<a href=#177 id=177 data-nosnippet>177</a>/// Returns an error if the connection to the socket fails or the command execution encounters issues.
|
|
<a href=#178 id=178 data-nosnippet>178</a></span><span class="kw">pub async fn </span>set_property(
|
|
<a href=#179 id=179 data-nosnippet>179</a> property: <span class="kw-2">&</span>str,
|
|
<a href=#180 id=180 data-nosnippet>180</a> value: <span class="kw-2">&</span>Value,
|
|
<a href=#181 id=181 data-nosnippet>181</a> socket_path: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>,
|
|
<a href=#182 id=182 data-nosnippet>182</a>) -> io::Result<<span class="prelude-ty">Option</span><Value>> {
|
|
<a href=#183 id=183 data-nosnippet>183</a> send_ipc_command(
|
|
<a href=#184 id=184 data-nosnippet>184</a> MpvCommand::SetProperty.as_str(),
|
|
<a href=#185 id=185 data-nosnippet>185</a> <span class="kw-2">&</span>[<span class="macro">json!</span>(property), value.clone()],
|
|
<a href=#186 id=186 data-nosnippet>186</a> socket_path,
|
|
<a href=#187 id=187 data-nosnippet>187</a> )
|
|
<a href=#188 id=188 data-nosnippet>188</a> .<span class="kw">await
|
|
<a href=#189 id=189 data-nosnippet>189</a></span>}
|
|
<a href=#190 id=190 data-nosnippet>190</a>
|
|
<a href=#191 id=191 data-nosnippet>191</a><span class="doccomment">/// Sends the `playlist-next` command to move to the next playlist item.
|
|
<a href=#192 id=192 data-nosnippet>192</a>///
|
|
<a href=#193 id=193 data-nosnippet>193</a>/// # Arguments
|
|
<a href=#194 id=194 data-nosnippet>194</a>/// - `socket_path`: An optional custom socket path.
|
|
<a href=#195 id=195 data-nosnippet>195</a>///
|
|
<a href=#196 id=196 data-nosnippet>196</a>/// # Returns
|
|
<a href=#197 id=197 data-nosnippet>197</a>/// A `Result` containing the response data.
|
|
<a href=#198 id=198 data-nosnippet>198</a>///
|
|
<a href=#199 id=199 data-nosnippet>199</a>/// # Errors
|
|
<a href=#200 id=200 data-nosnippet>200</a>/// Returns an error if the connection to the socket fails or the command execution encounters issues.
|
|
<a href=#201 id=201 data-nosnippet>201</a></span><span class="kw">pub async fn </span>playlist_next(socket_path: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>) -> io::Result<<span class="prelude-ty">Option</span><Value>> {
|
|
<a href=#202 id=202 data-nosnippet>202</a> send_ipc_command(MpvCommand::PlaylistNext.as_str(), <span class="kw-2">&</span>[], socket_path).<span class="kw">await
|
|
<a href=#203 id=203 data-nosnippet>203</a></span>}
|
|
<a href=#204 id=204 data-nosnippet>204</a>
|
|
<a href=#205 id=205 data-nosnippet>205</a><span class="doccomment">/// Sends the `playlist-prev` command to move to the previous playlist item.
|
|
<a href=#206 id=206 data-nosnippet>206</a>///
|
|
<a href=#207 id=207 data-nosnippet>207</a>/// # Arguments
|
|
<a href=#208 id=208 data-nosnippet>208</a>/// - `socket_path`: An optional custom socket path.
|
|
<a href=#209 id=209 data-nosnippet>209</a>///
|
|
<a href=#210 id=210 data-nosnippet>210</a>/// # Returns
|
|
<a href=#211 id=211 data-nosnippet>211</a>/// A `Result` containing the response data.
|
|
<a href=#212 id=212 data-nosnippet>212</a>///
|
|
<a href=#213 id=213 data-nosnippet>213</a>/// # Errors
|
|
<a href=#214 id=214 data-nosnippet>214</a>/// Returns an error if the connection to the socket fails or the command execution encounters issues.
|
|
<a href=#215 id=215 data-nosnippet>215</a></span><span class="kw">pub async fn </span>playlist_prev(socket_path: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>) -> io::Result<<span class="prelude-ty">Option</span><Value>> {
|
|
<a href=#216 id=216 data-nosnippet>216</a> send_ipc_command(MpvCommand::PlaylistPrev.as_str(), <span class="kw-2">&</span>[], socket_path).<span class="kw">await
|
|
<a href=#217 id=217 data-nosnippet>217</a></span>}
|
|
<a href=#218 id=218 data-nosnippet>218</a>
|
|
<a href=#219 id=219 data-nosnippet>219</a><span class="doccomment">/// Sends the `seek` command to seek the media playback by a given number of seconds.
|
|
<a href=#220 id=220 data-nosnippet>220</a>///
|
|
<a href=#221 id=221 data-nosnippet>221</a>/// # Arguments
|
|
<a href=#222 id=222 data-nosnippet>222</a>/// - `seconds`: The number of seconds to seek.
|
|
<a href=#223 id=223 data-nosnippet>223</a>/// - `socket_path`: An optional custom socket path.
|
|
<a href=#224 id=224 data-nosnippet>224</a>///
|
|
<a href=#225 id=225 data-nosnippet>225</a>/// # Returns
|
|
<a href=#226 id=226 data-nosnippet>226</a>/// A `Result` containing the response data.
|
|
<a href=#227 id=227 data-nosnippet>227</a>///
|
|
<a href=#228 id=228 data-nosnippet>228</a>/// # Errors
|
|
<a href=#229 id=229 data-nosnippet>229</a>/// Returns an error if the connection to the socket fails or the command execution encounters issues.
|
|
<a href=#230 id=230 data-nosnippet>230</a></span><span class="kw">pub async fn </span>seek(seconds: f64, socket_path: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>) -> io::Result<<span class="prelude-ty">Option</span><Value>> {
|
|
<a href=#231 id=231 data-nosnippet>231</a> send_ipc_command(MpvCommand::Seek.as_str(), <span class="kw-2">&</span>[<span class="macro">json!</span>(seconds)], socket_path).<span class="kw">await
|
|
<a href=#232 id=232 data-nosnippet>232</a></span>}
|
|
<a href=#233 id=233 data-nosnippet>233</a>
|
|
<a href=#234 id=234 data-nosnippet>234</a><span class="doccomment">/// Sends the `quit` command to terminate MPV.
|
|
<a href=#235 id=235 data-nosnippet>235</a>///
|
|
<a href=#236 id=236 data-nosnippet>236</a>/// # Arguments
|
|
<a href=#237 id=237 data-nosnippet>237</a>/// - `socket_path`: An optional custom socket path.
|
|
<a href=#238 id=238 data-nosnippet>238</a>///
|
|
<a href=#239 id=239 data-nosnippet>239</a>/// # Returns
|
|
<a href=#240 id=240 data-nosnippet>240</a>/// A `Result` containing the response data.
|
|
<a href=#241 id=241 data-nosnippet>241</a>///
|
|
<a href=#242 id=242 data-nosnippet>242</a>/// # Errors
|
|
<a href=#243 id=243 data-nosnippet>243</a>/// Returns an error if the connection to the socket fails or the command execution encounters issues.
|
|
<a href=#244 id=244 data-nosnippet>244</a></span><span class="kw">pub async fn </span>quit(socket_path: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>) -> io::Result<<span class="prelude-ty">Option</span><Value>> {
|
|
<a href=#245 id=245 data-nosnippet>245</a> send_ipc_command(MpvCommand::Quit.as_str(), <span class="kw-2">&</span>[], socket_path).<span class="kw">await
|
|
<a href=#246 id=246 data-nosnippet>246</a></span>}
|
|
<a href=#247 id=247 data-nosnippet>247</a>
|
|
<a href=#248 id=248 data-nosnippet>248</a><span class="doccomment">/// Sends the `playlist-move` command to move a playlist item from one index to another.
|
|
<a href=#249 id=249 data-nosnippet>249</a>///
|
|
<a href=#250 id=250 data-nosnippet>250</a>/// # Arguments
|
|
<a href=#251 id=251 data-nosnippet>251</a>/// - `from_index`: The index of the item to move.
|
|
<a href=#252 id=252 data-nosnippet>252</a>/// - `to_index`: The index to move the item to.
|
|
<a href=#253 id=253 data-nosnippet>253</a>/// - `socket_path`: An optional custom socket path.
|
|
<a href=#254 id=254 data-nosnippet>254</a>///
|
|
<a href=#255 id=255 data-nosnippet>255</a>/// # Returns
|
|
<a href=#256 id=256 data-nosnippet>256</a>/// A `Result` containing the response data.
|
|
<a href=#257 id=257 data-nosnippet>257</a>///
|
|
<a href=#258 id=258 data-nosnippet>258</a>/// # Errors
|
|
<a href=#259 id=259 data-nosnippet>259</a>/// Returns an error if the connection to the socket fails or the command execution encounters issues.
|
|
<a href=#260 id=260 data-nosnippet>260</a></span><span class="kw">pub async fn </span>playlist_move(
|
|
<a href=#261 id=261 data-nosnippet>261</a> from_index: usize,
|
|
<a href=#262 id=262 data-nosnippet>262</a> to_index: usize,
|
|
<a href=#263 id=263 data-nosnippet>263</a> socket_path: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>,
|
|
<a href=#264 id=264 data-nosnippet>264</a>) -> io::Result<<span class="prelude-ty">Option</span><Value>> {
|
|
<a href=#265 id=265 data-nosnippet>265</a> send_ipc_command(
|
|
<a href=#266 id=266 data-nosnippet>266</a> MpvCommand::PlaylistMove.as_str(),
|
|
<a href=#267 id=267 data-nosnippet>267</a> <span class="kw-2">&</span>[<span class="macro">json!</span>(from_index), <span class="macro">json!</span>(to_index)],
|
|
<a href=#268 id=268 data-nosnippet>268</a> socket_path,
|
|
<a href=#269 id=269 data-nosnippet>269</a> )
|
|
<a href=#270 id=270 data-nosnippet>270</a> .<span class="kw">await
|
|
<a href=#271 id=271 data-nosnippet>271</a></span>}
|
|
<a href=#272 id=272 data-nosnippet>272</a>
|
|
<a href=#273 id=273 data-nosnippet>273</a><span class="doccomment">/// Sends the `playlist-remove` command to remove an item from the playlist.
|
|
<a href=#274 id=274 data-nosnippet>274</a>///
|
|
<a href=#275 id=275 data-nosnippet>275</a>/// # Arguments
|
|
<a href=#276 id=276 data-nosnippet>276</a>/// - `index`: The index of the item to remove, or `None` to remove the current item.
|
|
<a href=#277 id=277 data-nosnippet>277</a>/// - `socket_path`: An optional custom socket path.
|
|
<a href=#278 id=278 data-nosnippet>278</a>///
|
|
<a href=#279 id=279 data-nosnippet>279</a>/// # Returns
|
|
<a href=#280 id=280 data-nosnippet>280</a>/// A `Result` containing the response data.
|
|
<a href=#281 id=281 data-nosnippet>281</a>///
|
|
<a href=#282 id=282 data-nosnippet>282</a>/// # Errors
|
|
<a href=#283 id=283 data-nosnippet>283</a>/// Returns an error if the connection to the socket fails or the command execution encounters issues.
|
|
<a href=#284 id=284 data-nosnippet>284</a></span><span class="kw">pub async fn </span>playlist_remove(
|
|
<a href=#285 id=285 data-nosnippet>285</a> index: <span class="prelude-ty">Option</span><usize>,
|
|
<a href=#286 id=286 data-nosnippet>286</a> socket_path: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>,
|
|
<a href=#287 id=287 data-nosnippet>287</a>) -> io::Result<<span class="prelude-ty">Option</span><Value>> {
|
|
<a href=#288 id=288 data-nosnippet>288</a> <span class="kw">let </span>args = <span class="kw">match </span>index {
|
|
<a href=#289 id=289 data-nosnippet>289</a> <span class="prelude-val">Some</span>(idx) => <span class="macro">vec!</span>[<span class="macro">json!</span>(idx)],
|
|
<a href=#290 id=290 data-nosnippet>290</a> <span class="prelude-val">None </span>=> <span class="macro">vec!</span>[<span class="macro">json!</span>(<span class="string">"current"</span>)],
|
|
<a href=#291 id=291 data-nosnippet>291</a> };
|
|
<a href=#292 id=292 data-nosnippet>292</a> send_ipc_command(MpvCommand::PlaylistRemove.as_str(), <span class="kw-2">&</span>args, socket_path).<span class="kw">await
|
|
<a href=#293 id=293 data-nosnippet>293</a></span>}
|
|
<a href=#294 id=294 data-nosnippet>294</a>
|
|
<a href=#295 id=295 data-nosnippet>295</a><span class="doccomment">/// Sends the `playlist-clear` command to clear the playlist.
|
|
<a href=#296 id=296 data-nosnippet>296</a>///
|
|
<a href=#297 id=297 data-nosnippet>297</a>/// # Arguments
|
|
<a href=#298 id=298 data-nosnippet>298</a>/// - `socket_path`: An optional custom socket path.
|
|
<a href=#299 id=299 data-nosnippet>299</a>///
|
|
<a href=#300 id=300 data-nosnippet>300</a>/// # Returns
|
|
<a href=#301 id=301 data-nosnippet>301</a>/// A `Result` containing the response data.
|
|
<a href=#302 id=302 data-nosnippet>302</a>///
|
|
<a href=#303 id=303 data-nosnippet>303</a>/// # Errors
|
|
<a href=#304 id=304 data-nosnippet>304</a>/// Returns an error if the connection to the socket fails or the command execution encounters issues.
|
|
<a href=#305 id=305 data-nosnippet>305</a></span><span class="kw">pub async fn </span>playlist_clear(socket_path: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>) -> io::Result<<span class="prelude-ty">Option</span><Value>> {
|
|
<a href=#306 id=306 data-nosnippet>306</a> send_ipc_command(MpvCommand::PlaylistClear.as_str(), <span class="kw-2">&</span>[], socket_path).<span class="kw">await
|
|
<a href=#307 id=307 data-nosnippet>307</a></span>}
|
|
<a href=#308 id=308 data-nosnippet>308</a>
|
|
<a href=#309 id=309 data-nosnippet>309</a><span class="doccomment">/// Sends the `get_property` command to retrieve a property value from MPV.
|
|
<a href=#310 id=310 data-nosnippet>310</a>///
|
|
<a href=#311 id=311 data-nosnippet>311</a>/// # Arguments
|
|
<a href=#312 id=312 data-nosnippet>312</a>/// - `property`: The name of the property to retrieve.
|
|
<a href=#313 id=313 data-nosnippet>313</a>/// - `socket_path`: An optional custom socket path.
|
|
<a href=#314 id=314 data-nosnippet>314</a>///
|
|
<a href=#315 id=315 data-nosnippet>315</a>/// # Returns
|
|
<a href=#316 id=316 data-nosnippet>316</a>/// A `Result` containing the response data.
|
|
<a href=#317 id=317 data-nosnippet>317</a>///
|
|
<a href=#318 id=318 data-nosnippet>318</a>/// # Errors
|
|
<a href=#319 id=319 data-nosnippet>319</a>/// Returns an error if the connection to the socket fails or the command execution encounters issues.
|
|
<a href=#320 id=320 data-nosnippet>320</a></span><span class="kw">pub async fn </span>get_property(property: <span class="kw-2">&</span>str, socket_path: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>) -> io::Result<<span class="prelude-ty">Option</span><Value>> {
|
|
<a href=#321 id=321 data-nosnippet>321</a> send_ipc_command(
|
|
<a href=#322 id=322 data-nosnippet>322</a> MpvCommand::GetProperty.as_str(),
|
|
<a href=#323 id=323 data-nosnippet>323</a> <span class="kw-2">&</span>[<span class="macro">json!</span>(property)],
|
|
<a href=#324 id=324 data-nosnippet>324</a> socket_path,
|
|
<a href=#325 id=325 data-nosnippet>325</a> )
|
|
<a href=#326 id=326 data-nosnippet>326</a> .<span class="kw">await
|
|
<a href=#327 id=327 data-nosnippet>327</a></span>}
|
|
<a href=#328 id=328 data-nosnippet>328</a>
|
|
<a href=#329 id=329 data-nosnippet>329</a><span class="doccomment">/// Sends the `loadfile` command to load a file into MPV.
|
|
<a href=#330 id=330 data-nosnippet>330</a>///
|
|
<a href=#331 id=331 data-nosnippet>331</a>/// # Arguments
|
|
<a href=#332 id=332 data-nosnippet>332</a>/// - `filename`: The name of the file to load.
|
|
<a href=#333 id=333 data-nosnippet>333</a>/// - `append`: Whether to append the file to the playlist (`true`) or replace the current file (`false`).
|
|
<a href=#334 id=334 data-nosnippet>334</a>/// - `socket_path`: An optional custom socket path.
|
|
<a href=#335 id=335 data-nosnippet>335</a>///
|
|
<a href=#336 id=336 data-nosnippet>336</a>/// # Returns
|
|
<a href=#337 id=337 data-nosnippet>337</a>/// A `Result` containing the response data.
|
|
<a href=#338 id=338 data-nosnippet>338</a>///
|
|
<a href=#339 id=339 data-nosnippet>339</a>/// # Errors
|
|
<a href=#340 id=340 data-nosnippet>340</a>/// Returns an error if the connection to the socket fails or the command execution encounters issues.
|
|
<a href=#341 id=341 data-nosnippet>341</a></span><span class="kw">pub async fn </span>loadfile(
|
|
<a href=#342 id=342 data-nosnippet>342</a> filename: <span class="kw-2">&</span>str,
|
|
<a href=#343 id=343 data-nosnippet>343</a> append: bool,
|
|
<a href=#344 id=344 data-nosnippet>344</a> socket_path: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>,
|
|
<a href=#345 id=345 data-nosnippet>345</a>) -> io::Result<<span class="prelude-ty">Option</span><Value>> {
|
|
<a href=#346 id=346 data-nosnippet>346</a> <span class="kw">let </span>append_flag = <span class="kw">if </span>append {
|
|
<a href=#347 id=347 data-nosnippet>347</a> <span class="macro">json!</span>(<span class="string">"append-play"</span>)
|
|
<a href=#348 id=348 data-nosnippet>348</a> } <span class="kw">else </span>{
|
|
<a href=#349 id=349 data-nosnippet>349</a> <span class="macro">json!</span>(<span class="string">"replace"</span>)
|
|
<a href=#350 id=350 data-nosnippet>350</a> };
|
|
<a href=#351 id=351 data-nosnippet>351</a> send_ipc_command(
|
|
<a href=#352 id=352 data-nosnippet>352</a> MpvCommand::LoadFile.as_str(),
|
|
<a href=#353 id=353 data-nosnippet>353</a> <span class="kw-2">&</span>[<span class="macro">json!</span>(filename), append_flag],
|
|
<a href=#354 id=354 data-nosnippet>354</a> socket_path,
|
|
<a href=#355 id=355 data-nosnippet>355</a> )
|
|
<a href=#356 id=356 data-nosnippet>356</a> .<span class="kw">await
|
|
<a href=#357 id=357 data-nosnippet>357</a></span>}</code></pre></div></section></main></body></html> |