gortsplib

RTSP client and server library for the Go programming language, written for MediaMTX.

Go ≥ 1.26 is required.

Features:

• Client
  • Support secure protocol variants (RTSPS, SRTP, SRTCP)
  • Support tunneling (RTSP-over-HTTP, RTSP-over-WebSocket)
  • Query servers about available media streams
  • Read media streams from a server ("play")
    • Read streams with the UDP, UDP-multicast or TCP transport protocol
    • Switch transport protocol automatically
    • Read selected media streams
    • Pause or seek without disconnecting from the server
    • Write to ONVIF back channels
    • Get PTS (presentation timestamp) of inbound packets
    • Get NTP (absolute timestamp) of inbound packets
  • Write media streams to a server ("record")
    • Write streams with the UDP or TCP transport protocol
    • Switch transport protocol automatically
    • Pause without disconnecting from the server
• Server
  • Support secure protocol variants (RTSPS, SRTP, SRTCP)
  • Support tunneling (RTSP-over-HTTP, RTSP-over-WebSocket)
  • Handle requests from clients
  • Validate client credentials
  • Read media streams from clients ("record")
    • Read streams with the UDP or TCP transport protocol
    • Get PTS (presentation timestamp) of inbound packets
    • Get NTP (absolute timestamp) of inbound packets
  • Serve media streams to clients ("play")
    • Write streams with the UDP, UDP-multicast or TCP transport protocol
    • Compute and provide SSRC, RTP-Info to clients
    • Read ONVIF back channels
• Utilities
  • Parse RTSP elements
  • Encode/decode RTP packets into/from codec-specific frames

Table of contents

• Examples
• API Documentation
• RTP Payload Formats
• Specifications
• Related projects

Examples

• client-query
• client-play
• client-play-timestamp
• client-play-options
• client-play-pause
• client-play-backchannel
• client-play-format-av1
• client-play-format-av1-to-jpeg
• client-play-format-g711
• client-play-format-h264
• client-play-format-h264-to-jpeg
• client-play-format-h264-to-disk
• client-play-format-h264-mpeg4audio-to-disk
• client-play-format-h265
• client-play-format-h265-to-jpeg
• client-play-format-h265-to-disk
• client-play-format-lpcm
• client-play-format-mjpeg
• client-play-format-mpeg4audio
• client-play-format-mpeg4audio-to-disk
• client-play-format-opus
• client-play-format-opus-to-disk
• client-play-format-vp8
• client-play-format-vp9
• client-record-options
• client-record-pause
• client-record-format-av1
• client-record-format-g711
• client-record-format-h264
• client-record-format-h264-from-disk
• client-record-format-h265
• client-record-format-lpcm
• client-record-format-mjpeg
• client-record-format-mpeg4audio
• client-record-format-opus
• client-record-format-vp8
• client-record-format-vp9
• client-record-format-klv
• client-republish
• server
• server-secure
• server-auth
• server-record-format-h264-to-disk
• server-play-format-h264-from-disk
• server-play-backchannel
• proxy
• proxy-backchannel

API Documentation

Click to open the API Documentation

RTP Payload Formats

In RTSP, media streams are transmitted by using RTP packets, which are encoded in a specific, codec-dependent, format. This library supports the following formats:

Video

Audio

Other

Specifications

Related projects

• MediaMTX
• gohlslib
• gortmplib
• mediacommon
• pion/sdp (SDP library used internally)
• pion/rtp (RTP library used internally)
• pion/rtcp (RTCP library used internally)
• pion/srtp (SRTP library used internally)