docs

Documentation Overview

SRT API Documents

Document Title	Folder	File Name	Description
SRT API	API	API.md	Detailed description of the SRT C API.
SRT API Functions	API	API-functions.md	Reference document for SRT API functions.
SRT API Socket Options	API	API-socket-options.md	Instructions and list of socket options for SRT API.
SRT Rejection Codes	API	rejection-codes.md	The list of SRT rejections codes.
SRT Statistics	API	statistics.md	How to use SRT socket and socket group statistics.
Configuration Guidelines	API	configuration-guidelines.md	How to configure SRT buffers.

Build Instructions

Document Title	Folder	File Name	Description
SRT Build Options	build	build-options.md	Description of CMake build system, configure script, and build options.
Building SRT on Linux (Ubuntu/CentOS)	build	build-linux.md	Build instructions for Linux (Ubuntu/CentOS).
Building SRT on Windows	build	build-win.md	Build instructions for Windows.
Building SRT on macOS	build	build-macOS.md	Build instructions for macOS.
Building SRT on iOS	build	build-iOS.md	Build instructions for iOS.
Building SRT on Android	build	build-android.md	Build instructions for Android.
Package Managers	build	package-managers.md	Package managers supporting SRT library.

Development Documents

Document Title	Folder	File Name	Description
SRT Developer's Guide	dev	developers-guide.md	Development setup, project structure, coding rules, submitting issues & PRs, etc.
Low Level Info	dev	low-level-info.md	Low level information for the SRT project (only mutex locking).
Making SRT Better	dev	making-srt-better.md	Guidelines for problem reporting, collecting debug logs and pcaps.

Features

Document Title	Folder	File Name	Description
SRT Access Control (Stream ID) Guidelines	features	access-control.md	Access Control (Stream ID) guidelines.
SRT Connection Bonding: Quick Start	features	bonding-quick-start.md	SRT Connection Bonding Quick Start.
SRT Connection Bonding: Introduction	features	bonding-intro.md	Introduction to Connection Bonding. Description of group (bonded) connections.
SRT Connection Bonding: Socket Groups	features	socket-groups.md	Description of socket groups in SRT (Connection Bonding). Here you will also find information regarding the srt-test-live application for testing Connection Bonding.
SRT Connection Bonding: Main/Backup	features	bonding-main-backup.md	Main/Backup mode description.
SRT Encryption	features	encryption.md	Description of SRT encryption mechanism. This document might be outdated, please consult Section 6. Encryption of the Internet Draft additionally.
SRT Handshake	features	handshake.md	Description of SRT handshake mechanism. This document might be outdated, please consult Section 3.2.1 Handshake and Section 4.3 Handshake Messages of the Internet Draft additionally.
Live Streaming Guidelines	features	live-streaming.md	Guidelines for live streaming with SRT. See also best practices and configuration tips in Section 7.1 Live Streaming of the Internet Draft.
SRT Packet Filtering & FEC	features	packet-filtering-and-fec.md	Description of SRT packet filtering mechanism, including FEC.

Sample Applications

Document Title	Folder	File Name	Description
Using the srt-live-transmit App	apps	srt-live-transmit.md	A sample application to transmit a live stream from source medium (UDP/SRT/stdin) to the target medium (UDP/SRT/stdout).
Using the srt-file-transmit App	apps	srt-file-transmit.md	A sample application to transmit a file over SRT
Using the srt-tunnel App	apps	srt-tunnel.md	A sample application to set up an SRT tunnel for TCP traffic.
Using the srt-test-multiplex App	apps	srt-test-multiplex.md	Testing application that allows to send multiple streams over one UDP link.
Using the srt-test-relay App	apps	srt-test-relay.md	Testing application for bidirectional stream sending over one connection.

Miscellaneous

Document Title	Folder	File Name	Description
Why SRT Was Created	misc	why-srt-was-created.md	Background and history of SRT. See also Section 1. Introduction of the Internet Draft.