Add readme

parent 5f9fdf7c
# Build
Simple invoke `make` to build.
Build time dependencies are:
- gstreamer
Run time dependencies are:
- gstreamer-plugins-good
- gstreamer-plugins-rtp (might also already be in plugins-good)
# Usage
`REMOTE=some_host ./sender` for the equivalent pipeline to
```
gst-launch-1.0 rtpbin name=rtpbin \
pulsesrc ! avenc_g722 ! rtpg722pay ! rtpbin.send_rtp_sink_0 \
rtpbin.send_rtp_src_0 ! udpsink host=${REMOTE} port=5002\
rtpbin.send_rtcp_src_0 ! udpsink host=${REMOTE} port=5003 sync=false async=false \
udpsrc port=5007 ! rtpbin.recv_rtcp_sink_0
```
`REMOTE=some_host ./receiver` for the equivalent pipeline to
```
gst-launch-1.0 -v rtpbin name=rtpbin \
udpsrc caps="application/x-rtp,media=(string)audio,clock-rate=(int)8000,encoding-name=(string)G722" \
port=5002 ! rtpbin.recv_rtp_sink_1 \
rtpbin. ! rtpg722depay ! avdec_g722 ! pulsesink \
udpsrc port=5003 ! rtpbin.recv_rtcp_sink_1 \
rtpbin.send_rtcp_src_1 ! udpsink host=${REMOTE} port=5007 sync=false async=false
```
`REMOTE=some_host ./combined` for the combined sender and receiver pipelines.
You may also specify a codec to use by setting the environment variable =CODEC= (untested, but should work).
The following environment variables influence the programs behaviour:
- `REMOTE` to connect to a specified host (defaults to localhost if unset, so you can talk to yourself)
- `CODEC` to use a specific codec (see ()[gst-rfc3551.h] for available options, defaults to G722 if unset)
- `G_MESSAGES=all` to get all debugging messages from our code
- `GST_DEBUG=rtpbin:5` to get debugging messages from the rtpbin plugin (see GStreamer documentation)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment