Skip to content

Commit 7a26ee2

Browse files
author
werwolf2303
committed
Add documentation
1 parent 1a93918 commit 7a26ee2

102 files changed

Lines changed: 18086 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/apidocs/allclasses-index.html‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
<!DOCTYPE HTML>
2+
<html lang>
3+
<head>
4+
<!-- Generated by javadoc (21) on Fri Dec 05 15:36:29 CET 2025 -->
5+
<title>All Classes and Interfaces (mpris-java Nightly API)</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8+
<meta name="dc.created" content="2025-12-05">
9+
<meta name="description" content="class index">
10+
<meta name="generator" content="javadoc/AllClassesIndexWriter">
11+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
13+
<script type="text/javascript" src="script.js"></script>
14+
<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script>
15+
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
16+
</head>
17+
<body class="all-classes-index-page">
18+
<script type="text/javascript">var pathtoroot = "./";
19+
loadScripts(document, 'script');</script>
20+
<noscript>
21+
<div>JavaScript is disabled on your browser.</div>
22+
</noscript>
23+
<div class="flex-box">
24+
<header role="banner" class="flex-header">
25+
<nav role="navigation">
26+
<!-- ========= START OF TOP NAVBAR ======= -->
27+
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
28+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
29+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
30+
<li><a href="index.html">Overview</a></li>
31+
<li>Package</li>
32+
<li>Class</li>
33+
<li>Use</li>
34+
<li><a href="overview-tree.html">Tree</a></li>
35+
<li><a href="index-all.html">Index</a></li>
36+
<li><a href="help-doc.html#all-classes">Help</a></li>
37+
</ul>
38+
</div>
39+
<div class="sub-nav">
40+
<div id="navbar-sub-list"></div>
41+
<div class="nav-list-search"><a href="search.html">SEARCH</a>
42+
<input type="text" id="search-input" disabled placeholder="Search">
43+
<input type="reset" id="reset-button" disabled value="reset">
44+
</div>
45+
</div>
46+
<!-- ========= END OF TOP NAVBAR ========= -->
47+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
48+
</header>
49+
<div class="flex-content">
50+
<main role="main">
51+
<div class="header">
52+
<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
53+
</div>
54+
<div id="all-classes-table">
55+
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab3" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab3', 2)" class="table-tab">Enums</button></div>
56+
<div id="all-classes-table.tabpanel" role="tabpanel" aria-labelledby="all-classes-table-tab0">
57+
<div class="summary-table two-column-summary">
58+
<div class="table-header col-first">Class</div>
59+
<div class="table-header col-last">Description</div>
60+
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/mpris/mpris/DBusProperties.html" title="interface in org.mpris.mpris">DBusProperties</a></div>
61+
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
62+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="org/mpris/mpris/LoopStatus.html" title="enum in org.mpris.mpris">LoopStatus</a></div>
63+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">&nbsp;</div>
64+
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/mpris/mpris/MediaPlayer2.html" title="interface in org.mpris.mpris">MediaPlayer2</a></div>
65+
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
66+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/Metadata.html" title="class in org.mpris">Metadata</a></div>
67+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
68+
<div class="block">A mapping from metadata attribute names to values.</div>
69+
</div>
70+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/Metadata.Builder.html" title="class in org.mpris">Metadata.Builder</a></div>
71+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
72+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/MPRIS.html" title="class in org.mpris">MPRIS</a></div>
73+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
74+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/MPRISBuilder.html" title="class in org.mpris">MPRISBuilder</a></div>
75+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
76+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="org/mpris/MPRISObjectPaths.html" title="enum in org.mpris">MPRISObjectPaths</a></div>
77+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">&nbsp;</div>
78+
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="org/mpris/mpris/PlaybackStatus.html" title="enum in org.mpris.mpris">PlaybackStatus</a></div>
79+
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">&nbsp;</div>
80+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/mpris/mpris/Player.html" title="interface in org.mpris.mpris">Player</a></div>
81+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
82+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/mpris/Player.Seeked.html" title="class in org.mpris.mpris">Player.Seeked</a></div>
83+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
84+
<div class="block">Indicates that the track position has changed in a way that is inconsistant with the current playing state.</div>
85+
</div>
86+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="org/mpris/mpris/PlaylistOrdering.html" title="enum in org.mpris.mpris">PlaylistOrdering</a></div>
87+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
88+
<div class="block">Specifies the ordering of returned playlists.</div>
89+
</div>
90+
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/mpris/mpris/Playlists.html" title="interface in org.mpris.mpris">Playlists</a></div>
91+
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
92+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/mpris/Playlists.Maybe_Playlist.html" title="class in org.mpris.mpris">Playlists.Maybe_Playlist</a></div>
93+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
94+
<div class="block">A data structure describing a playlist, or nothing.</div>
95+
</div>
96+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/mpris/Playlists.Playlist.html" title="class in org.mpris.mpris">Playlists.Playlist</a></div>
97+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
98+
<div class="block">A data structure describing a playlist.</div>
99+
</div>
100+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/mpris/Playlists.PlaylistChanged.html" title="class in org.mpris.mpris">Playlists.PlaylistChanged</a></div>
101+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
102+
<div class="block">Indicates that either the Name or Icon attribute of a playlist has changed.</div>
103+
</div>
104+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/mpris/Playlists.PlaylistSignal.html" title="class in org.mpris.mpris">Playlists.PlaylistSignal</a></div>
105+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
106+
<div class="block">A data signal describing a playlist.</div>
107+
</div>
108+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/PlaylistsImpl.html" title="class in org.mpris">PlaylistsImpl</a></div>
109+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
110+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/PlaylistsImpl.GetPlaylists.html" title="class in org.mpris">PlaylistsImpl.GetPlaylists</a></div>
111+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
112+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/PlaylistsImpl.PlaylistsBuilder.html" title="class in org.mpris">PlaylistsImpl.PlaylistsBuilder</a></div>
113+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
114+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/Position.html" title="class in org.mpris">Position</a></div>
115+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
116+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/mpris/ReturnableTypeRunnable.html" title="interface in org.mpris">ReturnableTypeRunnable&lt;S,<wbr>T&gt;</a></div>
117+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
118+
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/mpris/mpris/TrackList.html" title="interface in org.mpris.mpris">TrackList</a></div>
119+
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
120+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/mpris/TrackList.TrackAdded.html" title="class in org.mpris.mpris">TrackList.TrackAdded</a></div>
121+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
122+
<div class="block">Indicates that a track has been added to the track list.</div>
123+
</div>
124+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/mpris/TrackList.TrackListReplaced.html" title="class in org.mpris.mpris">TrackList.TrackListReplaced</a></div>
125+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
126+
<div class="block">Indicates that the entire tracklist has been replaced.</div>
127+
</div>
128+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/mpris/TrackList.TrackMetadataChanged.html" title="class in org.mpris.mpris">TrackList.TrackMetadataChanged</a></div>
129+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
130+
<div class="block">Indicates that the metadata of a track in the tracklist has changed.</div>
131+
</div>
132+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/mpris/TrackList.TrackRemoved.html" title="class in org.mpris.mpris">TrackList.TrackRemoved</a></div>
133+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
134+
<div class="block">Indicates that a track has been removed from the track list.</div>
135+
</div>
136+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/TrackListImpl.html" title="class in org.mpris">TrackListImpl</a></div>
137+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
138+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/TrackListImpl.AddTrack.html" title="class in org.mpris">TrackListImpl.AddTrack</a></div>
139+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
140+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/mpris/TrackListImpl.TrackListBuilder.html" title="class in org.mpris">TrackListImpl.TrackListBuilder</a></div>
141+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
142+
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/mpris/TypeRunnable.html" title="interface in org.mpris">TypeRunnable&lt;T&gt;</a></div>
143+
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
144+
</div>
145+
</div>
146+
</div>
147+
</main>
148+
<footer role="contentinfo">
149+
<hr>
150+
<p class="legal-copy"><small>Copyright &#169; 2025. All rights reserved.</small></p>
151+
</footer>
152+
</div>
153+
</div>
154+
</body>
155+
</html>

