Skip to content

Commit

Permalink
Update doc to 0.12.0 (#324)
Browse files Browse the repository at this point in the history
  • Loading branch information
hokyungh authored Sep 2, 2021
1 parent 9bf2c32 commit b1e035e
Show file tree
Hide file tree
Showing 10 changed files with 27 additions and 15 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Unreleased
## [0.12.0] - 2021-09-02

### Added
* [Demo] Added binding to screen share service to avoid condition where screen share starts before service.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@
<h1>ConfigurationFailure</h1>
<a name="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.capture.CaptureSourceError.ConfigurationFailure"></a>
<code><span class="identifier">ConfigurationFailure</span></code>
<p>A failure observer during configuration</p>
<p>A failure observed during configuration</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ <h4><a href="-system-failure.html">SystemFailure</a></h4>
<h4><a href="-configuration-failure.html">ConfigurationFailure</a></h4>
</td>
<td>
<p>A failure observer during configuration</p>
<p>A failure observed during configuration</p>
</td>
</tr>
</tbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,11 @@ <h1>&lt;init&gt;</h1>
<p>Builders will need to get permission from users to obtain the <a href="#">activityResultCode</a> and <a href="#">activityData</a> arguments,
required to create an internal <a href="https://developer.android.com/reference/android/media/projection/MediaProjection.html">MediaProjection</a> object.
Read <a href="https://github.com/aws/amazon-chime-sdk-android/blob/master/guides/content_share.md">content share guide</a> for more information.</p>
<p>Note that you must finish starting the foreground service before calling start. Otherwise start
will fail to succeed despite having the user grant permission and despite having created
a foreground service for the <a href="https://developer.android.com/reference/android/media/projection/MediaProjection.html">MediaProjection</a>. <a href="../-capture-source-observer/on-capture-failed.html">CaptureSourceObserver.onCaptureFailed</a> will be
called with <a href="../-capture-source-error/-system-failure.html">CaptureSourceError.SystemFailure</a> in this case.</p>
<p>If the <a href="https://developer.android.com/reference/android/media/projection/MediaProjection.html">MediaProjection</a> could not be obtained with the <a href="#">activityResultCode</a> and <a href="#">activityData</a>,
<a href="../-capture-source-observer/on-capture-failed.html">CaptureSourceObserver.onCaptureFailed</a> will be called with <a href="../-capture-source-error/-configuration-failure.html">CaptureSourceError.ConfigurationFailure</a>.</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ <h1>DefaultScreenCaptureSource</h1>
<p>Builders will need to get permission from users to obtain the <a href="#">activityResultCode</a> and <a href="#">activityData</a> arguments,
required to create an internal <a href="https://developer.android.com/reference/android/media/projection/MediaProjection.html">MediaProjection</a> object.
Read <a href="https://github.com/aws/amazon-chime-sdk-android/blob/master/guides/content_share.md">content share guide</a> for more information.</p>
<p>Note that you must finish starting the foreground service before calling start. Otherwise start
will fail to succeed despite having the user grant permission and despite having created
a foreground service for the <a href="https://developer.android.com/reference/android/media/projection/MediaProjection.html">MediaProjection</a>. <a href="../-capture-source-observer/on-capture-failed.html">CaptureSourceObserver.onCaptureFailed</a> will be
called with <a href="../-capture-source-error/-system-failure.html">CaptureSourceError.SystemFailure</a> in this case.</p>
<p>If the <a href="https://developer.android.com/reference/android/media/projection/MediaProjection.html">MediaProjection</a> could not be obtained with the <a href="#">activityResultCode</a> and <a href="#">activityData</a>,
<a href="../-capture-source-observer/on-capture-failed.html">CaptureSourceObserver.onCaptureFailed</a> will be called with <a href="../-capture-source-error/-configuration-failure.html">CaptureSourceError.ConfigurationFailure</a>.</p>
<h3>Constructors</h3>
<table>
<tbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,21 +113,21 @@ <h4><a href="release.html">release</a></h4>
<h4><a href="surface-changed.html">surfaceChanged</a></h4>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">surfaceChanged</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceChanged(android.view.SurfaceHolder, kotlin.Int, kotlin.Int, kotlin.Int)/holder">holder</span><span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/view/SurfaceHolder.html"><span class="identifier">SurfaceHolder</span></a><span class="symbol">?</span><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceChanged(android.view.SurfaceHolder, kotlin.Int, kotlin.Int, kotlin.Int)/format">format</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.gl.SurfaceRenderView$surfaceChanged(android.view.SurfaceHolder, kotlin.Int, kotlin.Int, kotlin.Int)/width">width</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.gl.SurfaceRenderView$surfaceChanged(android.view.SurfaceHolder, kotlin.Int, kotlin.Int, kotlin.Int)/height">height</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/-unit/index.html"><span class="identifier">Unit</span></a></code></td>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">surfaceChanged</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceChanged(android.view.SurfaceHolder, kotlin.Int, kotlin.Int, kotlin.Int)/holder">holder</span><span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/view/SurfaceHolder.html"><span class="identifier">SurfaceHolder</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceChanged(android.view.SurfaceHolder, kotlin.Int, kotlin.Int, kotlin.Int)/format">format</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.gl.SurfaceRenderView$surfaceChanged(android.view.SurfaceHolder, kotlin.Int, kotlin.Int, kotlin.Int)/width">width</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.gl.SurfaceRenderView$surfaceChanged(android.view.SurfaceHolder, kotlin.Int, kotlin.Int, kotlin.Int)/height">height</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/-unit/index.html"><span class="identifier">Unit</span></a></code></td>
</tr>
<tr>
<td>
<h4><a href="surface-created.html">surfaceCreated</a></h4>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">surfaceCreated</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceCreated(android.view.SurfaceHolder)/holder">holder</span><span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/view/SurfaceHolder.html"><span class="identifier">SurfaceHolder</span></a><span class="symbol">?</span><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>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">surfaceCreated</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceCreated(android.view.SurfaceHolder)/holder">holder</span><span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/view/SurfaceHolder.html"><span class="identifier">SurfaceHolder</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="surface-destroyed.html">surfaceDestroyed</a></h4>
</td>
<td>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">surfaceDestroyed</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceDestroyed(android.view.SurfaceHolder)/holder">holder</span><span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/view/SurfaceHolder.html"><span class="identifier">SurfaceHolder</span></a><span class="symbol">?</span><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>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">surfaceDestroyed</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceDestroyed(android.view.SurfaceHolder)/holder">holder</span><span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/view/SurfaceHolder.html"><span class="identifier">SurfaceHolder</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>
</tbody>
</table>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@
<br/>
<h1>surfaceChanged</h1>
<a name="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceChanged(android.view.SurfaceHolder, kotlin.Int, kotlin.Int, kotlin.Int)"></a>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">surfaceChanged</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceChanged(android.view.SurfaceHolder, kotlin.Int, kotlin.Int, kotlin.Int)/holder">holder</span><span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/view/SurfaceHolder.html"><span class="identifier">SurfaceHolder</span></a><span class="symbol">?</span><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceChanged(android.view.SurfaceHolder, kotlin.Int, kotlin.Int, kotlin.Int)/format">format</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.gl.SurfaceRenderView$surfaceChanged(android.view.SurfaceHolder, kotlin.Int, kotlin.Int, kotlin.Int)/width">width</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.gl.SurfaceRenderView$surfaceChanged(android.view.SurfaceHolder, kotlin.Int, kotlin.Int, kotlin.Int)/height">height</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/-unit/index.html"><span class="identifier">Unit</span></a></code>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">surfaceChanged</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceChanged(android.view.SurfaceHolder, kotlin.Int, kotlin.Int, kotlin.Int)/holder">holder</span><span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/view/SurfaceHolder.html"><span class="identifier">SurfaceHolder</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceChanged(android.view.SurfaceHolder, kotlin.Int, kotlin.Int, kotlin.Int)/format">format</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.gl.SurfaceRenderView$surfaceChanged(android.view.SurfaceHolder, kotlin.Int, kotlin.Int, kotlin.Int)/width">width</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.gl.SurfaceRenderView$surfaceChanged(android.view.SurfaceHolder, kotlin.Int, kotlin.Int, kotlin.Int)/height">height</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/-unit/index.html"><span class="identifier">Unit</span></a></code>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@
<br/>
<h1>surfaceCreated</h1>
<a name="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceCreated(android.view.SurfaceHolder)"></a>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">surfaceCreated</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceCreated(android.view.SurfaceHolder)/holder">holder</span><span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/view/SurfaceHolder.html"><span class="identifier">SurfaceHolder</span></a><span class="symbol">?</span><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>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">surfaceCreated</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceCreated(android.view.SurfaceHolder)/holder">holder</span><span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/view/SurfaceHolder.html"><span class="identifier">SurfaceHolder</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>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@
<br/>
<h1>surfaceDestroyed</h1>
<a name="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceDestroyed(android.view.SurfaceHolder)"></a>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">surfaceDestroyed</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceDestroyed(android.view.SurfaceHolder)/holder">holder</span><span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/view/SurfaceHolder.html"><span class="identifier">SurfaceHolder</span></a><span class="symbol">?</span><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>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">surfaceDestroyed</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl.SurfaceRenderView$surfaceDestroyed(android.view.SurfaceHolder)/holder">holder</span><span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/view/SurfaceHolder.html"><span class="identifier">SurfaceHolder</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>
</BODY>
</HTML>
Loading

0 comments on commit b1e035e

Please sign in to comment.