Skip to content

Commit

Permalink
Minor documentation update. (microsoftgraph#67)
Browse files Browse the repository at this point in the history
* Minor documentation update.
* Removed space.
  • Loading branch information
ksikorsk authored May 29, 2019
1 parent a6d8bde commit 7b90027
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,19 @@ The Incident Bot sample is a Remote Media sample demonstrating a simple incident
* Clone the Git repo for the Microsoft Graph Calling API Samples. Please see the instructions [here](https://docs.microsoft.com/en-us/vsts/git/tutorial/clone?view=vsts&tabs=visual-studio) to get started with VSTS Git.
* Log in to your Azure subscription to host web sites and bot services.
* Install Visual Studio and launch IncidentBot.sln in <Repository>\RemoteMediaSamples with Visual Studio
* Follow the instructions [Register a Calling Bot](https://microsoftgraph.github.io/microsoft-graph-comms-samples/docs/articles/calls/register-calling-bot.html). Take a note of the registered config values (Bot Id, MicrosoftAppId and MicrosoftAppPassword). You will need these values in the code sample config.

#### Bot Registration

1. Follow the instructions [Register a Calling Bot](https://microsoftgraph.github.io/microsoft-graph-comms-samples/docs/articles/calls/register-calling-bot.html). Take a note of the registered config values (Bot Id, MicrosoftAppId and MicrosoftAppPassword). You will need these values in the code sample config.

1. Add the following Application Permissions to the bot:

* Calls.AccessMedia.All
* Calls.Initiate
* Calls.JoinGroupCall.All
* Calls.JoinGroupAsGuestCall.All

1. The permissions need to be consented by tenant admin. Go to "https://login.microsoftonline.com/common/adminconsent?client_id=<app_id>&state=<any_number>&redirect_uri=<any_callback_url>" using tenant admin to sign-in, then consent for the whole tenant.

#### Deploying the Sample

Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# Introduction

## About

The AudioVideoPlaybackBot sample guides you through building, deploying and testing an application hosted media bot. This sample demonstrates how a bot can do a video stream and change screen sharing role.

## Getting Started
This section walks you through the process of deploying and testing the sample AudioVideoPlaybackBot to Azure.

This section walks you through the process of deploying and testing the sample bot.

### Bot Registration

1. Follow the steps in [Register Calling Bot](https://microsoftgraph.github.io/microsoft-graph-comms-samples/docs/articles/calls/register-calling-bot.html). Save the bot name, bot app id and bot secret for configuration.

1. Add the following Application Permissions to the bot:
Expand All @@ -16,8 +19,7 @@ This section walks you through the process of deploying and testing the sample A
* Calls.JoinGroupCall.All
* Calls.JoinGroupAsGuestCall.All

1. The permission needs to be consented by tenant admin. Go to "https://login.microsoftonline.com/common/adminconsent?client_id=<app_id>&state=<any_number>&redirect_uri=<any_callback_url>" using tenant admin to sign-in , then consent for the whole tenant.

1. The permission needs to be consented by tenant admin. Go to "https://login.microsoftonline.com/common/adminconsent?client_id=<app_id>&state=<any_number>&redirect_uri=<any_callback_url>" using tenant admin to sign-in, then consent for the whole tenant.

### Prerequisites

Expand All @@ -28,6 +30,7 @@ This section walks you through the process of deploying and testing the sample A
### Deploy

#### [Azure] deployment

1. Create a cloud service (classic) in Azure. Get your "Site URL" from Azure portal, this will be your DNS name and CN name for later configuration, for example: `bot.contoso.com`.

1. Set up SSL certificate and upload to the cloud service
Expand All @@ -41,7 +44,6 @@ This section walks you through the process of deploying and testing the sample A

1. Publish AudioVideoPlaybackBot from VS:
1. Right click AudioVideoPlaybackBot, then click Publish.... Publish it to the cloud service you created earlier.


### Test

Expand Down
5 changes: 5 additions & 0 deletions Samples/V1.0Samples/LocalMediaSamples/HueBot/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# Introduction

## About

The Hue Bot sample guides you through building, deploying and testing an application hosted media bot. This sample demonstrates how bots can interact with users by enabling real-time video capabilities.

## Getting Started

This section walks you through the process of deploying and testing the sample bot. You have 2 options: deploy to Azure, or run locally on your dev box. Many of the steps are common; wherever they do diverge, they have been specifically marked as **[Local]** or **[Azure]**.

For running locally, we need to use a tunneling mechanism to route traffic to your dev box. You can find the concepts documented [here](https://microsoftgraph.github.io/microsoft-graph-comms-samples/docs/articles/Testing.html). While the steps for running locally can seem a bit longer, the deployments are much faster and convenient for tweaking and playing with the samples.

### Bot Registration

1. Follow the steps in [Register Calling Bot](https://microsoftgraph.github.io/microsoft-graph-comms-samples/docs/articles/calls/register-calling-bot.html).

1. Add the following Application Permissions to the bot:
Expand All @@ -18,6 +21,8 @@ For running locally, we need to use a tunneling mechanism to route traffic to yo
* Calls.JoinGroupCall.All
* Calls.JoinGroupAsGuestCall.All

1. The permissions need to be consented by tenant admin. Go to "https://login.microsoftonline.com/common/adminconsent?client_id=<app_id>&state=<any_number>&redirect_uri=<any_callback_url>" using tenant admin to sign-in, then consent for the whole tenant.

### Prerequisites

* Install the prerequisites:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@ Local media samples give the developer direct access to the inbound and outbound

## AudioVideoPlaybackBot

This bot demostrates several features of local media scenarios:
The [AudioVideoPlaybackBot](AudioVideoPlaybackBot/README.md) demostrates several features of local media scenarios:
- Plays a movie in multiple resolutions as the main video output feed.
- Listens to dominant speaker events and subscribes to inbound video feeds of those participants.
- Allows switching between screen viewing sharer and viewer, and publishes video through the screen sharing socket.

## HueBot

This bot demonstrates local media scenarios.
The [HueBot](HueBot/README.md) demonstrates local media scenarios.
- Listens to dominant speaker events and changes the hue color of the dominant speaker video.

# Getting Started

1. [Register Calling Bot](https://microsoftgraph.github.io/microsoft-graph-comms-samples/docs/articles/calls/register-calling-bot.html).
1. Configure your permissions. Go to Settings page and click on the *Manage* link near *Microsoft App ID*. In the new page, click *Add* button after *Application Permissions* and select *Calls.AccessMedia.All*, and then save the change. If your bot also need to join meeting, select *Calls.JoinGroupCall.All* as well.
1. The permission needs to be consented by tenant admin. Go to "https://login.microsoftonline.com/common/adminconsent?client_id=<app_id>&state=<any_number>&redirect_uri=<callback_url>" using tenant admin to sign-in , then consent for the whole tenant.
1. The permission needs to be consented by tenant admin. Go to "https://login.microsoftonline.com/common/adminconsent?client_id=<app_id>&state=<any_number>&redirect_uri=<callback_url>" using tenant admin to sign-in, then consent for the whole tenant.
1. Please read the [Concepts](https://docs.microsoft.com/en-us/microsoftteams/platform/concepts/calls-and-meetings/real-time-media-concepts) articles for more in depth knowledge on local media bots.
1. Follow instructions in the sample to publish your bot to the web.
1. Please read the [API Reference](https://microsoftgraph.github.io/microsoft-graph-comms-samples/docs/) for specific API information.
Expand Down

0 comments on commit 7b90027

Please sign in to comment.