Skip to content
This repository was archived by the owner on Mar 6, 2025. It is now read-only.

Commit 81de9f8

Browse files
committed
doc
1 parent 8ed07e6 commit 81de9f8

File tree

3 files changed

+18
-88
lines changed

3 files changed

+18
-88
lines changed

README.md

+16-23
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ FFmpeg is used from Python `subprocess` to stream to sites including:
1313
* Facebook Live (requires FFmpeg >= 4.2 due to mandatory RTMPS)
1414
* YouTube Live
1515
* Twitch
16-
* also Ustream, Vimeo, Restream.io and more for streaming broadcasts.
16+
* also IBM Live Video, Vimeo, Restream.io and more for streaming broadcasts.
1717

1818
![PyLivestream diagram showing screen capture or camera simultaneously livestreaming to multiple services.](./doc/logo.png)
1919

@@ -160,20 +160,16 @@ python -m pylivestream.screen youtube ./pylivestream.json
160160

161161
### Facebook Live
162162

163-
Facebook Live requires FFmpeg >= 4.2 due to mandatory RTMPS
163+
Facebook Live requires FFmpeg ≥ 4.2 due to mandatory RTMPS.
164164

165-
1. configure your Facebook Live stream
165+
1. configure a Facebook Live stream
166166
2. Put [stream ID](https://www.facebook.com/live/create) into the JSON file
167167
3. Run Python script for Facebook with chosen input
168168

169169
```sh
170170
python -m pylivestream.screen facebook ./pylivestream.json
171171
```
172172

173-
### Twitter
174-
175-
TODO
176-
177173
### Twitch
178174

179175
Create stream from
@@ -257,37 +253,34 @@ python -m pylivestream.screen2disk myvid.avi ./pylivestream.json
257253

258254
## Notes
259255

260-
* Linux requires X11, not Wayland (choose at login)
261-
* `x11grab` was deprecated in FFmpeg 3.3, was previously replaced by `xcbgrab`
262-
* Reference [webpage](https://www.scivision.dev/youtube-live-ffmpeg-livestream/)
256+
Linux requires X11, not Wayland (choose at login).
257+
If Wayland is required, consider OBS Studio.
258+
[x11grab](https://ffmpeg.org/ffmpeg-devices.html#x11grab) is used for screen capture on Linux.
263259

264-
### FFmpeg References
265-
266-
* [streaming](https://trac.ffmpeg.org/wiki/EncodingForStreamingSites)
267-
* [camera](https://trac.ffmpeg.org/wiki/Capture/Webcam)
268-
* Camera [overlay](https://trac.ffmpeg.org/wiki/EncodingForStreamingSites#Withwebcamoverlay)
260+
* [FFmpeg streaming](https://trac.ffmpeg.org/wiki/EncodingForStreamingSites)
261+
* [FFmpeg camera](https://trac.ffmpeg.org/wiki/Capture/Webcam)
262+
* Camera [FFmpeg overlay](https://trac.ffmpeg.org/wiki/EncodingForStreamingSites#Withwebcamoverlay)
269263

270264
### Windows
271265

272266
* [gdigrab](https://ffmpeg.org/ffmpeg-devices.html#gdigrab)
273267

274-
DirectShow didn't work for me on Windows 10, so I used gdigrab instead.
268+
DirectShow didn't seem to work on Windows, so we used gdigrab instead.
275269

276270
* [DirectShow](https://trac.ffmpeg.org/wiki/DirectShow) device selection
277271
* DirectShow [examples](https://ffmpeg.org/ffmpeg-devices.html#Examples-4)
278272

279273
### Stream References
280274

281-
* [Twitch parameters](https://help.twitch.tv/customer/portal/articles/1253460-broadcast-requirements)
282-
* Twitch [ingest servers](https://stream.twitch.tv/ingests/)
283-
* Twitch [encoding](https://stream.twitch.tv/encoding/)
275+
* [X Live](https://help.x.com/en/using-x/x-live) doesn't give any specific settings.
276+
277+
* Twitch [ingest servers](https://dev.twitch.tv/docs/video-broadcast/)
278+
* Twitch [encoding](https://help.twitch.tv/s/article/broadcasting-guidelines)
284279

285-
* [Twitter Live parameters](https://help.twitter.com/en/using-twitter/twitter-live)
286280
* [YouTube Live parameters](https://support.google.com/youtube/answer/2853702)
287281
* [Facebook Live parameters](https://www.facebook.com/facebookmedia/get-started/live)
288-
* [Ustream parameters](https://support.ustream.tv/hc/en-us/articles/207852117-Internet-connection-and-recommended-encoding-settings)
289-
* Vimeo [config](https://help.vimeo.com/hc/en-us/articles/115012811168)
290-
* Vimeo [parameters](https://help.vimeo.com/hc/en-us/articles/115012811208-Encoder-guides)
282+
* [IBM Cloud Video parameters](https://support.video.ibm.com/hc/en-us/articles/207852117-Internet-connection-and-recommended-encoding-settings)
283+
* [Vimeo](https://help.vimeo.com/hc/en-us/articles/12426924775953-Encoder-guide)
291284

292285
### Logo Credits
293286

pyproject.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "pylivestream"
7-
description = "Livestream using FFmpeg to YouTube Live, Twitter, Facebook Live, Twitch, and more"
8-
keywords = ["youtube", "ffmpeg", "twitch", "twitter live", "facebook live", "restream.io"]
7+
description = "Livestream using FFmpeg to YouTube Live, X, Facebook Live, Twitch, and more"
8+
keywords = ["youtube", "ffmpeg", "twitch", "X", "facebook live", "restream.io"]
99
classifiers = [
1010
"Development Status :: 5 - Production/Stable",
1111
"Environment :: Console",

tests/no_audio.ini

-63
This file was deleted.

0 commit comments

Comments
 (0)