‎docs/apidocs/allpackages-index.html‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<!DOCTYPE HTML>
2+
<html lang>
3+
<head>
4+
<!-- Generated by javadoc (21) on Fri Dec 05 15:36:29 CET 2025 -->
5+
<title>All Packages (mpris-java Nightly API)</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8+
<meta name="dc.created" content="2025-12-05">
9+
<meta name="description" content="package index">
10+
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
11+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
13+
<script type="text/javascript" src="script.js"></script>
14+
<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script>
15+
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
16+
</head>
17+
<body class="all-packages-index-page">
18+
<script type="text/javascript">var pathtoroot = "./";
19+
loadScripts(document, 'script');</script>
20+
<noscript>
21+
<div>JavaScript is disabled on your browser.</div>
22+
</noscript>
23+
<div class="flex-box">
24+
<header role="banner" class="flex-header">
25+
<nav role="navigation">
26+
<!-- ========= START OF TOP NAVBAR ======= -->
27+
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
28+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
29+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
30+
<li><a href="index.html">Overview</a></li>
31+
<li>Package</li>
32+
<li>Class</li>
33+
<li>Use</li>
34+
<li><a href="overview-tree.html">Tree</a></li>
35+
<li><a href="index-all.html">Index</a></li>
36+
<li><a href="help-doc.html#all-packages">Help</a></li>
37+
</ul>
38+
</div>
39+
<div class="sub-nav">
40+
<div id="navbar-sub-list"></div>
41+
<div class="nav-list-search"><a href="search.html">SEARCH</a>
42+
<input type="text" id="search-input" disabled placeholder="Search">
43+
<input type="reset" id="reset-button" disabled value="reset">
44+
</div>
45+
</div>
46+
<!-- ========= END OF TOP NAVBAR ========= -->
47+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
48+
</header>
49+
<div class="flex-content">
50+
<main role="main">
51+
<div class="header">
52+
<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
53+
</div>
54+
<div class="caption"><span>Package Summary</span></div>
55+
<div class="summary-table two-column-summary">
56+
<div class="table-header col-first">Package</div>
57+
<div class="table-header col-last">Description</div>
58+
<div class="col-first even-row-color"><a href="org/mpris/package-summary.html">org.mpris</a></div>
59+
<div class="col-last even-row-color">
60+
<div class="block">Implementation classes for using MPRIS</div>
61+
</div>
62+
<div class="col-first odd-row-color"><a href="org/mpris/mpris/package-summary.html">org.mpris.mpris</a></div>
63+
<div class="col-last odd-row-color">
64+
<div class="block">Up to spec interfaces describing MPRIS</div>
65+
</div>
66+
</div>
67+
</main>
68+
<footer role="contentinfo">
69+
<hr>
70+
<p class="legal-copy"><small>Copyright &#169; 2025. All rights reserved.</small></p>
71+
</footer>
72+
</div>
73+
</div>
74+
</body>
75+
</html>

‎docs/apidocs/copy.svg‎

Lines changed: 33 additions & 0 deletions
Loading

‎docs/apidocs/element-list‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
org.mpris
2+
org.mpris.mpris

0 commit comments

Comments
 (0)