Compare commits

...

2 Commits

Author SHA1 Message Date
8e99cd18f9 Add README. 2020-06-30 19:06:24 -07:00
59c8f3b3bf Rename webrtc-sendrecv.py to minimal-webrtc-host.py.
Also fix help description from --receiveAudioTo.
2020-06-30 19:05:49 -07:00
2 changed files with 46 additions and 1 deletions

43
README.md Normal file
View File

@ -0,0 +1,43 @@
# minimal-webrtc-gstreamer
GStreamer client for
[minimal-webrtc][https://git.aweirdimagination.net/perelman/minimal-webrtc].
Primarily intended for getting camera/microphone streams from a
smartphone into arbitrary GStreamer pipelines, but should be useful
generally as a GStreamer WebRTC example application.
Example usage:
```sh
./minimal-webrtc-host.py --url "https://apps.aweirdimagination.net/camera/" --receiveAudio --receiveVideo any
```
Note that by default test video and audio patterns are sent.
Use `--sendAudio false`/`--sendVideo false` to disable them.
Running that command will output a URL both as text and as a QR code to
give to the web browser to connect to.
```
usage: minimal-webrtc-host.py [-h] [--url URL] [--roomName ROOMNAME]
[--sendAudio SENDAUDIO] [--sendVideo SENDVIDEO]
[--receiveAudio] [--receiveVideo RECEIVEVIDEO]
[--receiveAudioTo RECEIVEAUDIOTO]
[--receiveVideoTo RECEIVEVIDEOTO]
optional arguments:
-h, --help show this help message and exit
--url URL URL from minimal-webrtc
--roomName ROOMNAME room name to host
--sendAudio SENDAUDIO
GStreamer audio pipeline to send
--sendVideo SENDVIDEO
GStreamer video pipeline to send
--receiveAudio Enable receiving audio
--receiveVideo RECEIVEVIDEO
Set video to receive ("screen", "environment",
"facing", "true", "false")
--receiveAudioTo RECEIVEAUDIOTO
"auto" or file path or device=DEVICE where DEVICE is a
PulseAudio sink to send received audio to
--receiveVideoTo RECEIVEVIDEOTO
"auto" or file path to send received video to
```

View File

@ -321,7 +321,9 @@ if __name__ == '__main__':
help='Set video to receive ("screen", '
+ '"environment", "facing", "true", "false")')
parser.add_argument('--receiveAudioTo', default=None,
help='"auto" or file path to send received audio to')
help='"auto" or file path or device=DEVICE '
+ 'where DEVICE is a PulseAudio sink '
+ 'to send received audio to ')
parser.add_argument('--receiveVideoTo', default=None,
help='"auto" or file path to send received video to')
args = parser.parse_args()