Skip to content

Commit

Permalink
Update Javadoc from d13759a
Browse files Browse the repository at this point in the history
  • Loading branch information
Mindgamesnl committed Feb 1, 2025
1 parent a5658f2 commit 077ae26
Show file tree
Hide file tree
Showing 166 changed files with 612 additions and 525 deletions.
6 changes: 3 additions & 3 deletions javadoc/allclasses-index.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) on Tue Jan 21 20:32:02 UTC 2025 -->
<title>All Classes and Interfaces (openaudiomc-api 6.10.8 API)</title>
<!-- Generated by javadoc (17) on Sat Feb 01 21:05:45 UTC 2025 -->
<title>All Classes and Interfaces (openaudiomc-api 6.10.9 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2025-01-21">
<meta name="dc.created" content="2025-02-01">
<meta name="description" content="class index">
<meta name="generator" content="javadoc/AllClassesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down
6 changes: 3 additions & 3 deletions javadoc/allpackages-index.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) on Tue Jan 21 20:32:02 UTC 2025 -->
<title>All Packages (openaudiomc-api 6.10.8 API)</title>
<!-- Generated by javadoc (17) on Sat Feb 01 21:05:45 UTC 2025 -->
<title>All Packages (openaudiomc-api 6.10.9 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2025-01-21">
<meta name="dc.created" content="2025-02-01">
<meta name="description" content="package index">
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down
6 changes: 3 additions & 3 deletions javadoc/com/craftmend/openaudiomc/api/ApiHolder.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) on Tue Jan 21 20:32:02 UTC 2025 -->
<title>ApiHolder (openaudiomc-api 6.10.8 API)</title>
<!-- Generated by javadoc (17) on Sat Feb 01 21:05:45 UTC 2025 -->
<title>ApiHolder (openaudiomc-api 6.10.9 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2025-01-21">
<meta name="dc.created" content="2025-02-01">
<meta name="description" content="declaration: package: com.craftmend.openaudiomc.api, class: ApiHolder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down
6 changes: 3 additions & 3 deletions javadoc/com/craftmend/openaudiomc/api/ClientApi.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) on Tue Jan 21 20:32:02 UTC 2025 -->
<title>ClientApi (openaudiomc-api 6.10.8 API)</title>
<!-- Generated by javadoc (17) on Sat Feb 01 21:05:45 UTC 2025 -->
<title>ClientApi (openaudiomc-api 6.10.9 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2025-01-21">
<meta name="dc.created" content="2025-02-01">
<meta name="description" content="declaration: package: com.craftmend.openaudiomc.api, interface: ClientApi">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down
6 changes: 3 additions & 3 deletions javadoc/com/craftmend/openaudiomc/api/EventApi.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) on Tue Jan 21 20:32:02 UTC 2025 -->
<title>EventApi (openaudiomc-api 6.10.8 API)</title>
<!-- Generated by javadoc (17) on Sat Feb 01 21:05:45 UTC 2025 -->
<title>EventApi (openaudiomc-api 6.10.9 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2025-01-21">
<meta name="dc.created" content="2025-02-01">
<meta name="description" content="declaration: package: com.craftmend.openaudiomc.api, interface: EventApi">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down
6 changes: 3 additions & 3 deletions javadoc/com/craftmend/openaudiomc/api/MediaApi.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) on Tue Jan 21 20:32:02 UTC 2025 -->
<title>MediaApi (openaudiomc-api 6.10.8 API)</title>
<!-- Generated by javadoc (17) on Sat Feb 01 21:05:45 UTC 2025 -->
<title>MediaApi (openaudiomc-api 6.10.9 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2025-01-21">
<meta name="dc.created" content="2025-02-01">
<meta name="description" content="declaration: package: com.craftmend.openaudiomc.api, interface: MediaApi">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down
76 changes: 68 additions & 8 deletions javadoc/com/craftmend/openaudiomc/api/VoiceApi.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) on Tue Jan 21 20:32:02 UTC 2025 -->
<title>VoiceApi (openaudiomc-api 6.10.8 API)</title>
<!-- Generated by javadoc (17) on Sat Feb 01 21:05:45 UTC 2025 -->
<title>VoiceApi (openaudiomc-api 6.10.9 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2025-01-21">
<meta name="dc.created" content="2025-02-01">
<meta name="description" content="declaration: package: com.craftmend.openaudiomc.api, interface: VoiceApi">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down Expand Up @@ -165,18 +165,33 @@ <h2>Method Summary</h2>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Check if a channel name is valid</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#removeStaticPeer(com.craftmend.openaudiomc.api.clients.Client,com.craftmend.openaudiomc.api.clients.Client,boolean)" class="member-name-link">removeStaticPeer</a><wbr>(<a href="clients/Client.html" title="interface in com.craftmend.openaudiomc.api.clients">Client</a>&nbsp;client,
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isClientModerating(com.craftmend.openaudiomc.api.clients.Client)" class="member-name-link">isClientModerating</a><wbr>(<a href="clients/Client.html" title="interface in com.craftmend.openaudiomc.api.clients">Client</a>&nbsp;client)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Check if a client has voicechat moderation enabled</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#removeStaticPeer(com.craftmend.openaudiomc.api.clients.Client,com.craftmend.openaudiomc.api.clients.Client,boolean)" class="member-name-link">removeStaticPeer</a><wbr>(<a href="clients/Client.html" title="interface in com.craftmend.openaudiomc.api.clients">Client</a>&nbsp;client,
<a href="clients/Client.html" title="interface in com.craftmend.openaudiomc.api.clients">Client</a>&nbsp;peerToRemove,
boolean&nbsp;mutual)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Remove a global peer from someone's voice chat.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#startClientModeration(com.craftmend.openaudiomc.api.clients.Client)" class="member-name-link">startClientModeration</a><wbr>(<a href="clients/Client.html" title="interface in com.craftmend.openaudiomc.api.clients">Client</a>&nbsp;client)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Start a moderation session for a client, bypassing permission checks.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#updatePeerOptions(com.craftmend.openaudiomc.api.clients.Client,com.craftmend.openaudiomc.api.clients.Client,com.craftmend.openaudiomc.api.voice.VoicePeerOptions)" class="member-name-link">updatePeerOptions</a><wbr>(<a href="clients/Client.html" title="interface in com.craftmend.openaudiomc.api.clients">Client</a>&nbsp;client,
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#stopClientModeration(com.craftmend.openaudiomc.api.clients.Client)" class="member-name-link">stopClientModeration</a><wbr>(<a href="clients/Client.html" title="interface in com.craftmend.openaudiomc.api.clients">Client</a>&nbsp;client)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Stop a moderation session for a client</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#updatePeerOptions(com.craftmend.openaudiomc.api.clients.Client,com.craftmend.openaudiomc.api.clients.Client,com.craftmend.openaudiomc.api.voice.VoicePeerOptions)" class="member-name-link">updatePeerOptions</a><wbr>(<a href="clients/Client.html" title="interface in com.craftmend.openaudiomc.api.clients">Client</a>&nbsp;client,
<a href="clients/Client.html" title="interface in com.craftmend.openaudiomc.api.clients">Client</a>&nbsp;peerToUpdate,
<a href="voice/VoicePeerOptions.html" title="class in com.craftmend.openaudiomc.api.voice">VoicePeerOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Push new options for a peer, changing how its rendered in the client</div>
</div>
</div>
Expand Down Expand Up @@ -421,6 +436,51 @@ <h3>isChannelNameValid</h3>
</dl>
</section>
</li>
<li>
<section class="detail" id="isClientModerating(com.craftmend.openaudiomc.api.clients.Client)">
<h3>isClientModerating</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isClientModerating</span><wbr><span class="parameters">(<a href="clients/Client.html" title="interface in com.craftmend.openaudiomc.api.clients">Client</a>&nbsp;client)</span></div>
<div class="block">Check if a client has voicechat moderation enabled</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>client</code> - the client to check</dd>
<dt>Returns:</dt>
<dd>true if the client has moderation enabled</dd>
<dt>Since:</dt>
<dd>6.10.9</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="startClientModeration(com.craftmend.openaudiomc.api.clients.Client)">
<h3>startClientModeration</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">startClientModeration</span><wbr><span class="parameters">(<a href="clients/Client.html" title="interface in com.craftmend.openaudiomc.api.clients">Client</a>&nbsp;client)</span></div>
<div class="block">Start a moderation session for a client, bypassing permission checks.
Moderation will still have to be enabled in the config, otherwise this method will return false and do nothing.
Moderation mode isn't permanent, it will only last for the duration you have configured in the config, but you can call this method again to extend the duration.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>client</code> - the client to enable or disable moderation for</dd>
<dt>Returns:</dt>
<dd>true if the client is now moderating</dd>
<dt>Since:</dt>
<dd>6.10.9</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="stopClientModeration(com.craftmend.openaudiomc.api.clients.Client)">
<h3>stopClientModeration</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">stopClientModeration</span><wbr><span class="parameters">(<a href="clients/Client.html" title="interface in com.craftmend.openaudiomc.api.clients">Client</a>&nbsp;client)</span></div>
<div class="block">Stop a moderation session for a client</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>client</code> - the client to stop moderation for</dd>
<dt>Since:</dt>
<dd>6.10.9</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
Expand Down
6 changes: 3 additions & 3 deletions javadoc/com/craftmend/openaudiomc/api/WorldApi.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) on Tue Jan 21 20:32:02 UTC 2025 -->
<title>WorldApi (openaudiomc-api 6.10.8 API)</title>
<!-- Generated by javadoc (17) on Sat Feb 01 21:05:45 UTC 2025 -->
<title>WorldApi (openaudiomc-api 6.10.9 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2025-01-21">
<meta name="dc.created" content="2025-02-01">
<meta name="description" content="declaration: package: com.craftmend.openaudiomc.api, interface: WorldApi">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Expand Down
6 changes: 3 additions & 3 deletions javadoc/com/craftmend/openaudiomc/api/basic/Actor.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) on Tue Jan 21 20:32:02 UTC 2025 -->
<title>Actor (openaudiomc-api 6.10.8 API)</title>
<!-- Generated by javadoc (17) on Sat Feb 01 21:05:45 UTC 2025 -->
<title>Actor (openaudiomc-api 6.10.9 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2025-01-21">
<meta name="dc.created" content="2025-02-01">
<meta name="description" content="declaration: package: com.craftmend.openaudiomc.api.basic, interface: Actor">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) on Tue Jan 21 20:32:02 UTC 2025 -->
<title>Uses of Interface com.craftmend.openaudiomc.api.basic.Actor (openaudiomc-api 6.10.8 API)</title>
<!-- Generated by javadoc (17) on Sat Feb 01 21:05:45 UTC 2025 -->
<title>Uses of Interface com.craftmend.openaudiomc.api.basic.Actor (openaudiomc-api 6.10.9 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2025-01-21">
<meta name="dc.created" content="2025-02-01">
<meta name="description" content="use: package: com.craftmend.openaudiomc.api.basic, interface: Actor">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) on Tue Jan 21 20:32:02 UTC 2025 -->
<title>com.craftmend.openaudiomc.api.basic (openaudiomc-api 6.10.8 API)</title>
<!-- Generated by javadoc (17) on Sat Feb 01 21:05:45 UTC 2025 -->
<title>com.craftmend.openaudiomc.api.basic (openaudiomc-api 6.10.9 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2025-01-21">
<meta name="dc.created" content="2025-02-01">
<meta name="description" content="declaration: package: com.craftmend.openaudiomc.api.basic">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
Expand Down
6 changes: 3 additions & 3 deletions javadoc/com/craftmend/openaudiomc/api/basic/package-tree.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) on Tue Jan 21 20:32:02 UTC 2025 -->
<title>com.craftmend.openaudiomc.api.basic Class Hierarchy (openaudiomc-api 6.10.8 API)</title>
<!-- Generated by javadoc (17) on Sat Feb 01 21:05:45 UTC 2025 -->
<title>com.craftmend.openaudiomc.api.basic Class Hierarchy (openaudiomc-api 6.10.9 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2025-01-21">
<meta name="dc.created" content="2025-02-01">
<meta name="description" content="tree: package: com.craftmend.openaudiomc.api.basic">
<meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
Expand Down
6 changes: 3 additions & 3 deletions javadoc/com/craftmend/openaudiomc/api/basic/package-use.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) on Tue Jan 21 20:32:02 UTC 2025 -->
<title>Uses of Package com.craftmend.openaudiomc.api.basic (openaudiomc-api 6.10.8 API)</title>
<!-- Generated by javadoc (17) on Sat Feb 01 21:05:45 UTC 2025 -->
<title>Uses of Package com.craftmend.openaudiomc.api.basic (openaudiomc-api 6.10.9 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2025-01-21">
<meta name="dc.created" content="2025-02-01">
<meta name="description" content="use: package: com.craftmend.openaudiomc.api.basic">
<meta name="generator" content="javadoc/PackageUseWriter">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) on Tue Jan 21 20:32:02 UTC 2025 -->
<title>ChannelJoinResponse (openaudiomc-api 6.10.8 API)</title>
<!-- Generated by javadoc (17) on Sat Feb 01 21:05:45 UTC 2025 -->
<title>ChannelJoinResponse (openaudiomc-api 6.10.9 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2025-01-21">
<meta name="dc.created" content="2025-02-01">
<meta name="description" content="declaration: package: com.craftmend.openaudiomc.api.channels, enum: ChannelJoinResponse">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (17) on Tue Jan 21 20:32:02 UTC 2025 -->
<title>VoiceChannel (openaudiomc-api 6.10.8 API)</title>
<!-- Generated by javadoc (17) on Sat Feb 01 21:05:45 UTC 2025 -->
<title>VoiceChannel (openaudiomc-api 6.10.9 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2025-01-21">
<meta name="dc.created" content="2025-02-01">
<meta name="description" content="declaration: package: com.craftmend.openaudiomc.api.channels, interface: VoiceChannel">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
Expand Down
Loading

0 comments on commit 077ae26

Please sign in to comment.