gortsplib/README.md

gortsplib

RTSP 1.0 client and server library for the Go programming language, written for rtsp-simple-server.

Go ≥ 1.14 is required.

Features:

• Client
  • Query servers about available streams
  • Encrypt connections with TLS (RTSPS)
  • Read
    • Read streams from servers with UDP or TCP
    • Switch protocol automatically (switch to TCP in case of server error or UDP timeout)
    • Read only selected tracks of a stream
    • Pause reading without disconnecting from the server
    • Generate RTCP receiver reports automatically
  • Publish
    • Publish streams to servers with UDP or TCP
    • Switch protocol automatically (switch to TCP in case of server error)
    • Pause publishing without disconnecting from the server
    • Generate RTCP sender reports automatically
• Server
  • Handle requests from clients
  • Sessions and connections are independent; clients can control multiple sessions
  • Encrypt connections with TLS (RTSPS)
  • Read streams from clients with UDP or TCP
  • Write streams to clients with UDP or TCP
  • Generate RTCP receiver reports automatically
• Utilities
  • Encode and decode RTSP primitives, RTP/H264, RTP/AAC, SDP

Table of contents

• Examples
• API Documentation
• Links

Examples

• client-query
• client-read
• client-read-partial
• client-read-options
• client-read-pause
• client-read-h264
• client-publish
• client-publish-options
• client-publish-pause
• server
• server-tls

API Documentation

https://pkg.go.dev/github.com/aler9/gortsplib#pkg-index

Links

Related projects

• https://github.com/aler9/rtsp-simple-server
• https://github.com/pion/sdp (SDP library used internally)
• https://github.com/pion/rtcp (RTCP library used internally)
• https://github.com/pion/rtp (RTP library used internally)

IETF Standards

• RTSP 1.0 https://tools.ietf.org/html/rfc2326
• RTSP 2.0 https://tools.ietf.org/html/rfc7826
• HTTP 1.1 https://tools.ietf.org/html/rfc2616

Conventions

• https://github.com/golang-standards/project-layout