# Documentation Overview

<!-- - [SRT API Documents](#srt-api-documents)
- [Build Instructions](#build-instructions)
- [Development Documents](#development-documents)
- [Features](#features)
- [Sample Applications](#sample-applications)
- [Miscellaneous](#miscellaneous) -->

## SRT API Documents

| Document Title                                      |            Folder             | File Name                                          | Description                                          |
| :-------------------------------------------------- | :---------------------------- | :------------------------------------------------- | :--------------------------------------------------- |
| [SRT API](API/API.md)                               |          [API](API/)          | [API.md](API/API.md)                               | Detailed description of the SRT C API.               |
| [SRT API Functions](API/API-functions.md)           |          [API](API/)          | [API-functions.md](API/API-functions.md)           | Reference document for SRT API functions.            |
| [SRT API Socket Options](API/API-socket-options.md) |          [API](API/)          | [API-socket-options.md](API/API-socket-options.md) | Instructions and list of socket options for SRT API. |
| [SRT Statistics](API/statistics.md)                 |          [API](API/)          | [statistics.md](API/statistics.md)                 | How to use SRT socket and socket group statistics.   |
| <img width=200px height=1px/>                       | <img width=100px height=1px/> | <img width=200px height=1px/>                      | <img width=500px height=1px/>                        |

## Build Instructions

| Document Title                                     |            Folder             | File Name                                  | Description                                                  |
| :------------------------------------------------- | :---------------------------- | :----------------------------------------- | :----------------------------------------------------------- |
| [Building SRT for Android](build/build-android.md) |        [build](build/)        | [build-android.md](build/build-android.md) | SRT build instructions for Android.                          |
| [Building SRT for iOS](build/build-iOS.md)         |        [build](build/)        | [build-iOS.md](build/build-iOS.md)         | SRT build instructions for iOS.                              |
| [SRT Build Options](build/build-options.md)        |        [build](build/)        | [build-options.md](build/build-options.md) | Description of CMake build system, configure script, and<br />build options. |
| [Building SRT for Windows](build/build-win.md)     |        [build](build/)        | [build-win.md](build/build-win.md)         | SRT build instructions for Windows.                          |
| <img width=200px height=1px/>                      | <img width=100px height=1px/> | <img width=200px height=1px/>              | <img width=500px height=1px/>                                |

## Development Documents

| Document Title                                   |            Folder             | File Name                                        | Description                                                  |
| :----------------------------------------------- | :---------------------------- | :----------------------------------------------- | :----------------------------------------------------------- |
| [SRT Developer's Guide](dev/developers-guide.md) |          [dev](dev/)          | [developers-guide.md](dev/developers-guide.md)   | Development setup, project structure, coding rules,<br />submitting issues & PRs, etc. |
| [Low Level Info](dev/low-level-info.md)          |          [dev](dev/)          | [low-level-info.md](dev/low-level-info.md)       | Low level information for the SRT project (only<br />mutex locking). |
| [Making SRT Better](dev/making-srt-better.md)    |          [dev](dev/)          | [making-srt-better.md](dev/making-srt-better.md) | Guidelines for problem reporting, collecting debug logs<br />and pcaps. |
| <img width=200px height=1px/>                    | <img width=100px height=1px/> | <img width=200px height=1px/>                    | <img width=500px height=1px/>                                |

## Features

| Document Title                                               |            Folder             | File Name                                                    | Description                                                  |
| :----------------------------------------------------------- | :---------------------------- | :----------------------------------------------------------- | :----------------------------------------------------------- |
| [SRT Access Control](features/access-control.md)<br />[(Stream ID) Guidelines](features/access-control.md) |     [features](features/)     | [access-control.md](features/access-control.md)              | Access Control (Stream ID) guidelines.                       |
| [SRT Connection Bonding](features/bonding-intro.md)          |     [features](features/)     | [bonding-intro.md](features/bonding-intro.md)                | Introduction to Connection Bonding. Description<br />of group (bonded) connections. |
| [SRT Encryption](features/encryption.md)                     |     [features](features/)     | [encryption.md](features/encryption.md)                      | Description of SRT encryption mechanism. This<br />document might be outdated, please consult<br />[Section 6. Encryption](https://datatracker.ietf.org/doc/html/draft-sharabayko-srt-00#section-6) of the [SRT RFC](https://datatracker.ietf.org/doc/html/draft-sharabayko-srt-00) additionally. |
| [SRT Handshake](features/handshake.md)                       |     [features](features/)     | [handshake.md](features/handshake.md)                        | Description of SRT handshake mechanism. This<br />document might be outdated, please consult<br />[Section 3.2.1 Handshake](https://datatracker.ietf.org/doc/html/draft-sharabayko-srt-00#section-3.2.1) and<br />[Section 4.3 Handshake Messages](https://datatracker.ietf.org/doc/html/draft-sharabayko-srt-00#section-4.3) of the<br />[SRT RFC](https://datatracker.ietf.org/doc/html/draft-sharabayko-srt-00) additionally. |
| [Live Streaming](features/live-streaming.md)<br />[Guidelines](features/live-streaming.md) |     [features](features/)     | [live-streaming.md](features/live-streaming.md)              | Guidelines for live streaming with SRT. See also<br />best practices and configuration tips in<br />[Section 7.1 Live Streaming](https://datatracker.ietf.org/doc/html/draft-sharabayko-srt-00#section-7.1) of the [SRT RFC](https://datatracker.ietf.org/doc/html/draft-sharabayko-srt-00). |
| [SRT Packet](features/packet-filtering-and-fec.md)<br />[Filtering & FEC](features/packet-filtering-and-fec.md) |     [features](features/)     | [packet-filtering-and-fec.md](features/packet-filtering-and-fec.md) | Description of SRT packet filtering mechanism,<br />including FEC. |
| [SRT Socket Groups](features/socket-groups.md)               |     [features](features/)     | [socket-groups.md](features/socket-groups.md)                | Description of socket groups in SRT (Connection<br />Bonding). Here you will also find the information<br />regarding the `srt-test-live` application for testing<br />Connection Bonding. |
| <img width=200px height=1px/>                                | <img width=100px height=1px/> | <img width=200px height=1px/>                                | <img width=500px height=1px/>                                |

## Sample Applications

| Document Title                                               |            Folder             | File Name                                         | Description                                                  |
| :----------------------------------------------------------- | :---------------------------- | :------------------------------------------------ | :----------------------------------------------------------- |
| [Using the](apps/srt-live-transmit.md)<br />[`srt-live-transmit` App](apps/srt-live-transmit.md) |         [apps](apps/)         | [srt-live-transmit.md](apps/srt-live-transmit.md) | A sample application to transmit a live stream from<br />source medium (UDP/SRT/`stdin`) to the target medium<br />(UDP/SRT/`stdout`). |
| [Using the](apps/srt-multiplex.md)<br />[`srt-multiplex` App](apps/srt-multiplex.md) |         [apps](apps/)         | [srt-multiplex.md](apps/srt-multiplex.md)         | Description of sample program for sending multiple streams.  |
| [Using the](apps/srt-tunnel.md)<br />[`srt-tunnel` App](apps/srt-tunnel.md) |         [apps](apps/)         | [srt-tunnel.md](apps/srt-tunnel.md)               | A sample application to set up an SRT tunnel for TCP traffic. |
| <img width=200px height=1px/>                                | <img width=100px height=1px/> | <img width=200px height=1px/>                     | <img width=500px height=1px/>                                |

## Miscellaneous

| Document Title                                     |            Folder             | File Name                                             | Description                                                  |
| :------------------------------------------------- | :---------------------------- | :---------------------------------------------------- | :----------------------------------------------------------- |
| [Why SRT Was Created](misc/why-srt-was-created.md) |         [misc](misc/)         | [why-srt-was-created.md](misc/why-srt-was-created.md) | Background and history of SRT. See also<br />[Section 1. Introduction](https://datatracker.ietf.org/doc/html/draft-sharabayko-srt-00#section-1) of the [SRT RFC](https://datatracker.ietf.org/doc/html/draft-sharabayko-srt-00). |
| <img width=200px height=1px/>                      | <img width=100px height=1px/> | <img width=200px height=1px/>                         | <img width=500px height=1px/>                                |

