Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update docs #131

Merged
merged 2 commits into from
Dec 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/bot_media/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,11 @@ <h1 id="graph-communications-bot-media-sdk">Graph Communications Bot Media SDK</
<p>The Real-time Media Platform enables bots to interact with Microsoft Teams calls and meetings using real-time voice, video and screen sharing. This is an advanced capability which allows the bot to send and receive voice and video content frame by frame. The bot has &quot;raw&quot; access to the voice, video and screen sharing media streams. (Bots which process media themselves are called application-hosted media bots, as opposed to simpler service-hosted media bots that rely on the Real-time Media platform for all media processing.)</p>
<p>For example, in a 1:1 call with a bot, as the user speaks, the bot will receive 50 audio frames per second, with each frame containing 20 milliseconds (ms) of audio. An application-hosted media bot can perform real-time speech recognition as the audio frames are received, rather than having to wait for a recording after the user has stopped speaking. The bot can also send and receive high-definition-resolution video, including video-based screen sharing content.</p>
<p>The platform provides a simple &quot;socket&quot;-like API for the bot to send and receive media, and handles the real-time encoding and decoding of audio/video packets, using codecs such as SILK and G.722 for audio and H.264 for video. The platform also handles all media packet encryption/decryption and packet network transmission automatically, so the bot just needs to concern itself with the actual audio/video content. A real-time media bot may participate in 1:1 calls as well as meetings with multiple participants.</p>
<h2 id="microsoft-real-time-media-platform-for-bots-api-media-access-api">Microsoft Real-Time Media Platform for Bots API (&quot;Media Access API&quot;)</h2>
<h3 id="accompanying-documentation">Accompanying Documentation</h3>
<p>The Media Access API is offered under the terms of the Microsoft APIs Terms of Use (<a href="https://docs.microsoft.com/en-us/legal/microsoft-apis/terms-of-use">https://docs.microsoft.com/en-us/legal/microsoft-apis/terms-of-use</a>) and this accompanying documentation.</p>
<p>&quot;Media Access API&quot; means (i) any form of machine accessible application programming interface that Microsoft makes publicly available which provides access to a Microsoft Offering that includes media content (e.g., audio or video), including all associated tools, elements, components and executables therein, (ii) any Microsoft sample code that enables interactions with a Microsoft Offering, and (iii) documentation that Microsoft makes available to help enable your access to the Media Access API.</p>
<p><strong>Additional Restriction</strong>: You may NOT use the Media Access API to record or otherwise persist media content from calls or meetings that your Application accesses, or data derived from that media content.</p>
<hr>
<p>Select a class on the left to dive into the reference docs</p>
</article>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ <h5 class="propertyValue">Property Value</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="../core_calls/Microsoft.Graph.Modality.html">Modality</a>[]</td>
<td><a class="xref" href="../core/Microsoft.Graph.Modality.html">Modality</a>[]</td>
<td></td>
</tr>
</tbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,6 @@ <h6><strong>Assembly</strong>: Microsoft.Graph.Communications.Client.dll</h6>
<h5 id="Microsoft_Graph_Communications_Client_Cache_CacheContext_1_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public struct CacheContext&lt;TEntity&gt;

where TEntity : Entity</code></pre>
</div>
<h5 class="typeParameters">Type Parameters</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,6 @@ <h4 id="Microsoft_Graph_Communications_Client_Cache_ICache_GetDataAsync__1_Syste
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;string&gt; GetDataAsync&lt;T&gt;(IEnumerable&lt;IGraphProperty&gt; properties, string resourcePath, CancellationToken cancellationToken = default(CancellationToken))

where T : Entity</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down Expand Up @@ -179,7 +178,6 @@ <h4 id="Microsoft_Graph_Communications_Client_Cache_ICache_GetDataCollectionAsyn
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;IEnumerable&lt;string&gt;&gt; GetDataCollectionAsync&lt;T&gt;(IEnumerable&lt;IGraphProperty&gt; properties, string resourcePath, CancellationToken cancellationToken = default(CancellationToken))

where T : Entity</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,6 @@ <h4 id="Microsoft_Graph_Communications_Client_Cache_ServiceCache_GetDataAsync__1
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;string&gt; GetDataAsync&lt;T&gt;(IEnumerable&lt;IGraphProperty&gt; properties, string resourcePath, CancellationToken cancellationToken = default(CancellationToken))

where T : Entity</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down Expand Up @@ -236,7 +235,6 @@ <h4 id="Microsoft_Graph_Communications_Client_Cache_ServiceCache_GetDataCollecti
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;IEnumerable&lt;string&gt;&gt; GetDataCollectionAsync&lt;T&gt;(IEnumerable&lt;IGraphProperty&gt; properties, string resourcePath, CancellationToken cancellationToken = default(CancellationToken))

where T : Entity</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,6 @@ <h4 id="Microsoft_Graph_Communications_Client_Transport_GraphAuthClient_SendHttp
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected override Task&lt;IGraphResponse&lt;T2&gt;&gt; SendHttpRequestAsync&lt;T1, T2&gt;(IGraphRequest&lt;T1&gt; graphRequest, CancellationToken cancellationToken)

where T1 : class where T2 : class</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,6 @@ <h4 id="Microsoft_Graph_Communications_Client_Transport_GraphClientWrapper_SendA
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;IGraphResponse&gt; SendAsync&lt;T&gt;(IGraphRequest&lt;T&gt; request, CancellationToken cancellationToken = default(CancellationToken))

where T : class</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down Expand Up @@ -280,7 +279,6 @@ <h4 id="Microsoft_Graph_Communications_Client_Transport_GraphClientWrapper_SendA
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;IGraphResponse&lt;T2&gt;&gt; SendAsync&lt;T1, T2&gt;(IGraphRequest&lt;T1&gt; request, CancellationToken cancellationToken = default(CancellationToken))

where T1 : class where T2 : class</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,6 @@ <h6><strong>Assembly</strong>: Microsoft.Graph.Communications.Client.dll</h6>
<h5 id="Microsoft_Graph_Communications_Resources_ResourceEventArgs_1_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ResourceEventArgs&lt;TEntity&gt;

where TEntity : Entity</code></pre>
</div>
<h5 class="typeParameters">Type Parameters</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@ <h6><strong>Assembly</strong>: Microsoft.Graph.Communications.Client.dll</h6>
<h5 id="Microsoft_Graph_Communications_Resources_ResourceEventHandler_2_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public delegate void ResourceEventHandler&lt;in TSender, TEntity&gt;(TSender sender, ResourceEventArgs&lt;TEntity&gt; e)

where TEntity : Entity;</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,6 @@ <h4 id="Microsoft_Graph_Communications_Common_CollectionUtils_TryRemoveAndDispos
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void TryRemoveAndDispose&lt;TKey, TValue&gt;(this ConcurrentDictionary&lt;TKey, TValue&gt; dictionary, TKey key)

where TValue : IDisposable</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,6 @@ <h4 id="Microsoft_Graph_Communications_Common_EnumUtils_Parse__1_System_String_"
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static TEnum Parse&lt;TEnum&gt;(string value)

where TEnum : struct, IComparable, IFormattable, IConvertible</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,6 @@ <h6><strong>Assembly</strong>: Microsoft.Graph.Communications.Common.dll</h6>
<h5 id="Microsoft_Graph_Communications_Common_StateMachine_1_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class StateMachine&lt;TStateEnum&gt;

where TStateEnum : struct, IComparable, IFormattable, IConvertible</code></pre>
</div>
<h5 class="typeParameters">Type Parameters</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -759,7 +759,6 @@ <h4 id="Microsoft_Graph_Communications_Common_Telemetry_LoggingExtensions_GetTyp
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static T GetTypedProperty&lt;T&gt;(this LogEvent logEvent)

where T : class</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -492,7 +492,6 @@ <h4 id="Microsoft_Graph_Communications_Common_Transport_GraphHttpClient_SendAsyn
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;IGraphResponse&gt; SendAsync&lt;T&gt;(IGraphRequest&lt;T&gt; graphRequest, CancellationToken cancellationToken = default(CancellationToken))

where T : class</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down Expand Up @@ -554,7 +553,6 @@ <h4 id="Microsoft_Graph_Communications_Common_Transport_GraphHttpClient_SendAsyn
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;IGraphResponse&lt;T2&gt;&gt; SendAsync&lt;T1, T2&gt;(IGraphRequest&lt;T1&gt; graphRequest, CancellationToken cancellationToken = default(CancellationToken))

where T1 : class where T2 : class</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down Expand Up @@ -623,7 +621,6 @@ <h4 id="Microsoft_Graph_Communications_Common_Transport_GraphHttpClient_SendHttp
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual Task&lt;IGraphResponse&lt;T2&gt;&gt; SendHttpRequestAsync&lt;T1, T2&gt;(IGraphRequest&lt;T1&gt; graphRequest, CancellationToken cancellationToken)

where T1 : class where T2 : class</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,6 @@ <h4 id="Microsoft_Graph_Communications_Common_Transport_HttpResponseMessageExten
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Task&lt;IGraphResponse&lt;T&gt;&gt; ToGraphResponseAsync&lt;T&gt;(this HttpResponseMessage httpResponse, JsonSerializerSettings serializerSettings = null)

where T : class</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,6 @@ <h4 id="Microsoft_Graph_Communications_Common_Transport_IGraphClient_SendAsync__
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;IGraphResponse&gt; SendAsync&lt;TRequest&gt;(IGraphRequest&lt;TRequest&gt; request, CancellationToken cancellationToken = default(CancellationToken))

where TRequest : class</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down Expand Up @@ -222,7 +221,6 @@ <h4 id="Microsoft_Graph_Communications_Common_Transport_IGraphClient_SendAsync__
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;IGraphResponse&lt;TResponse&gt;&gt; SendAsync&lt;TRequest, TResponse&gt;(IGraphRequest&lt;TRequest&gt; request, CancellationToken cancellationToken = default(CancellationToken))

where TRequest : class where TResponse : class</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,6 @@ <h4 id="Microsoft_Graph_Communications_Common_Utilities_SafeDispose__1___0__Micr
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void SafeDispose&lt;T&gt;(ref T t, IGraphLogger logger = null)

where T : class, IDisposable</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,6 @@ <h4 id="Microsoft_Graph_Communications_Common_Validator_Equals__2___0___0_System
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static T Equals&lt;T, TE&gt;(this T value, T expected, string message = null)

where TE : Exception</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down Expand Up @@ -537,7 +536,6 @@ <h4 id="Microsoft_Graph_Communications_Common_Validator_InRange__1___0___0___0_S
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void InRange&lt;T&gt;(this T value, T minValue, T maxValue, string paramName = null)

where T : IComparable&lt;T&gt;</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down Expand Up @@ -682,7 +680,6 @@ <h4 id="Microsoft_Graph_Communications_Common_Validator_IsFalse__1_System_Boolea
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void IsFalse&lt;T&gt;(this bool condition, string message = null)

where T : Exception</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down Expand Up @@ -811,7 +808,6 @@ <h4 id="Microsoft_Graph_Communications_Common_Validator_IsTrue__1_System_Boolean
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void IsTrue&lt;T&gt;(this bool condition, string message = null)

where T : Exception</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down Expand Up @@ -862,7 +858,6 @@ <h4 id="Microsoft_Graph_Communications_Common_Validator_NotEmpty__1___0_System_S
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static T NotEmpty&lt;T&gt;(this T obj, string paramName = null, string message = null)

where T : IEnumerable</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,6 @@ <h6><strong>Assembly</strong>: Microsoft.Graph.Communications.Common.dll</h6>
<h5 id="Microsoft_Graph_Communications_Common_WeakKey_1_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class WeakKey&lt;T&gt;

where T : class</code></pre>
</div>
<h5 class="typeParameters">Type Parameters</h5>
Expand Down
Loading