Skip to content

Commit

Permalink
Doc update (#596)
Browse files Browse the repository at this point in the history
* Update doc
  • Loading branch information
bjason authored Dec 21, 2023
1 parent 5191ad1 commit c8e4fda
Show file tree
Hide file tree
Showing 38 changed files with 587 additions and 18 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## [0.19.0] - 2023-12-19
## [0.19.0] - 2023-12-20

### Added

Expand Down
8 changes: 8 additions & 0 deletions docs/amazon-chime-sdk/alltypes/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,9 @@ <h5><a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-meeting-eve
that is needed for <a href="../com.amazonaws.services.chime.sdk.meetings.ingestion/-default-event-reporter/index.html">DefaultEventReporter</a></p>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.session/-meeting-features/index.html">com.amazonaws.services.chime.sdk.meetings.session.MeetingFeatures</a></h5>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-meeting-history-event/index.html">com.amazonaws.services.chime.sdk.meetings.analytics.MeetingHistoryEvent</a></h5>
</tr>
<tr>
Expand Down Expand Up @@ -460,6 +463,11 @@ <h5><a href="../com.amazonaws.services.chime.sdk.meetings.audiovideo.video/-remo
or the configuration may or may not be updated.</p>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture/-screen-capture-resolution-calculator/index.html">com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.ScreenCaptureResolutionCalculator</a></h5>
<p><a href="../com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture/-screen-capture-resolution-calculator/index.html">ScreenCaptureResolutionCalculator</a> calculates scaled resolution based on input resolution
and target resolution constraint</p>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.audiovideo.video.backgroundfilter/-segmentation-processor/index.html">com.amazonaws.services.chime.sdk.meetings.audiovideo.video.backgroundfilter.SegmentationProcessor</a></h5>
<p><a href="../com.amazonaws.services.chime.sdk.meetings.audiovideo.video.backgroundfilter/-segmentation-processor/index.html">SegmentationProcessor</a> predicts foreground mask for an image.</p>
</tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,15 @@ <h4><a href="remove-video-sink.html">removeVideoSink</a></h4>
</tr>
<tr>
<td>
<h4><a href="set-max-resolution.html">setMaxResolution</a></h4>
</td>
<td>
<p>Set max resolution for video capture source
DefaultCameraCaptureSource and DefaultScreenCaptureSource call this function to set max resolution for camera and screen capture</p>
<code><span class="keyword">fun </span><span class="identifier">setMaxResolution</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.DefaultCameraCaptureSource$setMaxResolution(com.amazonaws.services.chime.sdk.meetings.audiovideo.video.VideoResolution)/maxResolution">maxResolution</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.audiovideo.video/-video-resolution/index.html"><span class="identifier">VideoResolution</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code></td>
</tr>
<tr>
<td>
<h4><a href="start.html">start</a></h4>
</td>
<td>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DefaultCameraCaptureSource.setMaxResolution - amazon-chime-sdk</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">amazon-chime-sdk</a>&nbsp;/&nbsp;<a href="../index.html">com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture</a>&nbsp;/&nbsp;<a href="index.html">DefaultCameraCaptureSource</a>&nbsp;/&nbsp;<a href="./set-max-resolution.html">setMaxResolution</a><br/>
<br/>
<h1>setMaxResolution</h1>
<a name="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.DefaultCameraCaptureSource$setMaxResolution(com.amazonaws.services.chime.sdk.meetings.audiovideo.video.VideoResolution)"></a>
<code><span class="keyword">fun </span><span class="identifier">setMaxResolution</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.DefaultCameraCaptureSource$setMaxResolution(com.amazonaws.services.chime.sdk.meetings.audiovideo.video.VideoResolution)/maxResolution">maxResolution</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.audiovideo.video/-video-resolution/index.html"><span class="identifier">VideoResolution</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
<p>Set max resolution for video capture source
DefaultCameraCaptureSource and DefaultScreenCaptureSource call this function to set max resolution for camera and screen capture</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,15 @@ <h4><a href="remove-video-sink.html">removeVideoSink</a></h4>
</tr>
<tr>
<td>
<h4><a href="set-max-resolution.html">setMaxResolution</a></h4>
</td>
<td>
<p>Set max resolution for video capture source
DefaultCameraCaptureSource and DefaultScreenCaptureSource call this function to set max resolution for camera and screen capture</p>
<code><span class="keyword">fun </span><span class="identifier">setMaxResolution</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.DefaultScreenCaptureSource$setMaxResolution(com.amazonaws.services.chime.sdk.meetings.audiovideo.video.VideoResolution)/maxResolution">maxResolution</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.audiovideo.video/-video-resolution/index.html"><span class="identifier">VideoResolution</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code></td>
</tr>
<tr>
<td>
<h4><a href="start.html">start</a></h4>
</td>
<td>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DefaultScreenCaptureSource.setMaxResolution - amazon-chime-sdk</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">amazon-chime-sdk</a>&nbsp;/&nbsp;<a href="../index.html">com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture</a>&nbsp;/&nbsp;<a href="index.html">DefaultScreenCaptureSource</a>&nbsp;/&nbsp;<a href="./set-max-resolution.html">setMaxResolution</a><br/>
<br/>
<h1>setMaxResolution</h1>
<a name="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.DefaultScreenCaptureSource$setMaxResolution(com.amazonaws.services.chime.sdk.meetings.audiovideo.video.VideoResolution)"></a>
<code><span class="keyword">fun </span><span class="identifier">setMaxResolution</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.DefaultScreenCaptureSource$setMaxResolution(com.amazonaws.services.chime.sdk.meetings.audiovideo.video.VideoResolution)/maxResolution">maxResolution</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.audiovideo.video/-video-resolution/index.html"><span class="identifier">VideoResolution</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
<p>Set max resolution for video capture source
DefaultCameraCaptureSource and DefaultScreenCaptureSource call this function to set max resolution for camera and screen capture</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,15 @@ <h4><a href="remove-video-sink.html">removeVideoSink</a></h4>
</tr>
<tr>
<td>
<h4><a href="set-max-resolution.html">setMaxResolution</a></h4>
</td>
<td>
<p>Set max resolution for video capture source
DefaultCameraCaptureSource and DefaultScreenCaptureSource call this function to set max resolution for camera and screen capture</p>
<code><span class="keyword">fun </span><span class="identifier">setMaxResolution</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.DefaultSurfaceTextureCaptureSource$setMaxResolution(com.amazonaws.services.chime.sdk.meetings.audiovideo.video.VideoResolution)/maxResolution">maxResolution</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.audiovideo.video/-video-resolution/index.html"><span class="identifier">VideoResolution</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code></td>
</tr>
<tr>
<td>
<h4><a href="start.html">start</a></h4>
</td>
<td>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DefaultSurfaceTextureCaptureSource.setMaxResolution - amazon-chime-sdk</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">amazon-chime-sdk</a>&nbsp;/&nbsp;<a href="../index.html">com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture</a>&nbsp;/&nbsp;<a href="index.html">DefaultSurfaceTextureCaptureSource</a>&nbsp;/&nbsp;<a href="./set-max-resolution.html">setMaxResolution</a><br/>
<br/>
<h1>setMaxResolution</h1>
<a name="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.DefaultSurfaceTextureCaptureSource$setMaxResolution(com.amazonaws.services.chime.sdk.meetings.audiovideo.video.VideoResolution)"></a>
<code><span class="keyword">fun </span><span class="identifier">setMaxResolution</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.DefaultSurfaceTextureCaptureSource$setMaxResolution(com.amazonaws.services.chime.sdk.meetings.audiovideo.video.VideoResolution)/maxResolution">maxResolution</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.audiovideo.video/-video-resolution/index.html"><span class="identifier">VideoResolution</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
<p>Set max resolution for video capture source
DefaultCameraCaptureSource and DefaultScreenCaptureSource call this function to set max resolution for camera and screen capture</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>ScreenCaptureResolutionCalculator.<init> - amazon-chime-sdk</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">amazon-chime-sdk</a>&nbsp;/&nbsp;<a href="../index.html">com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture</a>&nbsp;/&nbsp;<a href="index.html">ScreenCaptureResolutionCalculator</a>&nbsp;/&nbsp;<a href="./-init-.html">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<a name="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.ScreenCaptureResolutionCalculator$&lt;init&gt;()"></a>
<code><span class="identifier">ScreenCaptureResolutionCalculator</span><span class="symbol">(</span><span class="symbol">)</span></code>
<p><a href="index.html">ScreenCaptureResolutionCalculator</a> calculates scaled resolution based on input resolution
and target resolution constraint</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>ScreenCaptureResolutionCalculator.alignToEven - amazon-chime-sdk</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">amazon-chime-sdk</a>&nbsp;/&nbsp;<a href="../index.html">com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture</a>&nbsp;/&nbsp;<a href="index.html">ScreenCaptureResolutionCalculator</a>&nbsp;/&nbsp;<a href="./align-to-even.html">alignToEven</a><br/>
<br/>
<h1>alignToEven</h1>
<a name="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.ScreenCaptureResolutionCalculator$alignToEven(kotlin.Int)"></a>
<code><span class="keyword">fun </span><span class="identifier">alignToEven</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.ScreenCaptureResolutionCalculator$alignToEven(kotlin.Int)/positiveNumber">positiveNumber</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>ScreenCaptureResolutionCalculator.computeTargetSize - amazon-chime-sdk</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">amazon-chime-sdk</a>&nbsp;/&nbsp;<a href="../index.html">com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture</a>&nbsp;/&nbsp;<a href="index.html">ScreenCaptureResolutionCalculator</a>&nbsp;/&nbsp;<a href="./compute-target-size.html">computeTargetSize</a><br/>
<br/>
<h1>computeTargetSize</h1>
<a name="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.ScreenCaptureResolutionCalculator$computeTargetSize(kotlin.Int, kotlin.Int, kotlin.Int, kotlin.Int)"></a>
<code><span class="keyword">fun </span><span class="identifier">computeTargetSize</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.ScreenCaptureResolutionCalculator$computeTargetSize(kotlin.Int, kotlin.Int, kotlin.Int, kotlin.Int)/displayWidth">displayWidth</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.ScreenCaptureResolutionCalculator$computeTargetSize(kotlin.Int, kotlin.Int, kotlin.Int, kotlin.Int)/displayHeight">displayHeight</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.ScreenCaptureResolutionCalculator$computeTargetSize(kotlin.Int, kotlin.Int, kotlin.Int, kotlin.Int)/targetResolutionLong">targetResolutionLong</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.ScreenCaptureResolutionCalculator$computeTargetSize(kotlin.Int, kotlin.Int, kotlin.Int, kotlin.Int)/targetResolutionShort">targetResolutionShort</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html"><span class="identifier">IntArray</span></a></code>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>ScreenCaptureResolutionCalculator - amazon-chime-sdk</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">amazon-chime-sdk</a>&nbsp;/&nbsp;<a href="../index.html">com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture</a>&nbsp;/&nbsp;<a href="./index.html">ScreenCaptureResolutionCalculator</a><br/>
<br/>
<h1>ScreenCaptureResolutionCalculator</h1>
<code><span class="keyword">class </span><span class="identifier">ScreenCaptureResolutionCalculator</span></code>
<p><a href="./index.html">ScreenCaptureResolutionCalculator</a> calculates scaled resolution based on input resolution
and target resolution constraint</p>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<h4><a href="-init-.html">&lt;init&gt;</a></h4>
</td>
<td>
<p><a href="./index.html">ScreenCaptureResolutionCalculator</a> calculates scaled resolution based on input resolution
and target resolution constraint</p>
<code><span class="identifier">ScreenCaptureResolutionCalculator</span><span class="symbol">(</span><span class="symbol">)</span></code></td>
</tr>
</tbody>
</table>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
<h4><a href="align-to-even.html">alignToEven</a></h4>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">alignToEven</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.ScreenCaptureResolutionCalculator$alignToEven(kotlin.Int)/positiveNumber">positiveNumber</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a></code></td>
</tr>
<tr>
<td>
<h4><a href="compute-target-size.html">computeTargetSize</a></h4>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">computeTargetSize</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.ScreenCaptureResolutionCalculator$computeTargetSize(kotlin.Int, kotlin.Int, kotlin.Int, kotlin.Int)/displayWidth">displayWidth</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.ScreenCaptureResolutionCalculator$computeTargetSize(kotlin.Int, kotlin.Int, kotlin.Int, kotlin.Int)/displayHeight">displayHeight</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.ScreenCaptureResolutionCalculator$computeTargetSize(kotlin.Int, kotlin.Int, kotlin.Int, kotlin.Int)/targetResolutionLong">targetResolutionLong</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.ScreenCaptureResolutionCalculator$computeTargetSize(kotlin.Int, kotlin.Int, kotlin.Int, kotlin.Int)/targetResolutionShort">targetResolutionShort</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html"><span class="identifier">IntArray</span></a></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>
Loading

0 comments on commit c8e4fda

Please sign in to comment.