From 7da3df8b13e8e6c045dfb73ae278f117a6be64bd Mon Sep 17 00:00:00 2001 From: Martin Schoeler Date: Fri, 11 May 2018 14:38:25 -0300 Subject: [PATCH 1/2] Initial docs on youtube broadcasting --- _data/toc.yml | 1 + .../youtube-broadcasting/README.md | 16 ++++++++++++++++ user-guides/channel-actions/README.md | 16 ++++++++++++++++ 3 files changed, 33 insertions(+) create mode 100644 administrator-guides/youtube-broadcasting/README.md diff --git a/_data/toc.yml b/_data/toc.yml index 563b1f0c6d..3cc2951293 100644 --- a/_data/toc.yml +++ b/_data/toc.yml @@ -144,6 +144,7 @@ - Create the First Admin - Restoring an Admin - Settings Via Env Vars + - Youtube Broadcasting - Developer guides: - Quick Start - Branches and Releases diff --git a/administrator-guides/youtube-broadcasting/README.md b/administrator-guides/youtube-broadcasting/README.md new file mode 100644 index 0000000000..4c3a9d4684 --- /dev/null +++ b/administrator-guides/youtube-broadcasting/README.md @@ -0,0 +1,16 @@ +# Youtube Broadcasting + +This feature adds an integration between Rocket.Chat and Youtube Live, when enabled and set up, your channel owners will be able to broadcast their camera feed live to the Livestream feature which allows all users on the channel to watch a common stream. + +## Configuration + +The Broadcasting feature can only be used with the Livestream Tab feature. + +You can find the settings for this feature on `Livestream & Broadcasting` in the admin panel. + +_Currently the admin needs a valid Google app with access to the Youtube API to use youtube live integration (More details on the [Google Developer page](https://developers.google.com/youtube/v3/)), this will allow the administrator to have a valid API Key, Client ID & Secret which are used on the Broadcasting feature._ + +## Livestream tab + +After a correct set up, the Livestream tab will now allow you to Broadcast your camera when editing the source url. +When opening the popout, it might take a moment while we prepare the broadcast and livestream for your session, this will be indicated by the blinking icon and "Preparing" status displayed in the control bar. After that initial phase, the broadcast will be Ready and available to start with your click. \ No newline at end of file diff --git a/user-guides/channel-actions/README.md b/user-guides/channel-actions/README.md index 92b55c42d1..aea5289750 100644 --- a/user-guides/channel-actions/README.md +++ b/user-guides/channel-actions/README.md @@ -142,3 +142,19 @@ You can only use OTR in direct messages (one-on-one) and both sides must be onli To start OTR conversation, click on _START OTR_. The other user will be notified to start a OTR. After your request is confirmed by other side, messages are encrypted. Encrypted messages have a key icon on the right side. + +## Streaming + +If the feature [Youtube Livestream](../../administrator-guides/youtube-broadcasting) is enabled, you will see the `Streaming` Tab on the channel actions menu. + +If you are the owner of the channel or if you are a admin server you will be able to start streaming from there, or add a current ongoing stream to the channel via url. + +To start streaming from rocket.chat just press the `Broadcast my Camera` button. After that you will be prompted to login with a google account (you need to have streaming activated on your youtube account before, see [Introduction to live streaming](https://support.google.com/youtube/answer/2474026?hl=en) Google guide). + +You can also add a stream from Youtube with the stream link (The owner of the stream must allow the stream to be shown in other sites). To start a live stream from youtube, just add the link to it on the `Livestream source` form and hit save. + +You can add a message to whenever the stream is unavailable in the `Livestream not available message` field. + +You can also stream only the sound of the live stream with the `Enable audio only button`. This is very useful when you want to do a podcast for example. + +If you are not a channel owner and there is already a live stream set to that channel, you will need only press play on the stream tab. Doing that will create a pop over embedded video, that can be moved around the screen and even if you change channels you will still be able to watch that stream, since the popover will not close when changing channels. \ No newline at end of file From 9a07b2eb6d12577d6490a73c0831eefd1dd9846e Mon Sep 17 00:00:00 2001 From: Martin Schoeler Date: Fri, 11 May 2018 15:23:57 -0300 Subject: [PATCH 2/2] Add notes about Broadcasting Enable setting --- administrator-guides/youtube-broadcasting/README.md | 2 ++ user-guides/channel-actions/README.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/administrator-guides/youtube-broadcasting/README.md b/administrator-guides/youtube-broadcasting/README.md index 4c3a9d4684..1bf1820770 100644 --- a/administrator-guides/youtube-broadcasting/README.md +++ b/administrator-guides/youtube-broadcasting/README.md @@ -8,6 +8,8 @@ The Broadcasting feature can only be used with the Livestream Tab feature. You can find the settings for this feature on `Livestream & Broadcasting` in the admin panel. +If you set the `Broadcasting Enable` setting to false, users wont be able to create live streams using their webcams, but will still be able to link a live stream from youtube. + _Currently the admin needs a valid Google app with access to the Youtube API to use youtube live integration (More details on the [Google Developer page](https://developers.google.com/youtube/v3/)), this will allow the administrator to have a valid API Key, Client ID & Secret which are used on the Broadcasting feature._ ## Livestream tab diff --git a/user-guides/channel-actions/README.md b/user-guides/channel-actions/README.md index aea5289750..1046424817 100644 --- a/user-guides/channel-actions/README.md +++ b/user-guides/channel-actions/README.md @@ -149,6 +149,8 @@ If the feature [Youtube Livestream](../../administrator-guides/youtube-broadcast If you are the owner of the channel or if you are a admin server you will be able to start streaming from there, or add a current ongoing stream to the channel via url. +_Note: depending on the settings of the server you might be only able to link live streams from Youtube. In doubt always ask your server's admin._ + To start streaming from rocket.chat just press the `Broadcast my Camera` button. After that you will be prompted to login with a google account (you need to have streaming activated on your youtube account before, see [Introduction to live streaming](https://support.google.com/youtube/answer/2474026?hl=en) Google guide). You can also add a stream from Youtube with the stream link (The owner of the stream must allow the stream to be shown in other sites). To start a live stream from youtube, just add the link to it on the `Livestream source` form and hit save.