Skip to content

Commit

Permalink
Update docs and changelog (#232)
Browse files Browse the repository at this point in the history
  • Loading branch information
alnlau authored Feb 4, 2021
1 parent 826ee5e commit 4bc2b31
Show file tree
Hide file tree
Showing 124 changed files with 2,954 additions and 36 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.11.0] - 2021-02-04

### Added
* Added Analytics
Expand Down
46 changes: 46 additions & 0 deletions docs/amazon-chime-sdk/alltypes/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,15 @@ <h5><a href="../com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl/-d
It will track all child <a href="../com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl/-egl-core/index.html">EglCore</a> objects and release the root core if all child cores are released.</p>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-default-event-analytics-controller/index.html">com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController</a></h5>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.session/-default-meeting-session/index.html">com.amazonaws.services.chime.sdk.meetings.session.DefaultMeetingSession</a></h5>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-default-meeting-stats-collector/index.html">com.amazonaws.services.chime.sdk.meetings.analytics.DefaultMeetingStatsCollector</a></h5>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.utils/-default-modality/index.html">com.amazonaws.services.chime.sdk.meetings.utils.DefaultModality</a></h5>
<p><a href="../com.amazonaws.services.chime.sdk.meetings.utils/-default-modality/index.html">DefaultModality</a> is a backwards compatible extension of the
attendee id (UUID string) and session token schemas (base 64 string).
Expand Down Expand Up @@ -201,6 +207,31 @@ <h5><a href="../com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl/-e
need to call <a href="../com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl/-egl-video-render-view/init.html">init</a> and <a href="../com.amazonaws.services.chime.sdk.meetings.audiovideo.video.gl/-egl-video-render-view/release.html">release</a> themselves</p>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-analytics-controller/index.html">com.amazonaws.services.chime.sdk.meetings.analytics.EventAnalyticsController</a></h5>
<p><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-analytics-controller/index.html">EventAnalyticsController</a> keeps track of events and notifies <a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-analytics-observer/index.html">EventAnalyticsObserver</a>.
An event describes the success and failure conditions for the meeting session.</p>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-analytics-facade/index.html">com.amazonaws.services.chime.sdk.meetings.analytics.EventAnalyticsFacade</a></h5>
<p><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-analytics-facade/index.html">EventAnalyticsFacade</a> allows builders to listen to meeting analytics events
through adding/removing <a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-analytics-observer/index.html">EventAnalyticsObserver</a>.</p>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-analytics-observer/index.html">com.amazonaws.services.chime.sdk.meetings.analytics.EventAnalyticsObserver</a></h5>
<p><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-analytics-observer/index.html">EventAnalyticsObserver</a> handles events regarding to analytics.</p>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-attribute-name/index.html">com.amazonaws.services.chime.sdk.meetings.analytics.EventAttributeName</a></h5>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-attributes.html">com.amazonaws.services.chime.sdk.meetings.analytics.EventAttributes</a></h5>
<p><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-attributes.html">EventAttributes</a> describes meeting event.</p>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-name/index.html">com.amazonaws.services.chime.sdk.meetings.analytics.EventName</a></h5>
<p><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-name/index.html">EventName</a> represent some major event that could help builders to analyze the data.</p>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.utils.logger/-logger/index.html">com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger</a></h5>
<p><a href="../com.amazonaws.services.chime.sdk.meetings.utils.logger/-logger/index.html">Logger</a> defines how to write logs for different logging level.</p>
</tr>
Expand All @@ -222,6 +253,14 @@ <h5><a href="../com.amazonaws.services.chime.sdk.meetings.session/-media-placeme
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.session/-meeting/index.html">com.amazonaws.services.chime.sdk.meetings.session.Meeting</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>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-meeting-history-event-name/index.html">com.amazonaws.services.chime.sdk.meetings.analytics.MeetingHistoryEventName</a></h5>
<p><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-meeting-history-event-name/index.html">MeetingHistoryEventName</a> is a notable event (such as MeetingStartSucceeded) that occur during meeting.
Thus, this also includes events in <a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-event-name/index.html">EventName</a>.</p>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.session/-meeting-session/index.html">com.amazonaws.services.chime.sdk.meetings.session.MeetingSession</a></h5>
<p><a href="../com.amazonaws.services.chime.sdk.meetings.session/-meeting-session/index.html">MeetingSession</a> contains everything needed for the attendee to authenticate,
reach the meeting service, start audio, and start video</p>
Expand Down Expand Up @@ -251,12 +290,19 @@ <h5><a href="../com.amazonaws.services.chime.sdk.meetings.session/-meeting-sessi
meeting service.</p>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/-meeting-stats-collector/index.html">com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector</a></h5>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-metrics-observer/index.html">com.amazonaws.services.chime.sdk.meetings.audiovideo.metric.MetricsObserver</a></h5>
<p><a href="../com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-metrics-observer/index.html">MetricsObserver</a> handles events related to audio/video metrics.</p>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.utils/-modality-type/index.html">com.amazonaws.services.chime.sdk.meetings.utils.ModalityType</a></h5>
</tr>
<tr>
(extensions in package com.amazonaws.services.chime.sdk.meetings.analytics)
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.analytics/kotlin.collections.-mutable-map/index.html">kotlin.collections.MutableMap</a></h5>
</tr>
<tr>
<h5><a href="../com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-observable-metric/index.html">com.amazonaws.services.chime.sdk.meetings.audiovideo.metric.ObservableMetric</a></h5>
<p><a href="../com.amazonaws.services.chime.sdk.meetings.audiovideo.metric/-observable-metric/index.html">ObservableMetric</a> represents filtered metrics that are intended to propagate to the
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DefaultEventAnalyticsController.<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.analytics</a>&nbsp;/&nbsp;<a href="index.html">DefaultEventAnalyticsController</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.analytics.DefaultEventAnalyticsController$&lt;init&gt;(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector)"></a>
<code><span class="identifier">DefaultEventAnalyticsController</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$<init>(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector)/logger">logger</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.utils.logger/-logger/index.html"><span class="identifier">Logger</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$<init>(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector)/meetingSessionConfiguration">meetingSessionConfiguration</span><span class="symbol">:</span>&nbsp;<a href="../../com.amazonaws.services.chime.sdk.meetings.session/-meeting-session-configuration/index.html"><span class="identifier">MeetingSessionConfiguration</span></a><span class="symbol">, </span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$<init>(com.amazonaws.services.chime.sdk.meetings.utils.logger.Logger, com.amazonaws.services.chime.sdk.meetings.session.MeetingSessionConfiguration, com.amazonaws.services.chime.sdk.meetings.analytics.MeetingStatsCollector)/meetingStatsCollector">meetingStatsCollector</span><span class="symbol">:</span>&nbsp;<a href="../-meeting-stats-collector/index.html"><span class="identifier">MeetingStatsCollector</span></a><span class="symbol">)</span></code>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DefaultEventAnalyticsController.addEventAnalyticsObserver - 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.analytics</a>&nbsp;/&nbsp;<a href="index.html">DefaultEventAnalyticsController</a>&nbsp;/&nbsp;<a href="./add-event-analytics-observer.html">addEventAnalyticsObserver</a><br/>
<br/>
<h1>addEventAnalyticsObserver</h1>
<a name="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$addEventAnalyticsObserver(com.amazonaws.services.chime.sdk.meetings.analytics.EventAnalyticsObserver)"></a>
<code><span class="keyword">fun </span><span class="identifier">addEventAnalyticsObserver</span><span class="symbol">(</span><span class="identifier" id="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$addEventAnalyticsObserver(com.amazonaws.services.chime.sdk.meetings.analytics.EventAnalyticsObserver)/observer">observer</span><span class="symbol">:</span>&nbsp;<a href="../-event-analytics-observer/index.html"><span class="identifier">EventAnalyticsObserver</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>Add specified <a href="../-event-analytics-observer/index.html">EventAnalyticsObserver</a>.</p>
<h3>Parameters</h3>
<p><a name="observer"></a>
<code>observer</code> - : <a href="../-event-analytics-observer/index.html">EventAnalyticsObserver</a> - The observer to subscribe to events with.</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DefaultEventAnalyticsController.getCommonEventAttributes - 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.analytics</a>&nbsp;/&nbsp;<a href="index.html">DefaultEventAnalyticsController</a>&nbsp;/&nbsp;<a href="./get-common-event-attributes.html">getCommonEventAttributes</a><br/>
<br/>
<h1>getCommonEventAttributes</h1>
<a name="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$getCommonEventAttributes()"></a>
<code><span class="keyword">fun </span><span class="identifier">getCommonEventAttributes</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../-event-attributes.html"><span class="identifier">EventAttributes</span></a></code>
<p>Retrieve common attributes, including deviceName, osName, and more.</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DefaultEventAnalyticsController.getMeetingHistory - 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.analytics</a>&nbsp;/&nbsp;<a href="index.html">DefaultEventAnalyticsController</a>&nbsp;/&nbsp;<a href="./get-meeting-history.html">getMeetingHistory</a><br/>
<br/>
<h1>getMeetingHistory</h1>
<a name="com.amazonaws.services.chime.sdk.meetings.analytics.DefaultEventAnalyticsController$getMeetingHistory()"></a>
<code><span class="keyword">fun </span><span class="identifier">getMeetingHistory</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol">&lt;</span><a href="../-meeting-history-event/index.html"><span class="identifier">MeetingHistoryEvent</span></a><span class="symbol">&gt;</span></code>
<p>Retrieve meeting history.</p>
</BODY>
</HTML>
Loading

0 comments on commit 4bc2b31

Please sign in to comment.