diff --git a/src/docs/assets/SharingAudio.mp4 b/src/docs/assets/SharingAudio.mp4 new file mode 100644 index 0000000..8936c8a Binary files /dev/null and b/src/docs/assets/SharingAudio.mp4 differ diff --git a/src/docs/assets/index.js b/src/docs/assets/index.js index 1fe9e3c..32fab61 100644 --- a/src/docs/assets/index.js +++ b/src/docs/assets/index.js @@ -17,6 +17,7 @@ import customTokens from "./CustomTokens.mp4"; import customTokensAdvanced from "./CustomTokensAdvanced.jpg"; import addPartyMember from "./AddPartyMember.mp4"; import changeNickname from "./ChangeNickname.mp4"; +import sharingAudio from "./SharingAudio.mp4"; export default { audioSharingFaq, @@ -38,4 +39,5 @@ export default { customTokensAdvanced, addPartyMember, changeNickname, + sharingAudio, }; diff --git a/src/docs/howTo/sharingAudio.md b/src/docs/howTo/sharingAudio.md index 1333ed7..d28df99 100644 --- a/src/docs/howTo/sharingAudio.md +++ b/src/docs/howTo/sharingAudio.md @@ -1 +1,13 @@ -TODO +While using Owlbear Rodeo you can share your computers audio to other party memebers. + +To accomplish this Owlbear Rodeo uses the audio portion of a browsers screen share support. This means that sharing audio relies on a browser that supports this functionality (currently this is Google Chrome and the new Microsoft Edge). What kind of audio you can share depends on the operating system you are using. Currently Google Chrome on Windows allows you to share the audio of any tab or an entire screen while on MacOS you can only share the audio of a tab. The limited support is why this feature is marked as experimental. + +`Note: Even though sharing audio requires a supported browser, receiving audio works on all browsers` + +To use audio sharing click the Start Radio Stream Button in the bottom left to open the Radio Screen then click Start Radio. The browser will then ask to share your screen, click on the Chrome Tab option and select your tab. Insure to select the Share Audio Checkbox and finally click Share. + +![Sharing Audio](sharingAudio) + +`Note: Although Owlbear Rodeo uses the screen sharing functionality, only your audio is sent to the other players in the party` + +To stop sharing your audio you can either click Stop on the share banner at the top of the screen or open the Radio Screen and click Stop Radio.