Auto merge of #27470 - asajeffrey:gst-plugin-readme-twitch, r=jdm

bors-servo · web-flow · commit 6499367fe244 · 2020-07-31T20:46:39.000-04:00
Added a recipe for streaming to twitch

&lt;!-- Please describe your changes on the following line: --&gt;

All the cool kids are doing it.

---
&lt;!-- Thank you for contributing to Servo! Please replace each `[ ]` by `[X]` when the step is complete, and replace `___` with appropriate data: --&gt;
- [x] `./mach build -d` does not report any errors
- [x] `./mach test-tidy` does not report any errors
- [x] These changes do not require tests because we don't test docs

&lt;!-- Also, please make sure that "Allow edits from maintainers" checkbox is checked, so that we can help you if you get stuck somewhere along the way.--&gt;

&lt;!-- Pull requests that do not address these steps are welcome, but they will require additional verification as part of the review process. --&gt;
diff --git a/ports/gstplugin/README.md b/ports/gstplugin/README.md
@@ -91,7 +91,7 @@ GST_PLUGIN_PATH=target/gstplugins \
 This requires the webxr content to support the `sessionavailable` event for launching directly into immersive mode.
 Values for `webxr` include `none`, `left-right`, `red-cyan`, `cubemap` and `spherical`.
 
-To stream a Hubs room and save to a file (there'll be ~30s black at the beginning while Hubs starts up):
+To stream a Hubs room to twitch (there'll be ~30s black at the beginning while Hubs starts up):
 ```
 GST_PLUGIN_PATH=$PWD/target/gstplugins \
   gst-launch-1.0 -e servowebsrc \
@@ -103,9 +103,10 @@ GST_PLUGIN_PATH=$PWD/target/gstplugins \
     ! glcolorconvert \
     ! gldownload \
     ! queue \
-    ! x264enc \
-    ! mp4mux \
-    ! filesink location=test.mp4
+    ! x264enc bitrate=4500 \
+    ! video/x-h264, profile=high \
+    ! flvmux streamable=true \
+    ! rtmpsink location="rtmp://$ENDPOINT.twitch.tv/app/$STREAM_KEY"
 ```
 
 *Note*: killing the gstreamer pipeline with control-C sometimes locks up macOS to the point
