Knowledge Base > Streaming > RIST Protocol Streaming Guide

RIST Protocol Streaming Guide


Play RIST in OBS Studio

One can use either VLC Source or Media Source.
VLC restrictions: RIST will only work for receiving Simple Profile.
Media Source restrictions: RIST will only work for receiving Main Profile.

  • In a VLC Source in obs :

    • Add a Path/URL
    • RIST: enter the URL in the format rist://SERVER:PORT?cname=OBS&bandwidth=5000 where cname is whatever name you want (it just serves for logging and could be omitted) and bandwidth is the maximum bandwidth you expect in kbps (this is important for the resending of lost packets because the protocol will not go above that limit). Make sure the sender uses Simple Profile.
  • In a Media Source, uncheck 'Local File'.

    • For 'Input', enter the rist URL.
      • If the stream is received from a remote server, enter the URL in the format rist://SERVER:PORT?cname=OBS&bandwidth=5000 where cname is whatever name you want (it just serves for logging and could be omitted) and bandwidth is the maximum bandwidth you expect in kbps (this is important for the resending of lost packets because the protocol will not go above that limit).
      • If however the IP is that of the machine running OBS, use the syntax: rist://@LOCAL_IP:PORT?cname=OBS&bandwidth=5000. Note that on the receiver side, we place an @ sign in front of the destination address, because it is the receiver/host's own address.
    • For 'Input Format', enter mpegts.

Stream with RIST

  1. Go to Settings > Stream
  2. In the Service dropdown, select Custom.
  3. Enter the RIST URL in the form: rist://IP:port?cname=OBS&bandwidth=5000 where cname is whatever name you want (it just serves for logging and could be omitted) and bandwidth is the maximum bandwidth you expect in kbps (this is important for the resending of lost packets because the protocol will not go above that limit).
  4. Don't enter anything for the key. It's not used.

  • RIST options: OBS Studio will accept options in the syntax: rist://IP:port?option1=value1&option2=value2. The full list of options is listed here.
    • The most important options are: bandwidth, buffer and session-timeout.
    • For bandwidth, set the total bandwidth (video + audio) * 2 in kbps; this will allow recovery of up to 50 % packet loss.
    • buffer is in milliseconds. The buffer size will work best at four to seven times the ping time.