revmischa / rtsp-server

Lightweight RTSP/RTP streaming media server
https://metacpan.org/release/RTSP-Server
427 stars 111 forks source link

README clarity issues for a RTSP newbie #16

Open xandark opened 7 years ago

xandark commented 7 years ago

I came to this project via this reference from ffmpeg. I am still learning about RTSP servers and I had some trouble figuring out the intent behind your README instructions.

In this line:

ffmpeg -re -i /input.avi -f rtsp -muxdelay 0.1 rtsp://12.34.56.78:5545/abc

it's not clear that 12.34.56.78 is the RTSP's server address. If it said "rtsp-server-address", it would be more understandable to someone like me, a newcomer.

Also, because I saw that 12.34.56.78 placeholder IP address, I just assumed that the /abc part was unnecessary. That tripped me up for the longest time because I left it off and couldn't figure out why this RTSP server was rejecting the requests. (And there was no log output even when I set --loglevel to 0, another issue.)

What is the /abc part? Is that a unique name for the stream? I'm getting tripped up again, and I am not sure that it's ffmpeg's fault for not running multiple simultaneous instances, or it's rtsp-server's issue for not being able to accept multiple streams.

If the docs said /abc is mandatory, changeable, and the name of the stream, that would help a lot.

Last point: in the README.md file, it says use "--sourceport" but that should say "--serverport".

revmischa commented 7 years ago

I believe the /abc is a mountpoint. Thanks for the feedback, if you have improvements to add please open a PR.