Update README.md

This commit is contained in:
Fierelier 2023-11-01 00:45:19 +01:00
parent 4f2c7df83e
commit af3f6c8124
1 changed files with 5 additions and 5 deletions

View File

@ -9,11 +9,11 @@ Accepts data from stdin, and sends it to the specified server.
### Arguments
- **`user`**: Your user's name.
- **`user-password`**: Your user's password.
- **`channel`**: The channel you wanna stream to. Can be any name.
- **`channel-password`**: The channel's password.
- **`user-password`**: Your user's password.
- **`channel`**: The channel you wanna stream to. Can be any name. Defaults to default.
- **`channel-password`**: The channel's password. Can be any password. Defaults to no password.
All arguments are optional but for `user`.
All arguments are optional but for `user` and `user-password`.
### Example
`ffmpeg -f gdigrab -framerate 30 -i desktop -vf scale=-2:480 -c:v libx264 -pix_fmt yuv420p -maxrate 1M -f h264 - | fstream.py 127.0.0.1:61920 broadcast,user=fier,user-password=123,channel=exampleChannel,channel-password=456`
@ -55,4 +55,4 @@ Establish a TCP connection with the server, and send the payload. If the server
## The payload
Send the length of the payload as a 4-byte (32-bit) big endian unsigned integer, a null byte (hex:`00`) and a UTF-8 encoded string identifying the client's intentions follows, for example: `watch,user=fier,channel=exampleChannel,channel-password=123` or `broadcast,user=fier,user-password=123,channel=exampleChannel,channel-password=456`. The length includes only the string message, in bytes, it does not include the length itself, nor the null byte.
If you are a watcher, you will now be blasted with data. If you are a broadcaster, you can now blast data.
If you are a watcher, you will now be blasted with data. If you are a broadcaster, you can now blast data.