Change version to pre-release 0.5.0-dev + changelog (#18)

* Add changelog up to version 0.5.0-dev

* Update README to reflect the new changes in the code

* Bump version to 0.5.0-dev

* Fix typo

CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+Here you can find the changelog for the pre-release versions that are available as [releases in this repo](https://github.com/microsoft/Broadcast-Development-Kit/releases).
+
+## Notice
+
+This is a **PRE-RELEASE** project and is still in development. This project uses the [application-hosted media bot](https://docs.microsoft.com/en-us/microsoftteams/platform/bots/calls-and-meetings/requirements-considerations-application-hosted-media-bots) SDKs and APIs, which are still in **BETA**.
+
+The code in this repository is provided "AS IS", without any warranty of any kind. Check the [LICENSE](LICENSE) for more information.
+
+## 0.5.0-dev
+
+- Fixed an issue where some participants in the call were not able to see the video injected by the bot.
+    - Note that this fix is actually a workaround for a behavior in Microsoft Teams where the Teams client didn't render the video if the injection was started more than 3 minutes after the bot was joined to the meeting. The bot now shows a **slate** in the meeting when no injection is active to prevent the video socket in the Teams client from closing.
+    - You can personalize this slate following the instructions in the [Customize the Broadcast Development Kit Slate image](docs/common/customize_bdk_slate_image.md) document.
+- Added support for extracting video from the call using the RTMP/RTMPS protocols in pull mode. Previously, only push mode was supported for extractions with RTMP/RTMPS.
+- Updated to the latest version of the **Microsoft Graph Communications** SDKs (v1.2.0.3144).
+- Changed how the status of the service is managed to separate the state of the **BotService** from the state of the underlying virtual machine.
+- Updated the initialization logic of the **BotService** when running as a Windows service, to reduce the chance of Windows killing the service if the start-up process takes too long.
+
+## 0.4.0-dev
+
+- Initial pre-release of the solution.

README.md

@@ -37,7 +37,8 @@ To provide the best possible experience during a meeting, Microsoft Teams automa
 Extraction of any of those streams can be done with the following configurations:
 - SRT in "caller" mode (you have a SRT listener waiting to receive a connection from this solution).
 - SRT in "listener" mode (the solution will wait for a SRT caller to connect and get the content).
-- RTMP / RTMPS in "push" mode (you have a RTMP URL you want to push the stream to.)
+- RTMP / RTMPS in "push" mode (you have a RTMP URL you want to push the stream to).
+- RTMP / RTMPS in "pull" mode (the solution will wait for an RTMP client to connect and retrieve the content).
 
 ### Injection
 
@@ -71,14 +72,7 @@ Then you can process those feeds in a video production solution of your choosing
 
 If you have media content that can be streamed through SRT or RTMP such as live event or a VOD, you can use the injection feature to playback the video inside the Microsoft Teams meeting to the rest of the participants and watch the stream together.
 
-## Limitations and known issues
-
-There are some known issues in the current version of this solution:
-
-- There is a bug with the Teams Meeting client where sometimes, when you start injecting video, the Teams Meeting client of some participants do not show the video (but reproduce the audio). The workaround is to force the Teams Meeting client to refresh the view. There are several ways of doing this:
-    - By disabling the incoming video and enabling it again 
-    - Spotlighting a participant and then change the spotlight to the bot
-    - Leaving the meeting and entering again
+## Limitations
 
 This solution currently has some limitations:
 

src/BotService/BotService.csproj

@@ -11,7 +11,7 @@
     <Product>Broadcast Development Kit for Teams</Product>
     <Authors>Microsoft</Authors>
     <Company>Microsoft</Company>
-    <Version>0.4.0-dev</Version>
+    <Version>0.5.0-dev</Version>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">

src/BotService/appsettings.json

@@ -6,6 +6,6 @@
   },
   "AllowedHosts": "*",
   "Settings": {
-    "BuildVersion": "0.4.0-dev"
+    "BuildVersion": "0.5.0-dev"
   }
 }

src/ManagementApi/ManagementApi.csproj

@@ -6,7 +6,7 @@
     <TargetFramework>netcoreapp3.1</TargetFramework>
     <Copyright>Copyright (c) Microsoft Corporation.</Copyright>
     <Product>Broadcast Development Kit for Teams</Product>
-    <Version>0.4.0-dev</Version>
+    <Version>0.5.0-dev</Version>
     <Company>Microsoft</Company>
     <Authors>Microsoft</Authors>
   </PropertyGroup>

src/ManagementApi/appsettings.json

@@ -8,6 +8,6 @@
   },
   "AllowedHosts": "*",
   "Settings": {
-    "BuildVersion": "0.4.0-dev"
+    "BuildVersion": "0.5.0-dev"
   }
 }

src/OrchestratorFunction/BotOrchestrator.csproj

@@ -8,7 +8,7 @@
     <Copyright>Copyright (c) Microsoft Corporation.</Copyright>
     <Authors>Microsoft</Authors>
     <Company>Microsoft</Company>
-    <Version>0.4.0-dev</Version>
+    <Version>0.5.0-dev</Version>
     <Product>Broadcast Development Kit for Teams</Product>
   </PropertyGroup>
   <ItemGroup>