[ { "path": ".dockerignore", "content": "# do not add .git, since it is needed to extract the tag\n# do not add /binaries, since it is needed by Docker images\n/tmp\n/coverage*.txt\n/api/*.html\n/internal/core/VERSION\n/internal/servers/hls/hls.min.js\n/internal/staticsources/rpicamera/mtxrpicam_*/\n" }, { "path": ".github/DISCUSSION_TEMPLATE/questions.yml", "content": "body:\n - type: markdown\n attributes:\n value: |\n * Please create a discussion FOR EACH question. Do not ask for multiple questions all at once, otherwise they'll probably never get all answered.\n * If you are asking for help because you're having trouble doing something, provide enough informations to replicate the problem. In particular, include in the question:\n\n * MediaMTX version\n * precise instructions on how to replicate the problem\n * MediaMTX configuration\n * MediaMTX logs with setting `logLevel` set to `debug`\n\n * If you are asking for help and you think MediaMTX is misbehaving, open a bug report, NOT a discussion.\n\n - type: textarea\n attributes:\n label: Question\n validations:\n required: true\n" }, { "path": ".github/ISSUE_TEMPLATE/bug.yml", "content": "name: Bug report\ndescription: Report a bug\n\nbody:\n - type: markdown\n attributes:\n value: |\n To increase the chance of your bug getting fixed, open an issue FOR EACH bug. Do not report multiple problems in a single issue, otherwise they'll probably never get all fixed.\n\n - type: input\n id: version\n attributes:\n label: Which version are you using?\n description: MediaMTX version or commit\n validations:\n required: true\n\n - type: dropdown\n id: os\n attributes:\n label: Which operating system are you using?\n multiple: true\n options:\n - Linux amd64 standard\n - Linux amd64 Docker\n - Linux arm64 standard\n - Linux arm64 Docker\n - Linux arm7 standard\n - Linux arm7 Docker\n - Linux arm6 standard\n - Linux arm6 Docker\n - Windows amd64 standard\n - Windows amd64 Docker (WSL backend)\n - macOS amd64 standard\n - macOS amd64 Docker\n - Other (please describe)\n validations:\n required: true\n\n - type: textarea\n id: description\n attributes:\n label: Describe the issue\n validations:\n required: true\n\n - type: textarea\n id: replica\n attributes:\n label: Describe how to replicate the issue\n description: |\n The maintainers must be able to REPLICATE your issue to solve it - therefore, describe in a very detailed way how to replicate it.\n value: |\n 1. start the MediaMTX\n 2. publish with ...\n 3. read with ...\n validations:\n required: true\n\n - type: textarea\n id: conf\n attributes:\n label: MediaMTX configuration\n description: |\n MediaMTX configuration is often required to replicate the issue.\n placeholder: Paste the configuration file here\n render: yaml\n\n - type: textarea\n id: logs\n attributes:\n label: MediaMTX logs\n description: |\n MediaMTX logs are often useful to identify the issue. If you think this is the case, set 'logLevel' to 'debug' and attach logs.\n placeholder: Paste or drag the log file here\n\n - type: textarea\n id: network\n attributes:\n label: Packet dump\n description: |\n If the bug arises when using MediaMTX with external hardware or software, the most helpful information you can provide is a packet dump, that can be generated in this way:\n\n 1. In mediamtx.yml, set 'dumpPackets' to 'true'\n 2. Start the server and replicate the issue\n 3. Stop the server, find the generated .pcapng files in the current directory\n 4. Attach the pcapng files by dragging them here\n\n placeholder: Attach the pcapng files by dragging them here\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: false\n\ncontact_links:\n - name: Question\n url: https://github.com/bluenviron/mediamtx/discussions/new?category=questions\n about: Ask the community for help\n" }, { "path": ".github/ISSUE_TEMPLATE/feature.yml", "content": "name: Feature request\ndescription: Share ideas for new features\n\nbody:\n - type: markdown\n attributes:\n value: |\n Please create a request FOR EACH feature. Do not report multiple features in a single request, otherwise they'll probably never get all implemented.\n\n - type: textarea\n id: description\n attributes:\n label: Describe the feature\n validations:\n required: true\n" }, { "path": ".github/dependabot.yml", "content": "version: 2\nupdates:\n\n - package-ecosystem: \"gomod\"\n directory: \"/\"\n schedule:\n interval: \"daily\"\n\n - package-ecosystem: \"github-actions\"\n directory: \"/\"\n schedule:\n interval: \"daily\"\n" }, { "path": ".github/workflows/lint.yml", "content": "name: lint\n\non:\n push:\n branches: [ main ]\n pull_request:\n branches: [ main ]\n\njobs:\n go:\n runs-on: ubuntu-22.04\n\n steps:\n - uses: actions/checkout@v6\n with:\n fetch-depth: 0\n\n - uses: actions/setup-go@v6\n with:\n go-version: \"1.25\"\n\n - run: go generate ./...\n\n - uses: golangci/golangci-lint-action@v9\n with:\n version: v2.11.3\n\n go_mod:\n runs-on: ubuntu-22.04\n\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/setup-go@v6\n with:\n go-version: \"1.25\"\n\n - run: make lint-go-mod\n\n conf:\n runs-on: ubuntu-22.04\n\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/setup-go@v6\n with:\n go-version: \"1.25\"\n\n - run: make lint-conf\n\n go2api:\n runs-on: ubuntu-22.04\n\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/setup-go@v6\n with:\n go-version: \"1.25\"\n\n - run: make lint-go2api\n\n docs:\n runs-on: ubuntu-22.04\n\n steps:\n - uses: actions/checkout@v6\n\n - run: make lint-docs\n\n api_docs:\n runs-on: ubuntu-22.04\n\n steps:\n - uses: actions/checkout@v6\n\n - run: make lint-api-docs\n" }, { "path": ".github/workflows/nightly_binaries.yml", "content": "name: nightly_binaries\n\non:\n workflow_dispatch:\n\njobs:\n nightly_binaries:\n runs-on: ubuntu-22.04\n\n steps:\n - uses: actions/checkout@v6\n with:\n fetch-depth: 0\n\n - run: make binaries\n\n - uses: actions/upload-artifact@v7\n with:\n name: binaries\n path: binaries\n" }, { "path": ".github/workflows/release.yml", "content": "name: release\n\non:\n push:\n tags:\n - 'v*'\n\npermissions:\n id-token: write\n attestations: write\n artifact-metadata: write\n contents: write\n issues: write\n\njobs:\n binaries:\n runs-on: ubuntu-22.04\n\n steps:\n - uses: actions/checkout@v6\n\n - run: make binaries\n\n - run: cd binaries && sha256sum -b * > checksums.sha256\n\n - uses: actions/attest@v4\n with:\n subject-path: '${{ github.workspace }}/binaries/*'\n\n - uses: actions/upload-artifact@v7\n with:\n name: binaries\n path: binaries\n\n github_release:\n needs: binaries\n runs-on: ubuntu-22.04\n\n steps:\n - uses: actions/download-artifact@v8\n with:\n name: binaries\n path: binaries\n\n - uses: actions/github-script@v8\n with:\n github-token: ${{ secrets.GITHUB_TOKEN }}\n script: |\n const fs = require('fs').promises;\n const { repo: { owner, repo } } = context;\n\n const currentRelease = context.ref.split('/')[2];\n\n let body = `## New major features\\n`\n + `\\n`\n + `TODO\\n`\n + `\\n`\n + `## Fixes and improvements\\n`\n + `\\n`\n + `TODO\\n`\n + `\\n`\n + `## Security\\n`\n + `\\n`\n + `Binaries are compiled from source code by the [Release workflow](https://github.com/${owner}/${repo}/actions/workflows/release.yml), which is a fully-visible process that prevents any change or external interference in produced artifacts.\\n`\n + `\\n`\n + 'Checksums of binaries are also published in a public blockchain by using [GitHub Attestations](https://docs.github.com/en/actions/concepts/security/artifact-attestations), and they can be verified by running:\\n'\n + `\\n`\n + '```\\n'\n + `ls mediamtx_* | xargs -L1 gh attestation verify --repo bluenviron/mediamtx\\n`\n + '```\\n'\n + `\\n`\n + 'You can verify checksums of binaries by downloading `checksums.sha256` and running:\\n'\n + `\\n`\n + '```\\n'\n + `cat checksums.sha256 | grep \"$(ls mediamtx_*)\" | sha256sum --check\\n`\n + '```\\n'\n + `\\n`;\n\n const res = await github.rest.repos.createRelease({\n owner,\n repo,\n tag_name: currentRelease,\n name: currentRelease,\n body,\n });\n const release_id = res.data.id;\n\n for (const name of await fs.readdir('./binaries/')) {\n await github.rest.repos.uploadReleaseAsset({\n owner,\n repo,\n release_id,\n name,\n data: await fs.readFile(`./binaries/${name}`),\n });\n }\n\n github_notify_issues:\n needs: github_release\n runs-on: ubuntu-22.04\n\n steps:\n - uses: actions/github-script@v8\n with:\n github-token: ${{ secrets.GITHUB_TOKEN }}\n script: |\n const { repo: { owner, repo } } = context;\n\n const tags = await github.rest.repos.listTags({\n owner,\n repo,\n });\n\n const curTag = tags.data[0];\n const prevTag = tags.data[1];\n\n const diff = await github.rest.repos.compareCommitsWithBasehead({\n owner,\n repo,\n basehead: `${prevTag.commit.sha}...${curTag.commit.sha}`,\n });\n\n const issues = {};\n\n for (const commit of diff.data.commits) {\n for (const match of commit.commit.message.matchAll(/(^| |\\()#([0-9]+)( |\\)|$)/g)) {\n issues[match[2]] = 1;\n }\n }\n\n for (const issue in issues) {\n try {\n await github.rest.issues.createComment({\n owner,\n repo,\n issue_number: parseInt(issue),\n body: `This issue is mentioned in release ${curTag.name} 🚀\\n`\n + `Check out the entire changelog by [clicking here](https://github.com/${owner}/${repo}/releases/tag/${curTag.name})`,\n });\n } catch (exc) {\n console.error(exc.toString());\n }\n }\n\n dockerhub:\n needs: binaries\n runs-on: ubuntu-22.04\n\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/download-artifact@v8\n with:\n name: binaries\n path: binaries\n\n - run: make dockerhub\n env:\n DOCKER_USER: ${{ secrets.DOCKER_USER }}\n DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}\n" }, { "path": ".github/workflows/test.yml", "content": "name: test\n\non:\n push:\n branches: [ main ]\n pull_request:\n branches: [ main ]\n\njobs:\n test_64:\n runs-on: ubuntu-22.04\n\n steps:\n - uses: actions/checkout@v6\n with:\n fetch-depth: 0\n\n - run: make test\n\n - uses: codecov/codecov-action@v5\n with:\n token: ${{ secrets.CODECOV_TOKEN }}\n\n test_32:\n runs-on: ubuntu-22.04\n\n steps:\n - uses: actions/checkout@v6\n with:\n fetch-depth: 0\n\n - run: make test-32\n\n test_e2e:\n runs-on: ubuntu-22.04\n\n steps:\n - uses: actions/checkout@v6\n with:\n fetch-depth: 0\n\n - uses: actions/setup-go@v6\n with:\n go-version: \"1.25\"\n\n - run: make test-e2e-nodocker\n" }, { "path": ".gitignore", "content": "/tmp\n/binaries\n/coverage*.txt\n/api/*.html\n/internal/core/VERSION\n/internal/servers/hls/hls.min.js\n/internal/staticsources/rpicamera/mtxrpicam_*/\n" }, { "path": ".golangci.yml", "content": "version: \"2\"\n\nlinters:\n enable:\n - asciicheck\n - bidichk\n - bodyclose\n - copyloopvar\n - dupl\n - errorlint\n - gochecknoinits\n - gocritic\n - lll\n - misspell\n - modernize\n - nilerr\n - prealloc\n - predeclared\n - reassign\n - revive\n - usestdlibvars\n - unconvert\n - tparallel\n - wastedassign\n - whitespace\n\n settings:\n errcheck:\n exclude-functions:\n - io.Copy\n - (io.Closer).Close\n - (io.Writer).Write\n - (hash.Hash).Write\n - (net.Conn).Close\n - (net.Conn).SetReadDeadline\n - (net.Conn).SetWriteDeadline\n - (*net.TCPConn).SetKeepAlive\n - (*net.TCPConn).SetKeepAlivePeriod\n - (*net.TCPConn).SetNoDelay\n - (net.Listener).Close\n - (net.PacketConn).Close\n - (net.PacketConn).SetReadDeadline\n - (net.PacketConn).SetWriteDeadline\n - (net/http.ResponseWriter).Write\n - (*net/http.Server).Serve\n - (*net/http.Server).ServeTLS\n - (*net/http.Server).Shutdown\n - os.Chdir\n - os.Mkdir\n - os.MkdirAll\n - os.Remove\n - os.RemoveAll\n - os.Setenv\n - os.Unsetenv\n - (*os.File).WriteString\n - (*os.File).Close\n - (github.com/datarhei/gosrt.Conn).Close\n - (github.com/datarhei/gosrt.Conn).SetReadDeadline\n - (github.com/datarhei/gosrt.Conn).SetWriteDeadline\n - (*github.com/bluenviron/gortsplib/v5.Client).Close\n - (*github.com/bluenviron/gortsplib/v5.Server).Close\n - (*github.com/bluenviron/gortsplib/v5.ServerSession).Close\n - (*github.com/bluenviron/gortsplib/v5.ServerStream).Close\n - (*github.com/bluenviron/gortsplib/v5.ServerConn).Close\n\n govet:\n enable-all: true\n disable:\n - fieldalignment\n - reflectvaluecompare\n settings:\n shadow:\n strict: true\n\n modernize:\n disable:\n - reflecttypefor\n - stringsbuilder\n - testingcontext\n\nformatters:\n enable:\n - gofmt\n - gofumpt\n - goimports\n" }, { "path": "LICENSE", "content": "MIT License\n\nCopyright (c) 2019 aler9\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "Makefile", "content": "BASE_IMAGE = golang:1.25-alpine3.22\nGOLANGCI_LINT_IMAGE = golangci/golangci-lint:v2.11.3\nNODE_IMAGE = node:20-alpine3.22\n\n.PHONY: $(shell ls)\n\nhelp:\n\t@echo \"usage: make [action]\"\n\t@echo \"\"\n\t@echo \"available actions:\"\n\t@echo \"\"\n\t@echo \" format format code\"\n\t@echo \" test run tests\"\n\t@echo \" test-32 run tests on a 32-bit system\"\n\t@echo \" test-e2e run end-to-end tests\"\n\t@echo \" lint run linters\"\n\t@echo \" binaries build binaries for all supported platforms\"\n\t@echo \" dockerhub build and push images to Docker Hub\"\n\t@echo \"\"\n\nblank :=\ndefine NL\n\n$(blank)\nendef\n\ninclude scripts/*.mk\n" }, { "path": "README.md", "content": "

\n \n \"MediaMTX\"\n \n\n
\n
\n\n [![Website](https://img.shields.io/badge/website-mediamtx.org-1c94b5)](https://mediamtx.org)\n [![Test](https://github.com/bluenviron/mediamtx/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/bluenviron/mediamtx/actions/workflows/test.yml?query=branch%3Amain)\n [![Lint](https://github.com/bluenviron/mediamtx/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/bluenviron/mediamtx/actions/workflows/lint.yml?query=branch%3Amain)\n [![CodeCov](https://codecov.io/gh/bluenviron/mediamtx/branch/main/graph/badge.svg)](https://app.codecov.io/gh/bluenviron/mediamtx/tree/main)\n [![Release](https://img.shields.io/github/v/release/bluenviron/mediamtx)](https://github.com/bluenviron/mediamtx/releases)\n [![Docker Hub](https://img.shields.io/badge/docker-bluenviron/mediamtx-blue)](https://hub.docker.com/r/bluenviron/mediamtx)\n

\n\n
\n\n_MediaMTX_ is a ready-to-use and zero-dependency real-time media server and media proxy that allows to publish, read, proxy, record and playback video and audio streams. It has been conceived as a \"media router\" that routes media streams from one end to the other, with a focus on efficiency and portability.\n\n
\n\n |[Install](https://mediamtx.org/docs/kickoff/install)|[Documentation](https://mediamtx.org/docs/kickoff/introduction)|\n |-|-|\n\n
\n\n

Features

\n\n- [Publish](https://mediamtx.org/docs/usage/publish) live streams to the server with SRT, WebRTC, RTSP, RTMP, HLS, MPEG-TS, RTP, using FFmpeg, GStreamer, OBS Studio, Python , Golang, Unity, web browsers, Raspberry Pi Cameras and more.\n- [Read](https://mediamtx.org/docs/usage/read) live streams from the server with SRT, WebRTC, RTSP, RTMP, HLS, using FFmpeg, GStreamer, VLC, OBS Studio, Python , Golang, Unity, web browsers and more.\n- Streams are automatically converted from a protocol to another\n- Serve several streams at once in separate paths\n- Reload the configuration without disconnecting existing clients (hot reloading)\n- [Serve always-available streams](https://mediamtx.org/docs/usage/always-available) even when the publisher is offline\n- [Record](https://mediamtx.org/docs/usage/record) streams to disk in fMP4 or MPEG-TS format\n- [Playback](https://mediamtx.org/docs/usage/playback) recorded streams\n- [Authenticate](https://mediamtx.org/docs/usage/authentication) users with internal, HTTP or JWT authentication\n- [Forward](https://mediamtx.org/docs/usage/forward) streams to other servers\n- [Proxy](https://mediamtx.org/docs/usage/proxy) requests to other servers\n- [Control](https://mediamtx.org/docs/usage/control-api) the server through the Control API\n- [Extract metrics](https://mediamtx.org/docs/usage/metrics) from the server in a Prometheus-compatible format\n- [Monitor performance](https://mediamtx.org/docs/usage/performance) to investigate CPU and RAM consumption\n- [Run hooks](https://mediamtx.org/docs/usage/hooks) (external commands) when clients connect, disconnect, read or publish streams\n- Compatible with Linux, Windows and macOS, does not require any dependency or interpreter, it's a single executable\n- ...and many [others](https://mediamtx.org/docs/kickoff/introduction).\n" }, { "path": "SECURITY.md", "content": "# Security\n\nCheck the [Security page](https://mediamtx.org/docs/other/security) on the website.\n" }, { "path": "api/.redocly.yaml", "content": "extends:\n - recommended\n\nrules:\n operation-4xx-response: off\n" }, { "path": "api/openapi.yaml", "content": "openapi: 3.0.0\n\ninfo:\n version: 1.0.0\n title: MediaMTX API\n description: API of MediaMTX, a server and proxy that supports various protocols.\n license:\n name: MIT\n url: https://opensource.org/licenses/MIT\n\nservers:\n - url: http://localhost:9997\n\nsecurity: []\n\ncomponents:\n schemas:\n OKStatus:\n type: string\n enum: [ok]\n\n ErrorStatus:\n type: string\n enum: [error]\n\n PathSourceType:\n type: string\n enum:\n - hlsSource\n - redirect\n - rpiCameraSource\n - rtmpConn\n - rtmpsConn\n - rtmpSource\n - rtspSession\n - rtspSource\n - rtspsSession\n - srtConn\n - srtSource\n - mpegtsSource\n - rtpSource\n - webRTCSession\n - webRTCSource\n\n PathReaderType:\n type: string\n enum:\n - hlsMuxer\n - rpiCameraSecondary\n - rtmpConn\n - rtmpsConn\n - rtspConn\n - rtspSession\n - rtspsConn\n - rtspsSession\n - srtConn\n - webRTCSession\n\n PathTrackCodec:\n type: string\n enum:\n - AV1\n - VP9\n - VP8\n - H265\n - H264\n - MPEG-4 Video\n - MPEG-1 Video\n - MJPEG\n - Opus\n - Vorbis\n - MPEG-4 Audio\n - MPEG-4 Audio LATM\n - MPEG-1 Audio\n - AC3\n - Speex\n - G726\n - G722\n - G711\n - LPCM\n - MPEG-TS\n - KLV\n - Generic\n\n AlwaysAvailableTrackCodec:\n type: string\n enum:\n - AV1\n - VP9\n - H265\n - H264\n - MPEG4Audio\n - Opus\n - G711\n - LPCM\n\n AuthAction:\n type: string\n enum:\n - publish\n - read\n - playback\n - api\n - metrics\n - pprof\n\n AuthMethod:\n type: string\n enum: [internal, http, jwt]\n\n Encryption:\n type: string\n enum: [no, optional, strict]\n\n HLSVariant:\n type: string\n enum: [mpegts, fmp4, lowLatency]\n\n LogDestination:\n type: string\n enum: [stdout, file, syslog]\n\n LogLevel:\n type: string\n enum: [error, warn, info, debug]\n\n RecordFormat:\n type: string\n enum: [fmp4, mpegts]\n\n RTSPAuthMethod:\n type: string\n enum: [basic, digest]\n\n RTSPRangeType:\n type: string\n enum: ['', clock, npt, smpte]\n\n RTSPTransport:\n type: string\n enum: [udp, multicast, tcp, automatic]\n\n RTMPConnState:\n type: string\n enum: [idle, read, publish]\n\n RTSPSessionState:\n type: string\n enum: [idle, read, publish]\n\n SRTConnState:\n type: string\n enum: [idle, read, publish]\n\n WebRTCSessionState:\n type: string\n enum: [read, publish]\n\n OK:\n type: object\n properties:\n status:\n $ref: '#/components/schemas/OKStatus'\n\n Error:\n type: object\n properties:\n status:\n $ref: '#/components/schemas/ErrorStatus'\n error:\n type: string\n\n Info:\n type: object\n properties:\n version:\n type: string\n started:\n type: string\n\n AuthInternalUser:\n type: object\n properties:\n user:\n type: string\n pass:\n type: string\n ips:\n type: array\n items:\n type: string\n permissions:\n type: array\n items:\n $ref: '#/components/schemas/AuthInternalUserPermission'\n\n AuthInternalUserPermission:\n type: object\n properties:\n action:\n $ref: '#/components/schemas/AuthAction'\n path:\n type: string\n\n GlobalConf:\n type: object\n properties:\n # General\n logLevel:\n $ref: '#/components/schemas/LogLevel'\n logDestinations:\n type: array\n items:\n $ref: '#/components/schemas/LogDestination'\n logStructured:\n type: boolean\n logFile:\n type: string\n sysLogPrefix:\n type: string\n dumpPackets:\n type: boolean\n readTimeout:\n type: string\n writeTimeout:\n type: string\n readBufferCount:\n type: integer\n format: int64\n nullable: true\n deprecated: true\n writeQueueSize:\n type: integer\n format: int64\n udpMaxPayloadSize:\n type: integer\n format: int64\n udpReadBufferSize:\n type: integer\n format: uint64\n runOnConnect:\n type: string\n runOnConnectRestart:\n type: boolean\n runOnDisconnect:\n type: string\n\n # Authentication\n authMethod:\n $ref: '#/components/schemas/AuthMethod'\n authInternalUsers:\n type: array\n items:\n $ref: '#/components/schemas/AuthInternalUser'\n authHTTPAddress:\n type: string\n externalAuthenticationURL:\n type: string\n nullable: true\n deprecated: true\n authHTTPFingerprint:\n type: string\n authHTTPExclude:\n type: array\n items:\n $ref: '#/components/schemas/AuthInternalUserPermission'\n authJWTJWKS:\n type: string\n authJWTJWKSFingerprint:\n type: string\n authJWTClaimKey:\n type: string\n authJWTIssuer:\n type: string\n authJWTAudience:\n type: string\n authJWTExclude:\n type: array\n items:\n $ref: '#/components/schemas/AuthInternalUserPermission'\n authJWTInHTTPQuery:\n type: boolean\n\n # Control API\n api:\n type: boolean\n apiAddress:\n type: string\n apiEncryption:\n type: boolean\n apiServerKey:\n type: string\n apiServerCert:\n type: string\n apiAllowOrigin:\n type: string\n nullable: true\n deprecated: true\n apiAllowOrigins:\n type: array\n items:\n type: string\n apiTrustedProxies:\n type: array\n items:\n type: string\n\n # Metrics\n metrics:\n type: boolean\n metricsAddress:\n type: string\n metricsEncryption:\n type: boolean\n metricsServerKey:\n type: string\n metricsServerCert:\n type: string\n metricsAllowOrigin:\n type: string\n nullable: true\n deprecated: true\n metricsAllowOrigins:\n type: array\n items:\n type: string\n metricsTrustedProxies:\n type: array\n items:\n type: string\n\n # PPROF\n pprof:\n type: boolean\n pprofAddress:\n type: string\n pprofEncryption:\n type: boolean\n pprofServerKey:\n type: string\n pprofServerCert:\n type: string\n pprofAllowOrigin:\n type: string\n nullable: true\n deprecated: true\n pprofAllowOrigins:\n type: array\n items:\n type: string\n pprofTrustedProxies:\n type: array\n items:\n type: string\n\n # Playback server\n playback:\n type: boolean\n playbackAddress:\n type: string\n playbackEncryption:\n type: boolean\n playbackServerKey:\n type: string\n playbackServerCert:\n type: string\n playbackAllowOrigin:\n type: string\n nullable: true\n deprecated: true\n playbackAllowOrigins:\n type: array\n items:\n type: string\n playbackTrustedProxies:\n type: array\n items:\n type: string\n\n # RTSP server\n rtsp:\n type: boolean\n rtspDisable:\n type: boolean\n nullable: true\n deprecated: true\n protocols:\n type: array\n nullable: true\n items:\n type: string\n enum: [udp, multicast, tcp]\n deprecated: true\n rtspTransports:\n type: array\n items:\n type: string\n enum: [udp, multicast, tcp]\n encryption:\n type: string\n nullable: true\n deprecated: true\n allOf:\n - $ref: '#/components/schemas/Encryption'\n rtspEncryption:\n $ref: '#/components/schemas/Encryption'\n rtspAddress:\n type: string\n rtspsAddress:\n type: string\n rtpAddress:\n type: string\n rtcpAddress:\n type: string\n multicastIPRange:\n type: string\n multicastRTPPort:\n type: integer\n format: int64\n multicastRTCPPort:\n type: integer\n format: int64\n srtpAddress:\n type: string\n srtcpAddress:\n type: string\n multicastSRTPPort:\n type: integer\n format: int64\n multicastSRTCPPort:\n type: integer\n format: int64\n rtspServerKey:\n type: string\n rtspServerCert:\n type: string\n authMethods:\n type: array\n nullable: true\n items:\n $ref: '#/components/schemas/RTSPAuthMethod'\n deprecated: true\n rtspAuthMethods:\n type: array\n items:\n $ref: '#/components/schemas/RTSPAuthMethod'\n rtspUDPReadBufferSize:\n type: integer\n format: uint64\n nullable: true\n deprecated: true\n\n # RTMP server\n rtmp:\n type: boolean\n rtmpDisable:\n type: boolean\n nullable: true\n deprecated: true\n rtmpEncryption:\n $ref: '#/components/schemas/Encryption'\n rtmpAddress:\n type: string\n rtmpsAddress:\n type: string\n rtmpServerKey:\n type: string\n rtmpServerCert:\n type: string\n\n # HLS server\n hls:\n type: boolean\n hlsDisable:\n type: boolean\n nullable: true\n deprecated: true\n hlsAddress:\n type: string\n hlsEncryption:\n type: boolean\n hlsServerKey:\n type: string\n hlsServerCert:\n type: string\n hlsAllowOrigin:\n type: string\n nullable: true\n deprecated: true\n hlsAllowOrigins:\n type: array\n items:\n type: string\n hlsTrustedProxies:\n type: array\n items:\n type: string\n hlsAlwaysRemux:\n type: boolean\n hlsVariant:\n $ref: '#/components/schemas/HLSVariant'\n hlsSegmentCount:\n type: integer\n format: int64\n hlsSegmentDuration:\n type: string\n hlsPartDuration:\n type: string\n hlsSegmentMaxSize:\n type: string\n hlsDirectory:\n type: string\n hlsMuxerCloseAfter:\n type: string\n\n # WebRTC server\n webrtc:\n type: boolean\n webrtcDisable:\n type: boolean\n nullable: true\n deprecated: true\n webrtcAddress:\n type: string\n webrtcEncryption:\n type: boolean\n webrtcServerKey:\n type: string\n webrtcServerCert:\n type: string\n webrtcAllowOrigin:\n type: string\n nullable: true\n deprecated: true\n webrtcAllowOrigins:\n type: array\n items:\n type: string\n webrtcTrustedProxies:\n type: array\n items:\n type: string\n webrtcLocalUDPAddress:\n type: string\n webrtcLocalTCPAddress:\n type: string\n webrtcIPsFromInterfaces:\n type: boolean\n webrtcIPsFromInterfacesList:\n type: array\n items:\n type: string\n webrtcAdditionalHosts:\n type: array\n items:\n type: string\n webrtcICEServers2:\n type: array\n items:\n $ref: '#/components/schemas/WebRTCICEServer'\n webrtcSTUNGatherTimeout:\n type: string\n webrtcHandshakeTimeout:\n type: string\n webrtcTrackGatherTimeout:\n type: string\n webrtcICEUDPMuxAddress:\n type: string\n nullable: true\n deprecated: true\n webrtcICETCPMuxAddress:\n type: string\n nullable: true\n deprecated: true\n webrtcICEHostNAT1To1IPs:\n type: array\n nullable: true\n items:\n type: string\n deprecated: true\n webrtcICEServers:\n type: array\n nullable: true\n items:\n type: string\n deprecated: true\n\n # SRT server\n srt:\n type: boolean\n srtAddress:\n type: string\n\n # Record (deprecated)\n record:\n type: boolean\n nullable: true\n deprecated: true\n recordPath:\n type: string\n nullable: true\n deprecated: true\n recordFormat:\n type: string\n nullable: true\n deprecated: true\n allOf:\n - $ref: '#/components/schemas/RecordFormat'\n recordPartDuration:\n type: string\n nullable: true\n deprecated: true\n recordSegmentDuration:\n type: string\n nullable: true\n deprecated: true\n recordDeleteAfter:\n type: string\n nullable: true\n deprecated: true\n\n PathConf:\n type: object\n properties:\n name:\n type: string\n\n # General\n source:\n type: string\n sourceFingerprint:\n type: string\n sourceOnDemand:\n type: boolean\n sourceOnDemandStartTimeout:\n type: string\n sourceOnDemandCloseAfter:\n type: string\n maxReaders:\n type: integer\n format: int64\n srtReadPassphrase:\n type: string\n fallback:\n type: string\n nullable: true\n deprecated: true\n useAbsoluteTimestamp:\n type: boolean\n\n # Always available\n alwaysAvailable:\n type: boolean\n alwaysAvailableTracks:\n type: array\n items:\n $ref: '#/components/schemas/AlwaysAvailableTrack'\n alwaysAvailableFile:\n type: string\n\n # Record\n record:\n type: boolean\n playback:\n type: boolean\n nullable: true\n deprecated: true\n recordPath:\n type: string\n recordFormat:\n $ref: '#/components/schemas/RecordFormat'\n recordPartDuration:\n type: string\n recordMaxPartSize:\n type: string\n recordSegmentDuration:\n type: string\n recordDeleteAfter:\n type: string\n\n # Authentication (deprecated)\n publishUser:\n type: string\n nullable: true\n deprecated: true\n publishPass:\n type: string\n nullable: true\n deprecated: true\n publishIPs:\n type: array\n nullable: true\n items:\n type: string\n deprecated: true\n readUser:\n type: string\n nullable: true\n deprecated: true\n readPass:\n type: string\n nullable: true\n deprecated: true\n readIPs:\n type: array\n nullable: true\n items:\n type: string\n deprecated: true\n\n # Publisher source\n overridePublisher:\n type: boolean\n disablePublisherOverride:\n type: boolean\n nullable: true\n deprecated: true\n srtPublishPassphrase:\n type: string\n rtspDemuxMpegts:\n type: boolean\n\n # RTSP source\n rtspTransport:\n $ref: '#/components/schemas/RTSPTransport'\n rtspAnyPort:\n type: boolean\n sourceProtocol:\n type: string\n nullable: true\n deprecated: true\n allOf:\n - $ref: '#/components/schemas/RTSPTransport'\n sourceAnyPortEnable:\n type: boolean\n nullable: true\n deprecated: true\n rtspRangeType:\n $ref: '#/components/schemas/RTSPRangeType'\n rtspRangeStart:\n type: string\n rtspUDPReadBufferSize:\n type: integer\n format: uint64\n nullable: true\n deprecated: true\n rtspUDPSourcePortRange:\n type: array\n minItems: 2\n maxItems: 2\n items:\n type: integer\n format: uint64\n\n # MPEG-TS source\n mpegtsUDPReadBufferSize:\n type: integer\n format: uint64\n nullable: true\n deprecated: true\n\n # RTP source\n rtpSDP:\n type: string\n rtpUDPReadBufferSize:\n type: integer\n format: uint64\n nullable: true\n deprecated: true\n\n # WHEP source\n whepBearerToken:\n type: string\n whepSTUNGatherTimeout:\n type: string\n whepHandshakeTimeout:\n type: string\n whepTrackGatherTimeout:\n type: string\n\n # Redirect source\n sourceRedirect:\n type: string\n\n # Raspberry Pi Camera source\n rpiCameraCamID:\n type: integer\n format: uint64\n rpiCameraSecondary:\n type: boolean\n rpiCameraWidth:\n type: integer\n format: uint64\n rpiCameraHeight:\n type: integer\n format: uint64\n rpiCameraHFlip:\n type: boolean\n rpiCameraVFlip:\n type: boolean\n rpiCameraBrightness:\n type: number\n format: double\n rpiCameraContrast:\n type: number\n format: double\n rpiCameraSaturation:\n type: number\n format: double\n rpiCameraSharpness:\n type: number\n format: double\n rpiCameraExposure:\n type: string\n rpiCameraAWB:\n type: string\n rpiCameraAWBGains:\n type: array\n minItems: 2\n maxItems: 2\n items:\n type: number\n format: double\n rpiCameraDenoise:\n type: string\n rpiCameraShutter:\n type: integer\n format: uint64\n rpiCameraMetering:\n type: string\n rpiCameraGain:\n type: number\n format: double\n rpiCameraEV:\n type: number\n format: double\n rpiCameraROI:\n type: string\n rpiCameraHDR:\n type: boolean\n rpiCameraTuningFile:\n type: string\n rpiCameraMode:\n type: string\n rpiCameraFPS:\n type: number\n format: double\n rpiCameraAfMode:\n type: string\n rpiCameraAfRange:\n type: string\n rpiCameraAfSpeed:\n type: string\n rpiCameraLensPosition:\n type: number\n format: double\n rpiCameraAfWindow:\n type: string\n rpiCameraFlickerPeriod:\n type: integer\n format: uint64\n rpiCameraTextOverlayEnable:\n type: boolean\n rpiCameraTextOverlay:\n type: string\n rpiCameraCodec:\n type: string\n rpiCameraIDRPeriod:\n type: integer\n format: uint64\n rpiCameraBitrate:\n type: integer\n format: uint64\n rpiCameraProfile:\n type: string\n nullable: true\n deprecated: true\n rpiCameraLevel:\n type: string\n nullable: true\n deprecated: true\n rpiCameraHardwareH264Profile:\n type: string\n rpiCameraHardwareH264Level:\n type: string\n rpiCameraSoftwareH264Profile:\n type: string\n rpiCameraSoftwareH264Level:\n type: string\n rpiCameraJPEGQuality:\n type: integer\n format: uint64\n nullable: true\n deprecated: true\n rpiCameraMJPEGQuality:\n type: integer\n format: uint64\n\n # Hooks\n runOnInit:\n type: string\n runOnInitRestart:\n type: boolean\n runOnDemand:\n type: string\n runOnDemandRestart:\n type: boolean\n runOnDemandStartTimeout:\n type: string\n runOnDemandCloseAfter:\n type: string\n runOnUnDemand:\n type: string\n runOnReady:\n type: string\n runOnReadyRestart:\n type: boolean\n runOnNotReady:\n type: string\n runOnRead:\n type: string\n runOnReadRestart:\n type: boolean\n runOnUnread:\n type: string\n runOnRecordSegmentCreate:\n type: string\n runOnRecordSegmentComplete:\n type: string\n\n PathConfList:\n type: object\n properties:\n pageCount:\n type: integer\n format: int64\n itemCount:\n type: integer\n format: int64\n items:\n type: array\n items:\n $ref: '#/components/schemas/PathConf'\n\n Path:\n type: object\n properties:\n name:\n type: string\n confName:\n type: string\n source:\n type: object\n nullable: true\n allOf:\n - $ref: '#/components/schemas/PathSource'\n ready:\n type: boolean\n deprecated: true\n readyTime:\n type: string\n nullable: true\n deprecated: true\n available:\n type: boolean\n availableTime:\n type: string\n nullable: true\n online:\n type: boolean\n onlineTime:\n type: string\n nullable: true\n tracks:\n type: array\n deprecated: true\n items:\n $ref: '#/components/schemas/PathTrackCodec'\n tracks2:\n type: array\n items:\n $ref: '#/components/schemas/PathTrack'\n inboundBytes:\n type: integer\n format: uint64\n outboundBytes:\n type: integer\n format: uint64\n inboundFramesInError:\n type: integer\n format: uint64\n bytesReceived:\n type: integer\n format: uint64\n deprecated: true\n bytesSent:\n type: integer\n format: uint64\n deprecated: true\n readers:\n type: array\n items:\n $ref: '#/components/schemas/PathReader'\n\n PathList:\n type: object\n properties:\n pageCount:\n type: integer\n format: int64\n itemCount:\n type: integer\n format: int64\n items:\n type: array\n items:\n $ref: '#/components/schemas/Path'\n\n PathSource:\n type: object\n properties:\n type:\n $ref: '#/components/schemas/PathSourceType'\n id:\n type: string\n\n PathReader:\n type: object\n properties:\n type:\n $ref: '#/components/schemas/PathReaderType'\n id:\n type: string\n\n PathTrack:\n type: object\n properties:\n codec:\n $ref: '#/components/schemas/PathTrackCodec'\n codecProps:\n type: object\n nullable: true\n allOf:\n - $ref: '#/components/schemas/PathTrackCodecProps'\n\n PathTrackCodecProps:\n oneOf:\n - $ref: '#/components/schemas/PathTrackCodecPropsAV1'\n - $ref: '#/components/schemas/PathTrackCodecPropsVP9'\n - $ref: '#/components/schemas/PathTrackCodecPropsH265'\n - $ref: '#/components/schemas/PathTrackCodecPropsH264'\n - $ref: '#/components/schemas/PathTrackCodecPropsOpus'\n - $ref: '#/components/schemas/PathTrackCodecPropsMPEG4Audio'\n - $ref: '#/components/schemas/PathTrackCodecPropsAC3'\n - $ref: '#/components/schemas/PathTrackCodecPropsG711'\n - $ref: '#/components/schemas/PathTrackCodecPropsLPCM'\n\n PathTrackCodecPropsAV1:\n type: object\n properties:\n width:\n type: integer\n format: int64\n height:\n type: integer\n format: int64\n profile:\n type: integer\n format: int64\n level:\n type: integer\n format: int64\n tier:\n type: integer\n format: int64\n PathTrackCodecPropsVP9:\n type: object\n properties:\n profile:\n type: integer\n format: int64\n\n PathTrackCodecPropsH265:\n type: object\n properties:\n width:\n type: integer\n format: int64\n height:\n type: integer\n format: int64\n profile:\n type: string\n level:\n type: string\n\n PathTrackCodecPropsH264:\n type: object\n properties:\n width:\n type: integer\n format: int64\n height:\n type: integer\n format: int64\n profile:\n type: string\n level:\n type: string\n\n PathTrackCodecPropsOpus:\n type: object\n properties:\n channelCount:\n type: integer\n format: int64\n\n PathTrackCodecPropsMPEG4Audio:\n type: object\n properties:\n sampleRate:\n type: integer\n format: int64\n channelCount:\n type: integer\n format: int64\n\n PathTrackCodecPropsAC3:\n type: object\n properties:\n sampleRate:\n type: integer\n format: int64\n channelCount:\n type: integer\n format: int64\n\n PathTrackCodecPropsG711:\n type: object\n properties:\n muLaw:\n type: boolean\n sampleRate:\n type: integer\n format: int64\n channelCount:\n type: integer\n format: int64\n\n PathTrackCodecPropsLPCM:\n type: object\n properties:\n bitDepth:\n type: integer\n format: int64\n sampleRate:\n type: integer\n format: int64\n channelCount:\n type: integer\n format: int64\n\n HLSMuxer:\n type: object\n properties:\n path:\n type: string\n created:\n type: string\n lastRequest:\n type: string\n outboundBytes:\n type: integer\n format: uint64\n outboundFramesDiscarded:\n type: integer\n format: uint64\n bytesSent:\n type: integer\n format: uint64\n deprecated: true\n\n HLSMuxerList:\n type: object\n properties:\n pageCount:\n type: integer\n format: int64\n itemCount:\n type: integer\n format: int64\n items:\n type: array\n items:\n $ref: '#/components/schemas/HLSMuxer'\n\n Recording:\n type: object\n properties:\n name:\n type: string\n segments:\n type: array\n items:\n $ref: '#/components/schemas/RecordingSegment'\n\n RecordingList:\n type: object\n properties:\n pageCount:\n type: integer\n format: int64\n itemCount:\n type: integer\n format: int64\n items:\n type: array\n items:\n $ref: '#/components/schemas/Recording'\n\n RecordingSegment:\n type: object\n properties:\n start:\n type: string\n\n RTMPConn:\n type: object\n properties:\n id:\n type: string\n format: uuid\n created:\n type: string\n remoteAddr:\n type: string\n state:\n $ref: '#/components/schemas/RTMPConnState'\n path:\n type: string\n query:\n type: string\n user:\n type: string\n inboundBytes:\n type: integer\n format: uint64\n outboundBytes:\n type: integer\n format: uint64\n outboundFramesDiscarded:\n type: integer\n format: uint64\n bytesReceived:\n type: integer\n format: uint64\n deprecated: true\n bytesSent:\n type: integer\n format: uint64\n deprecated: true\n\n RTMPConnList:\n type: object\n properties:\n pageCount:\n type: integer\n format: int64\n itemCount:\n type: integer\n format: int64\n items:\n type: array\n items:\n $ref: '#/components/schemas/RTMPConn'\n\n RTSPConn:\n type: object\n properties:\n id:\n type: string\n format: uuid\n created:\n type: string\n remoteAddr:\n type: string\n session:\n type: string\n format: uuid\n nullable: true\n tunnel:\n type: string\n inboundBytes:\n type: integer\n format: uint64\n outboundBytes:\n type: integer\n format: uint64\n bytesReceived:\n type: integer\n format: uint64\n deprecated: true\n bytesSent:\n type: integer\n format: uint64\n deprecated: true\n\n RTSPConnList:\n type: object\n properties:\n pageCount:\n type: integer\n format: int64\n itemCount:\n type: integer\n format: int64\n items:\n type: array\n items:\n $ref: '#/components/schemas/RTSPConn'\n\n RTSPSession:\n type: object\n properties:\n id:\n type: string\n format: uuid\n created:\n type: string\n remoteAddr:\n type: string\n state:\n $ref: '#/components/schemas/RTSPSessionState'\n path:\n type: string\n query:\n type: string\n user:\n type: string\n transport:\n type: string\n nullable: true\n profile:\n type: string\n nullable: true\n conns:\n type: array\n items:\n type: string\n format: uuid\n inboundBytes:\n type: integer\n format: uint64\n inboundRTPPackets:\n type: integer\n format: uint64\n inboundRTPPacketsLost:\n type: integer\n format: uint64\n inboundRTPPacketsInError:\n type: integer\n format: uint64\n inboundRTPPacketsJitter:\n type: number\n format: double\n inboundRTCPPackets:\n type: integer\n format: uint64\n inboundRTCPPacketsInError:\n type: integer\n format: uint64\n outboundBytes:\n type: integer\n format: uint64\n outboundRTPPackets:\n type: integer\n format: uint64\n outboundRTPPacketsReportedLost:\n type: integer\n format: uint64\n outboundRTPPacketsDiscarded:\n type: integer\n format: uint64\n outboundRTCPPackets:\n type: integer\n format: uint64\n bytesReceived:\n type: integer\n format: uint64\n deprecated: true\n bytesSent:\n type: integer\n format: uint64\n deprecated: true\n rtpPacketsReceived:\n type: integer\n format: uint64\n deprecated: true\n rtpPacketsSent:\n type: integer\n format: uint64\n deprecated: true\n rtpPacketsLost:\n type: integer\n format: uint64\n deprecated: true\n rtpPacketsInError:\n type: integer\n format: uint64\n deprecated: true\n rtpPacketsJitter:\n type: number\n format: double\n deprecated: true\n rtcpPacketsReceived:\n type: integer\n format: uint64\n deprecated: true\n rtcpPacketsSent:\n type: integer\n format: uint64\n deprecated: true\n rtcpPacketsInError:\n type: integer\n format: uint64\n deprecated: true\n\n RTSPSessionList:\n type: object\n properties:\n pageCount:\n type: integer\n format: int64\n itemCount:\n type: integer\n format: int64\n items:\n type: array\n items:\n $ref: '#/components/schemas/RTSPSession'\n\n SRTConn:\n type: object\n properties:\n id:\n type: string\n format: uuid\n created:\n type: string\n remoteAddr:\n type: string\n state:\n $ref: '#/components/schemas/SRTConnState'\n path:\n type: string\n query:\n type: string\n user:\n type: string\n packetsSent:\n type: integer\n format: uint64\n description: The total number of sent DATA packets, including retransmitted packets\n packetsReceived:\n type: integer\n format: uint64\n description: The total number of received DATA packets, including retransmitted packets\n packetsReceivedBelated:\n type: integer\n format: uint64\n packetsSentUnique:\n type: integer\n format: uint64\n description: The total number of unique DATA packets sent by the SRT sender\n packetsReceivedUnique:\n type: integer\n format: uint64\n description: The total number of unique original, retransmitted or recovered by the packet filter DATA packets received in time, decrypted without errors and, as a result, scheduled for delivery to the upstream application by the SRT receiver.\n packetsSendLoss:\n type: integer\n format: uint64\n description: The total number of data packets considered or reported as lost at the sender side. Does not correspond to the packets detected as lost at the receiver side.\n packetsReceivedLoss:\n type: integer\n format: uint64\n description: The total number of SRT DATA packets detected as presently missing (either reordered or lost) at the receiver side\n packetsRetrans:\n type: integer\n format: uint64\n description: The total number of retransmitted packets sent by the SRT sender\n packetsReceivedRetrans:\n type: integer\n format: uint64\n description: The total number of retransmitted packets registered at the receiver side\n packetsSentACK:\n type: integer\n format: uint64\n description: The total number of sent ACK (Acknowledgement) control packets\n packetsReceivedACK:\n type: integer\n format: uint64\n description: The total number of received ACK (Acknowledgement) control packets\n packetsSentNAK:\n type: integer\n format: uint64\n description: The total number of sent NAK (Negative Acknowledgement) control packets\n packetsReceivedNAK:\n type: integer\n format: uint64\n description: The total number of received NAK (Negative Acknowledgement) control packets\n packetsSentKM:\n type: integer\n format: uint64\n description: The total number of sent KM (Key Material) control packets\n packetsReceivedKM:\n type: integer\n format: uint64\n description: The total number of received KM (Key Material) control packets\n usSndDuration:\n type: integer\n format: uint64\n description: The total accumulated time in microseconds, during which the SRT sender has some data to transmit, including packets that have been sent, but not yet acknowledged\n packetsSendDrop:\n type: integer\n format: uint64\n description: The total number of dropped by the SRT sender DATA packets that have no chance to be delivered in time\n packetsReceivedDrop:\n type: integer\n format: uint64\n description: The total number of dropped by the SRT receiver and, as a result, not delivered to the upstream application DATA packets\n packetsReceivedUndecrypt:\n type: integer\n format: uint64\n description: The total number of packets that failed to be decrypted at the receiver side\n bytesSent:\n type: integer\n format: uint64\n description: Same as packetsSent, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)\n bytesReceived:\n type: integer\n format: uint64\n description: Same as packetsReceived, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)\n bytesReceivedBelated:\n type: integer\n format: uint64\n bytesSentUnique:\n type: integer\n format: uint64\n description: Same as packetsSentUnique, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)\n bytesReceivedUnique:\n type: integer\n format: uint64\n description: Same as packetsReceivedUnique, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)\n bytesReceivedLoss:\n type: integer\n format: uint64\n description: Same as packetsReceivedLoss, but expressed in bytes, including payload and all the headers (IP, TCP, SRT), bytes for the presently missing (either reordered or lost) packets' payloads are estimated based on the average packet size\n bytesRetrans:\n type: integer\n format: uint64\n description: Same as packetsRetrans, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)\n bytesReceivedRetrans:\n type: integer\n format: uint64\n description: Same as packetsReceivedRetrans, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)\n bytesSendDrop:\n type: integer\n format: uint64\n description: Same as packetsSendDrop, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)\n bytesReceivedDrop:\n type: integer\n format: uint64\n description: Same as packetsReceivedDrop, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)\n bytesReceivedUndecrypt:\n type: integer\n format: uint64\n description: Same as packetsReceivedUndecrypt, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)\n usPacketsSendPeriod:\n type: number\n format: double\n description: Current minimum time interval between which consecutive packets are sent, in microseconds\n packetsFlowWindow:\n type: integer\n format: uint64\n description: The maximum number of packets that can be \"in flight\"\n packetsFlightSize:\n type: integer\n format: uint64\n description: The number of packets in flight\n msRTT:\n type: number\n format: double\n description: Smoothed round-trip time (SRTT), an exponentially-weighted moving average (EWMA) of an endpoint's RTT samples, in milliseconds\n mbpsSendRate:\n type: number\n format: double\n description: Current transmission bandwidth, in Mbps\n mbpsReceiveRate:\n type: number\n format: double\n description: Current receiving bandwidth, in Mbps\n mbpsLinkCapacity:\n type: number\n format: double\n description: Estimated capacity of the network link, in Mbps\n bytesAvailSendBuf:\n type: integer\n format: uint64\n description: The available space in the sender's buffer, in bytes\n bytesAvailReceiveBuf:\n type: integer\n format: uint64\n description: The available space in the receiver's buffer, in bytes\n mbpsMaxBW:\n type: number\n format: double\n description: Transmission bandwidth limit, in Mbps\n byteMSS:\n type: integer\n format: uint64\n description: Maximum Segment Size (MSS), in bytes\n packetsSendBuf:\n type: integer\n format: uint64\n description: The number of packets in the sender's buffer that are already scheduled for sending or even possibly sent, but not yet acknowledged\n bytesSendBuf:\n type: integer\n format: uint64\n description: Instantaneous (current) value of packetsSndBuf, but expressed in bytes, including payload and all headers (IP, TCP, SRT)\n msSendBuf:\n type: integer\n format: uint64\n description: The timespan (msec) of packets in the sender's buffer (unacknowledged packets)\n msSendTsbPdDelay:\n type: integer\n format: uint64\n description: Timestamp-based Packet Delivery Delay value of the peer\n packetsReceiveBuf:\n type: integer\n format: uint64\n description: The number of acknowledged packets in receiver's buffer\n bytesReceiveBuf:\n type: integer\n format: uint64\n description: Instantaneous (current) value of packetsRcvBuf, expressed in bytes, including payload and all headers (IP, TCP, SRT)\n msReceiveBuf:\n type: integer\n format: uint64\n description: The timespan (msec) of acknowledged packets in the receiver's buffer\n msReceiveTsbPdDelay:\n type: integer\n format: uint64\n description: Timestamp-based Packet Delivery Delay value set on the socket via SRTO_RCVLATENCY or SRTO_LATENCY\n packetsReorderTolerance:\n type: integer\n format: uint64\n description: Instant value of the packet reorder tolerance\n packetsReceivedAvgBelatedTime:\n type: integer\n format: uint64\n description: Accumulated difference between the current time and the time-to-play of a packet that is received late\n packetsSendLossRate:\n type: number\n format: double\n description: Percentage of resent data vs. sent data\n packetsReceivedLossRate:\n type: number\n format: double\n description: Percentage of retransmitted data vs. received data\n outboundFramesDiscarded:\n type: integer\n format: uint64\n\n SRTConnList:\n type: object\n properties:\n pageCount:\n type: integer\n format: int64\n itemCount:\n type: integer\n format: int64\n items:\n type: array\n items:\n $ref: '#/components/schemas/SRTConn'\n\n AlwaysAvailableTrack:\n type: object\n properties:\n codec:\n $ref: '#/components/schemas/AlwaysAvailableTrackCodec'\n sampleRate:\n type: integer\n format: int64\n channelCount:\n type: integer\n format: int64\n muLaw:\n type: boolean\n\n WebRTCICEServer:\n type: object\n properties:\n url:\n type: string\n username:\n type: string\n password:\n type: string\n clientOnly:\n type: boolean\n\n WebRTCSession:\n type: object\n properties:\n id:\n type: string\n format: uuid\n created:\n type: string\n remoteAddr:\n type: string\n peerConnectionEstablished:\n type: boolean\n localCandidate:\n type: string\n remoteCandidate:\n type: string\n state:\n $ref: '#/components/schemas/WebRTCSessionState'\n path:\n type: string\n query:\n type: string\n user:\n type: string\n inboundBytes:\n type: integer\n format: uint64\n inboundRTPPackets:\n type: integer\n format: uint64\n inboundRTPPacketsLost:\n type: integer\n format: uint64\n inboundRTPPacketsJitter:\n type: number\n format: double\n inboundRTCPPackets:\n type: integer\n format: uint64\n outboundBytes:\n type: integer\n format: uint64\n outboundRTPPackets:\n type: integer\n format: uint64\n outboundRTCPPackets:\n type: integer\n format: uint64\n outboundFramesDiscarded:\n type: integer\n format: uint64\n bytesReceived:\n type: integer\n format: uint64\n deprecated: true\n bytesSent:\n type: integer\n format: uint64\n deprecated: true\n rtpPacketsReceived:\n type: integer\n format: uint64\n deprecated: true\n rtpPacketsSent:\n type: integer\n format: uint64\n deprecated: true\n rtpPacketsLost:\n type: integer\n format: uint64\n deprecated: true\n rtpPacketsJitter:\n type: number\n format: double\n deprecated: true\n rtcpPacketsReceived:\n type: integer\n format: uint64\n deprecated: true\n rtcpPacketsSent:\n type: integer\n format: uint64\n deprecated: true\n\n WebRTCSessionList:\n type: object\n properties:\n pageCount:\n type: integer\n format: int64\n itemCount:\n type: integer\n format: int64\n items:\n type: array\n items:\n $ref: '#/components/schemas/WebRTCSession'\n\npaths:\n\n /v3/info:\n get:\n operationId: info\n tags: [General]\n summary: returns informations about the instance.\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Info'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/auth/jwks/refresh:\n post:\n operationId: authJwksRefresh\n tags: [Authentication]\n summary: Manually refreshes the JWT JWKS.\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/OK'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/config/global/get:\n get:\n operationId: configGlobalGet\n tags: [Configuration]\n summary: returns the global configuration.\n description: ''\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GlobalConf'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/config/global/patch:\n patch:\n operationId: configGlobalSet\n tags: [Configuration]\n summary: patches the global configuration.\n description: all fields are optional.\n requestBody:\n required: true\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GlobalConf'\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/OK'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/config/pathdefaults/get:\n get:\n operationId: configPathDefaultsGet\n tags: [Configuration]\n summary: returns the default path configuration.\n description: ''\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/PathConf'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/config/pathdefaults/patch:\n patch:\n operationId: configPathDefaultsPatch\n tags: [Configuration]\n summary: patches the default path configuration.\n description: all fields are optional.\n requestBody:\n required: true\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/PathConf'\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/OK'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/config/paths/list:\n get:\n operationId: configPathsList\n tags: [Configuration]\n summary: returns all path configurations.\n description: ''\n parameters:\n - name: page\n in: query\n description: page number.\n schema:\n type: integer\n default: 0\n - name: itemsPerPage\n in: query\n description: items per page.\n schema:\n type: integer\n default: 100\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/PathConfList'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/config/paths/get/{name}:\n get:\n operationId: configPathsGet\n tags: [Configuration]\n summary: returns a path configuration.\n description: ''\n parameters:\n - name: name\n in: path\n required: true\n description: the name of the path.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/PathConf'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: path not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/config/paths/add/{name}:\n post:\n operationId: configPathsAdd\n tags: [Configuration]\n summary: adds a path configuration.\n description: all fields are optional.\n parameters:\n - name: name\n in: path\n required: true\n description: the name of the path.\n schema:\n type: string\n requestBody:\n required: true\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/PathConf'\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/OK'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/config/paths/patch/{name}:\n patch:\n operationId: configPathsPatch\n tags: [Configuration]\n summary: patches a path configuration.\n description: all fields are optional.\n parameters:\n - name: name\n in: path\n required: true\n description: the name of the path.\n schema:\n type: string\n requestBody:\n required: true\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/PathConf'\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/OK'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: path not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/config/paths/replace/{name}:\n post:\n operationId: configPathsReplace\n tags: [Configuration]\n summary: replaces all values of a path configuration.\n description: all fields are optional.\n parameters:\n - name: name\n in: path\n required: true\n description: the name of the path.\n schema:\n type: string\n requestBody:\n required: true\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/PathConf'\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/OK'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: path not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/config/paths/delete/{name}:\n delete:\n operationId: configPathsDelete\n tags: [Configuration]\n summary: removes a path configuration.\n description: ''\n parameters:\n - name: name\n in: path\n required: true\n description: the name of the path.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/OK'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: path not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/hlsmuxers/list:\n get:\n operationId: hlsMuxersList\n tags: [HLS]\n summary: returns all HLS muxers.\n description: ''\n parameters:\n - name: page\n in: query\n description: page number.\n schema:\n type: integer\n default: 0\n - name: itemsPerPage\n in: query\n description: items per page.\n schema:\n type: integer\n default: 100\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/HLSMuxerList'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/hlsmuxers/get/{name}:\n get:\n operationId: hlsMuxersGet\n tags: [HLS]\n summary: returns a HLS muxer.\n description: ''\n parameters:\n - name: name\n in: path\n required: true\n description: name of the muxer.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/HLSMuxer'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: muxer not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/paths/list:\n get:\n operationId: pathsList\n tags: [Paths]\n summary: returns all paths.\n description: ''\n parameters:\n - name: page\n in: query\n description: page number.\n schema:\n type: integer\n default: 0\n - name: itemsPerPage\n in: query\n description: items per page.\n schema:\n type: integer\n default: 100\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/PathList'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/paths/get/{name}:\n get:\n operationId: pathsGet\n tags: [Paths]\n summary: returns a path.\n description: ''\n parameters:\n - name: name\n in: path\n required: true\n description: name of the path.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Path'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: path not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/rtspconns/list:\n get:\n operationId: rtspConnsList\n tags: [RTSP]\n summary: returns all RTSP connections.\n description: ''\n parameters:\n - name: page\n in: query\n description: page number.\n schema:\n type: integer\n default: 0\n - name: itemsPerPage\n in: query\n description: items per page.\n schema:\n type: integer\n default: 100\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RTSPConnList'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/rtspconns/get/{id}:\n get:\n operationId: rtspConnsGet\n tags: [RTSP]\n summary: returns a RTSP connection.\n description: ''\n parameters:\n - name: id\n in: path\n required: true\n description: ID of the connection.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RTSPConn'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: connection not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/rtspsessions/list:\n get:\n operationId: rtspSessionsList\n tags: [RTSP]\n summary: returns all RTSP sessions.\n description: ''\n parameters:\n - name: page\n in: query\n description: page number.\n schema:\n type: integer\n default: 0\n - name: itemsPerPage\n in: query\n description: items per page.\n schema:\n type: integer\n default: 100\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RTSPSessionList'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/rtspsessions/get/{id}:\n get:\n operationId: rtspSessionsGet\n tags: [RTSP]\n summary: returns a RTSP session.\n description: ''\n parameters:\n - name: id\n in: path\n required: true\n description: ID of the connection.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RTSPSession'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: session not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/rtspsessions/kick/{id}:\n post:\n operationId: rtspSessionsKick\n tags: [RTSP]\n summary: kicks out a RTSP session from the server.\n description: ''\n parameters:\n - name: id\n in: path\n required: true\n description: ID of the session.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/OK'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: session not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/rtspsconns/list:\n get:\n operationId: rtspsConnsList\n tags: [RTSP]\n summary: returns all RTSPS connections.\n description: ''\n parameters:\n - name: page\n in: query\n description: page number.\n schema:\n type: integer\n default: 0\n - name: itemsPerPage\n in: query\n description: items per page.\n schema:\n type: integer\n default: 100\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RTSPConnList'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/rtspsconns/get/{id}:\n get:\n operationId: rtspsConnsGet\n tags: [RTSP]\n summary: returns a RTSPS connection.\n description: ''\n parameters:\n - name: id\n in: path\n required: true\n description: ID of the connection.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RTSPConn'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: connection not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/rtspssessions/list:\n get:\n operationId: rtspsSessionsList\n tags: [RTSP]\n summary: returns all RTSPS sessions.\n description: ''\n parameters:\n - name: page\n in: query\n description: page number.\n schema:\n type: integer\n default: 0\n - name: itemsPerPage\n in: query\n description: items per page.\n schema:\n type: integer\n default: 100\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RTSPSessionList'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/rtspssessions/get/{id}:\n get:\n operationId: rtspsSessionsGet\n tags: [RTSP]\n summary: returns a RTSPS session.\n description: ''\n parameters:\n - name: id\n in: path\n required: true\n description: ID of the connection.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RTSPSession'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: session not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/rtspssessions/kick/{id}:\n post:\n operationId: rtspsSessionsKick\n tags: [RTSP]\n summary: kicks out a RTSPS session from the server.\n description: ''\n parameters:\n - name: id\n in: path\n required: true\n description: ID of the session.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/OK'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: session not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/rtmpconns/list:\n get:\n operationId: rtmpConnsList\n tags: [RTMP]\n summary: returns all RTMP connections.\n description: ''\n parameters:\n - name: page\n in: query\n description: page number.\n schema:\n type: integer\n default: 0\n - name: itemsPerPage\n in: query\n description: items per page.\n schema:\n type: integer\n default: 100\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RTMPConnList'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/rtmpconns/get/{id}:\n get:\n operationId: rtmpConnectionsGet\n tags: [RTMP]\n summary: returns a RTMP connection.\n description: ''\n parameters:\n - name: id\n in: path\n required: true\n description: ID of the connection.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RTMPConn'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: connection not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/rtmpconns/kick/{id}:\n post:\n operationId: rtmpConnsKick\n tags: [RTMP]\n summary: kicks out a RTMP connection from the server.\n description: ''\n parameters:\n - name: id\n in: path\n required: true\n description: ID of the connection.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/OK'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: connection not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/rtmpsconns/list:\n get:\n operationId: rtmpsConnsList\n tags: [RTMP]\n summary: returns all RTMPS connections.\n description: ''\n parameters:\n - name: page\n in: query\n description: page number.\n schema:\n type: integer\n default: 0\n - name: itemsPerPage\n in: query\n description: items per page.\n schema:\n type: integer\n default: 100\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RTMPConnList'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/rtmpsconns/get/{id}:\n get:\n operationId: rtmpsConnectionsGet\n tags: [RTMP]\n summary: returns a RTMPS connection.\n description: ''\n parameters:\n - name: id\n in: path\n required: true\n description: ID of the connection.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RTMPConn'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: connection not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/rtmpsconns/kick/{id}:\n post:\n operationId: rtmpsConnsKick\n tags: [RTMP]\n summary: kicks out a RTMPS connection from the server.\n description: ''\n parameters:\n - name: id\n in: path\n required: true\n description: ID of the connection.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/OK'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: connection not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/srtconns/list:\n get:\n operationId: srtConnsList\n tags: [SRT]\n summary: returns all SRT connections.\n description: ''\n parameters:\n - name: page\n in: query\n description: page number.\n schema:\n type: integer\n default: 0\n - name: itemsPerPage\n in: query\n description: items per page.\n schema:\n type: integer\n default: 100\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/SRTConnList'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/srtconns/get/{id}:\n get:\n operationId: srtConnsGet\n tags: [SRT]\n summary: returns a SRT connection.\n description: ''\n parameters:\n - name: id\n in: path\n required: true\n description: ID of the connection.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/SRTConn'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: connection not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/srtconns/kick/{id}:\n post:\n operationId: srtConnsKick\n tags: [SRT]\n summary: kicks out a SRT connection from the server.\n description: ''\n parameters:\n - name: id\n in: path\n required: true\n description: ID of the connection.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/OK'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: connection not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/webrtcsessions/list:\n get:\n operationId: webrtcSessionsList\n tags: [WebRTC]\n summary: returns all WebRTC sessions.\n description: ''\n parameters:\n - name: page\n in: query\n description: page number.\n schema:\n type: integer\n default: 0\n - name: itemsPerPage\n in: query\n description: items per page.\n schema:\n type: integer\n default: 100\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/WebRTCSessionList'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/webrtcsessions/get/{id}:\n get:\n operationId: webrtcSessionsGet\n tags: [WebRTC]\n summary: returns a WebRTC session.\n description: ''\n parameters:\n - name: id\n in: path\n required: true\n description: ID of the session.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/WebRTCSession'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: session not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/webrtcsessions/kick/{id}:\n post:\n operationId: webrtcSessionsKick\n tags: [WebRTC]\n summary: kicks out a WebRTC session from the server.\n description: ''\n parameters:\n - name: id\n in: path\n required: true\n description: ID of the session.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/OK'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: session not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/recordings/list:\n get:\n operationId: recordingsList\n tags: [Recordings]\n summary: returns all recordings, splitted by path.\n description: ''\n parameters:\n - name: page\n in: query\n description: page number.\n schema:\n type: integer\n default: 0\n - name: itemsPerPage\n in: query\n description: items per page.\n schema:\n type: integer\n default: 100\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RecordingList'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/recordings/get/{name}:\n get:\n operationId: recordingsGet\n tags: [Recordings]\n summary: returns recordings of a path.\n description: ''\n parameters:\n - name: name\n in: path\n required: true\n description: name of the path.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Recording'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: path not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n\n /v3/recordings/deletesegment:\n delete:\n operationId: recordingsDeleteSegment\n tags: [Recordings]\n summary: deletes a recording segment.\n description: ''\n parameters:\n - name: path\n in: query\n required: true\n description: path.\n schema:\n type: string\n - name: start\n in: query\n required: true\n description: starting date of the segment.\n schema:\n type: string\n responses:\n '200':\n description: the request was successful.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/OK'\n '400':\n description: invalid request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '404':\n description: connection not found.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n '500':\n description: server error.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Error'\n" }, { "path": "docker/ffmpeg-rpi.Dockerfile", "content": "#################################################################\nFROM --platform=linux/amd64 scratch AS binaries\n\nADD binaries/mediamtx_*_linux_armv6.tar.gz /linux/arm/v6\nADD binaries/mediamtx_*_linux_armv7.tar.gz /linux/arm/v7\nADD binaries/mediamtx_*_linux_arm64.tar.gz /linux/arm64\n\n#################################################################\nFROM --platform=linux/arm/v7 debian:bullseye-slim AS base-arm-v7\n\n# even though the base image is arm v7,\n# Raspbian libraries and compilers provide arm v6 compatibility.\n\nRUN apt update \\\n\t&& apt install -y wget gpg \\\n\t&& echo \"deb http://archive.raspbian.org/raspbian bullseye main rpi firmware\" > /etc/apt/sources.list \\\n\t&& echo \"deb http://archive.raspberrypi.org/debian bullseye main\" > /etc/apt/sources.list.d/raspi.list \\\n\t&& wget -O- https://archive.raspbian.org/raspbian.public.key | gpg --dearmor -o /etc/apt/trusted.gpg.d/raspbian.gpg \\\n\t&& wget -O- https://archive.raspberrypi.org/debian/raspberrypi.gpg.key | gpg --dearmor -o /etc/apt/trusted.gpg.d/raspberrypi.gpg \\\n\t&& rm -rf /var/lib/apt/lists/*\n\nRUN apt update && apt install --reinstall -y \\\n libc6 \\\n libc-bin \\\n libstdc++6 \\\n && rm -rf /var/lib/apt/lists/*\n\n#################################################################\nFROM --platform=linux/arm64 debian:bullseye-slim AS base-arm64\n\nRUN apt update \\\n\t&& apt install -y wget gpg \\\n\t&& echo \"deb http://archive.raspberrypi.org/debian bullseye main\" > /etc/apt/sources.list.d/raspi.list \\\n\t&& wget -O- https://archive.raspberrypi.org/debian/raspberrypi.gpg.key | gpg --dearmor -o /etc/apt/trusted.gpg.d/raspberrypi.gpg \\\n\t&& rm -rf /var/lib/apt/lists/*\n\n#################################################################\nFROM --platform=linux/amd64 scratch AS base\n\nCOPY --from=base-arm-v7 / /linux/arm/v6\nCOPY --from=base-arm-v7 / /linux/arm/v7\nCOPY --from=base-arm64 / /linux/arm64\n\n#################################################################\nFROM scratch\n\nARG TARGETPLATFORM\nCOPY --from=base /$TARGETPLATFORM /\n\nRUN apt update \\\n && apt install -y --no-install-recommends ffmpeg \\\n && rm -rf /var/lib/apt/lists/*\n\nCOPY --from=binaries /$TARGETPLATFORM /\n\nENTRYPOINT [ \"/mediamtx\" ]\n" }, { "path": "docker/ffmpeg.Dockerfile", "content": "#################################################################\nFROM --platform=linux/amd64 scratch AS binaries\n\nADD binaries/mediamtx_*_linux_amd64.tar.gz /linux/amd64\nADD binaries/mediamtx_*_linux_armv6.tar.gz /linux/arm/v6\nADD binaries/mediamtx_*_linux_armv7.tar.gz /linux/arm/v7\nADD binaries/mediamtx_*_linux_arm64.tar.gz /linux/arm64\n\n#################################################################\nFROM alpine:3.22\n\nRUN apk add --no-cache ffmpeg\n\nARG TARGETPLATFORM\nCOPY --from=binaries /$TARGETPLATFORM /\n\nENTRYPOINT [ \"/mediamtx\" ]\n" }, { "path": "docker/rpi.Dockerfile", "content": "#################################################################\nFROM --platform=linux/amd64 scratch AS binaries\n\nADD binaries/mediamtx_*_linux_armv6.tar.gz /linux/arm/v6\nADD binaries/mediamtx_*_linux_armv7.tar.gz /linux/arm/v7\nADD binaries/mediamtx_*_linux_arm64.tar.gz /linux/arm64\n\n#################################################################\nFROM --platform=linux/arm/v7 debian:bullseye-slim AS base-arm-v7\n\n# even though the base image is arm v7,\n# Raspbian libraries and compilers provide arm v6 compatibility.\n\nRUN apt update \\\n\t&& apt install -y wget gpg \\\n\t&& echo \"deb http://archive.raspbian.org/raspbian bullseye main rpi firmware\" > /etc/apt/sources.list \\\n\t&& echo \"deb http://archive.raspberrypi.org/debian bullseye main\" > /etc/apt/sources.list.d/raspi.list \\\n\t&& wget -O- https://archive.raspbian.org/raspbian.public.key | gpg --dearmor -o /etc/apt/trusted.gpg.d/raspbian.gpg \\\n\t&& wget -O- https://archive.raspberrypi.org/debian/raspberrypi.gpg.key | gpg --dearmor -o /etc/apt/trusted.gpg.d/raspberrypi.gpg \\\n\t&& rm -rf /var/lib/apt/lists/*\n\nRUN apt update && apt install --reinstall -y \\\n libc6 \\\n libc-bin \\\n libstdc++6 \\\n && rm -rf /var/lib/apt/lists/*\n\n#################################################################\nFROM --platform=linux/arm64 debian:bullseye-slim AS base-arm64\n\nRUN apt update \\\n\t&& apt install -y wget gpg \\\n\t&& echo \"deb http://archive.raspberrypi.org/debian bullseye main\" > /etc/apt/sources.list.d/raspi.list \\\n\t&& wget -O- https://archive.raspberrypi.org/debian/raspberrypi.gpg.key | gpg --dearmor -o /etc/apt/trusted.gpg.d/raspberrypi.gpg \\\n\t&& rm -rf /var/lib/apt/lists/*\n\n#################################################################\nFROM --platform=linux/amd64 scratch AS base\n\nCOPY --from=base-arm-v7 / /linux/arm/v6\nCOPY --from=base-arm-v7 / /linux/arm/v7\nCOPY --from=base-arm64 / /linux/arm64\n\n#################################################################\nFROM scratch\n\nARG TARGETPLATFORM\nCOPY --from=base /$TARGETPLATFORM /\n\nCOPY --from=binaries /$TARGETPLATFORM /\n\nENTRYPOINT [ \"/mediamtx\" ]\n" }, { "path": "docker/standard.Dockerfile", "content": "#################################################################\nFROM --platform=linux/amd64 scratch AS binaries\n\nADD binaries/mediamtx_*_linux_amd64.tar.gz /linux/amd64\nADD binaries/mediamtx_*_linux_armv6.tar.gz /linux/arm/v6\nADD binaries/mediamtx_*_linux_armv7.tar.gz /linux/arm/v7\nADD binaries/mediamtx_*_linux_arm64.tar.gz /linux/arm64\n\n#################################################################\nFROM scratch\n\nARG TARGETPLATFORM\nCOPY --from=binaries /$TARGETPLATFORM /\n\nENTRYPOINT [ \"/mediamtx\" ]\n" }, { "path": "docs/1-kickoff/1-introduction.md", "content": "# Introduction\n\nWelcome to the MediaMTX documentation!\n\n_MediaMTX_ is a ready-to-use and zero-dependency live media server and media proxy. It has been conceived as a \"media router\" that routes media streams from one end to the other, with a focus on efficiency and portability.\n\nMain features:\n\n- [Publish](../2-publish/01-overview.md) live streams to the server with SRT, WebRTC, RTSP, RTMP, HLS, MPEG-TS, RTP, using FFmpeg, GStreamer, OBS Studio, Python , Golang, Unity, Web browsers, Raspberry Pi Cameras and more.\n- [Read](../3-read/01-overview.md) live streams from the server with SRT, WebRTC, RTSP, RTMP, HLS, using FFmpeg, GStreamer, VLC, OBS Studio, Python , Golang, Unity, Web browsers and more.\n- Streams are automatically converted from a protocol to another\n- Serve several streams at once in separate paths\n- Reload the configuration without disconnecting existing clients (hot reloading)\n- [Serve always-available streams](../4-other/05-always-available.md) even when the publisher is offline\n- [Record](../4-other/06-record.md) streams to disk in fMP4 or MPEG-TS format\n- [Playback](../4-other/07-playback.md) recorded streams\n- [Authenticate](../4-other/03-authentication.md) users with internal, HTTP or JWT authentication\n- [Forward](../4-other/08-forward.md) streams to other servers\n- [Proxy](../4-other/09-proxy.md) requests to other servers\n- [Control](../4-other/18-control-api.md) the server through the Control API\n- [Extract metrics](../4-other/19-metrics.md) from the server in a Prometheus-compatible format\n- [Monitor performance](../4-other/20-performance.md) to investigate CPU and RAM consumption\n- [Run hooks](../4-other/17-hooks.md) (external commands) when clients connect, disconnect, read or publish streams\n- Compatible with Linux, Windows and macOS, does not require any dependency or interpreter, it's a single executable\n\nUse the menu to navigate through the documentation.\n" }, { "path": "docs/1-kickoff/2-install.md", "content": "# Install\n\nThere are several installation methods available:\n\n- [Standalone binary](#standalone-binary): use this if you are running Windows, macOS or you just want to try out _MediaMTX_.\n- [Docker image](#docker-image): use this if you want to run _MediaMTX_ in an isolated and deterministic way. This is recommended for production environments.\n- [Arch Linux package](#arch-linux-package): use this if you are running Arch Linux.\n- [FreeBSD package](#freebsd-package): use this if you are running FreeBSD.\n- [OpenWrt binary](#openwrt-binary): use this if you are running OpenWrt.\n\n## Standalone binary\n\n1. Visit the [Releases page](https://github.com/bluenviron/mediamtx/releases) on GitHub, download and extract a standalone binary that corresponds to your operating system and architecture (example: `mediamtx_{version_tag}_linux_amd64.tar.gz`).\n\n2. Start the server by double clicking on `mediamtx` (`mediamtx.exe` on Windows) or writing in the terminal:\n\n ```sh\n ./mediamtx\n ```\n\n## Docker image\n\nDownload and launch the `bluenviron/mediamtx:1` image with the following environment variables and ports:\n\n```sh\ndocker run --rm -it \\\n-e MTX_RTSPTRANSPORTS=tcp \\\n-e MTX_WEBRTCADDITIONALHOSTS=192.168.x.x \\\n-p 8554:8554 \\\n-p 1935:1935 \\\n-p 8888:8888 \\\n-p 8889:8889 \\\n-p 8890:8890/udp \\\n-p 8189:8189/udp \\\nbluenviron/mediamtx:1\n```\n\nFill the `MTX_WEBRTCADDITIONALHOSTS` environment variable with the IP that will be used to connect to the server.\n\nThe `MTX_RTSPTRANSPORTS=tcp` environment variable is meant to disable the UDP transport protocol of the RTSP server (which requires the real IP address and port of incoming UDP packets, that are sometimes replaced by the Docker network stack). If you want to use it, you need to bypass the Docker network stack through the `--network=host` flag (which is not compatible with Windows, macOS and Kubernetes):\n\n```sh\ndocker run --rm -it --network=host bluenviron/mediamtx:1\n```\n\nThere are four image variants:\n\n| name | FFmpeg included | RPI Camera support |\n| -------------------------------- | ------------------ | ------------------ |\n| bluenviron/mediamtx:1 | :x: | :x: |\n| bluenviron/mediamtx:1-ffmpeg | :heavy_check_mark: | :x: |\n| bluenviron/mediamtx:1-rpi | :x: | :heavy_check_mark: |\n| bluenviron/mediamtx:1-ffmpeg-rpi | :heavy_check_mark: | :heavy_check_mark: |\n\nThe `1` tag corresponds to the latest `1.x.x` release, that should guarantee backward compatibility when upgrading. It is also possible to bind the image to a specific release, by using the release name as tag (`bluenviron/mediamtx:{docker_version_tag}`).\n\nThe base image does not contain any utility, in order to minimize size and frequency of updates. If you need additional software (like curl, wget, GStreamer), you can build a custom image by creating a file named `Dockerfile` with this content:\n\n```Dockerfile\nFROM bluenviron/mediamtx:1 AS mediamtx\nFROM ubuntu:24.04\n\nCOPY --from=mediamtx /mediamtx /\nCOPY --from=mediamtx /mediamtx.yml /\n\n# add anything you need.\nRUN apt update && apt install -y \\\n gstreamer1.0-tools\n\nENTRYPOINT [ \"/mediamtx\" ]\n```\n\nAnd then build it:\n\n```sh\ndocker build . -t my-mediamtx\n```\n\nIn particular, the custom image is using the official _MediaMTX_ image as a base stage, and then adds a Linux-based operating system on top of it. Since _MediaMTX_ binaries are not tied to a specific Linux distribution or version, you can use anything you like.\n\n## Arch Linux package\n\nIf you are running the Arch Linux distribution, launch:\n\n```sh\ngit clone https://aur.archlinux.org/mediamtx.git\ncd mediamtx\nmakepkg -si\n```\n\n## FreeBSD package\n\nAvailable via ports tree or using packages (2025Q2 and later) as listed below:\n\n```sh\ncd /usr/ports/multimedia/mediamtx && make install clean\npkg install mediamtx\n```\n\n## OpenWrt binary\n\nIf the architecture of the OpenWrt device is amd64, armv6, armv7 or arm64, use the [standalone binary method](#standalone-binary) and download a Linux binary that corresponds to your architecture.\n\nOtherwise, [compile the server from source](../6-misc/1-compile.md).\n" }, { "path": "docs/1-kickoff/3-upgrade.md", "content": "# Upgrade\n\nIf you have an existing _MediaMTX_ installation, you can upgrade it to the latest version. The procedure depends on how _MediaMTX_ was installed.\n\n## Standalone binary\n\nThe standalone binary comes with an upgrade utility that can be launched with:\n\n```sh\n./mediamtx --upgrade\n```\n\nThis will replace the _MediaMTX_ executable with its latest version. Privileges to write to the executable location are required.\n\n## Docker image\n\nStop and remove the container:\n\n```sh\ndocker stop id-of-mediamtx-container\ndocker rm id-of-mediamtx-container\n```\n\nRemove the _MediaMTX_ image from cache:\n\n```sh\ndocker rm bluenviron/mediamtx:1\n```\n\nThen recreate the container as described in [Install](2-install.md#docker-image).\n\n## Arch Linux package\n\nRepeat the installation procedure.\n\n## FreeBSD package\n\nRepeat the installation procedure.\n\n## OpenWrt binary\n\nIf the architecture of the OpenWrt device is amd64, armv6, armv7 or arm64, you can use the standalone binary method.\n\nOtherwise, recompile the server from source.\n" }, { "path": "docs/1-kickoff/4-basic-usage.md", "content": "# Basic usage\n\n1. [Publish](../2-publish/01-overview.md) a stream. For instance, you can publish a stream from a MP4 file with _FFmpeg_:\n\n ```sh\n ffmpeg -re -stream_loop -1 -i file.mp4 -c copy \\\n -f rtsp rtsp://localhost:8554/mystream\n ```\n\n or _GStreamer_:\n\n ```sh\n gst-launch-1.0 rtspclientsink name=s location=rtsp://localhost:8554/mystream filesrc location=file.mp4 \\\n ! qtdemux name=d d.video_0 ! queue ! s.sink_0 d.audio_0 ! queue ! s.sink_1\n ```\n\n2. [Read](../3-read/01-overview.md) the stream. For instance, you can read the stream with _VLC_:\n\n ```sh\n vlc --network-caching=50 rtsp://localhost:8554/mystream\n ```\n\n or _GStreamer_:\n\n ```sh\n gst-play-1.0 rtsp://localhost:8554/mystream\n ```\n\n or _FFmpeg_:\n\n ```sh\n ffmpeg -i rtsp://localhost:8554/mystream -c copy output.mp4\n ```\n" }, { "path": "docs/1-kickoff/index.md", "content": "# Kickoff\n" }, { "path": "docs/2-publish/01-overview.md", "content": "# Publish a stream\n\nLive streams can be published to the server with the following protocols and codecs:\n\n| protocol | variants | codecs |\n| ---------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [SRT clients](02-srt-clients.md) | | **Video**: H265, H264, MPEG-4 Video (H263, Xvid), MPEG-1/2 Video
**Audio**: Opus, MPEG-4 Audio (AAC), MPEG-1/2 Audio (MP3), AC-3
**Other**: KLV |\n| [SRT cameras and servers](03-srt-cameras-and-servers.md) | | **Video**: H265, H264, MPEG-4 Video (H263, Xvid), MPEG-1/2 Video
**Audio**: Opus, MPEG-4 Audio (AAC), MPEG-1/2 Audio (MP3), AC-3
**Other**: KLV |\n| [WebRTC clients](04-webrtc-clients.md) | WHIP | **Video**: AV1, VP9, VP8, H265, H264
**Audio**: Opus, G722, G711 (PCMA, PCMU) |\n| [WebRTC servers](05-webrtc-servers.md) | WHEP | **Video**: AV1, VP9, VP8, H265, H264
**Audio**: Opus, G722, G711 (PCMA, PCMU) |\n| [RTSP clients](06-rtsp-clients.md) | UDP, TCP, RTSPS | **Video**: AV1, VP9, VP8, H265, H264, MPEG-4 Video (H263, Xvid), MPEG-1/2 Video, MJPEG
**Audio**: Opus, MPEG-4 Audio (AAC), MPEG-1/2 Audio (MP3), AC-3, G726, G722, G711 (PCMA, PCMU), LPCM
**Other**: KLV, MPEG-TS, any RTP-compatible codec |\n| [RTSP cameras and servers](07-rtsp-cameras-and-servers.md) | UDP, UDP-Multicast, TCP, RTSPS | **Video**: AV1, VP9, VP8, H265, H264, MPEG-4 Video (H263, Xvid), MPEG-1/2 Video, MJPEG
**Audio**: Opus, MPEG-4 Audio (AAC), MPEG-1/2 Audio (MP3), AC-3, G726, G722, G711 (PCMA, PCMU), LPCM
**Other**: KLV, MPEG-TS, any RTP-compatible codec |\n| [RTMP clients](08-rtmp-clients.md) | RTMP, RTMPS, Enhanced RTMP | **Video**: AV1, VP9, H265, H264
**Audio**: Opus, MPEG-4 Audio (AAC), MPEG-1/2 Audio (MP3), AC-3, G711 (PCMA, PCMU), LPCM |\n| [RTMP cameras and servers](09-rtmp-cameras-and-servers.md) | RTMP, RTMPS, Enhanced RTMP | **Video**: AV1, VP9, H265, H264
**Audio**: Opus, MPEG-4 Audio (AAC), MPEG-1/2 Audio (MP3), AC-3, G711 (PCMA, PCMU), LPCM |\n| [HLS cameras and servers](10-hls-cameras-and-servers.md) | Low-Latency HLS, MP4-based HLS, legacy HLS | **Video**: AV1, VP9, H265, H264
**Audio**: Opus, MPEG-4 Audio (AAC) |\n| [MPEG-TS](11-mpeg-ts.md) | MPEG-TS over UDP, MPEG-TS over Unix socket | **Video**: H265, H264, MPEG-4 Video (H263, Xvid), MPEG-1/2 Video
**Audio**: Opus, MPEG-4 Audio (AAC), MPEG-1/2 Audio (MP3), AC-3
**Other**: KLV |\n| [RTP](12-rtp.md) | RTP over UDP | **Video**: AV1, VP9, VP8, H265, H264, MPEG-4 Video (H263, Xvid), MPEG-1/2 Video, M-JPEG
**Audio**: Opus, MPEG-4 Audio (AAC), MPEG-1/2 Audio (MP3), AC-3, G726, G722, G711 (PCMA, PCMU), LPCM
**Other**: KLV, MPEG-TS, any RTP-compatible codec |\n\nWe provide instructions for publishing with the following devices:\n\n- [Raspberry Pi Cameras](13-raspberry-pi-cameras.md)\n- [Generic webcams](14-generic-webcams.md)\n\nWe provide instructions for publishing with the following software:\n\n- [FFmpeg](15-ffmpeg.md)\n- [GStreamer](16-gstreamer.md)\n- [OBS Studio](17-obs-studio.md)\n- [Python and OpenCV](18-python-opencv.md)\n- [Golang](19-golang.md)\n- [Unity](20-unity.md)\n- [Web browsers](21-web-browsers.md)\n" }, { "path": "docs/2-publish/02-srt-clients.md", "content": "# SRT clients\n\nSRT is a protocol that allows to publish and read live data stream, providing encryption, integrity and a retransmission mechanism. It is usually used to transfer media streams encoded with MPEG-TS. In order to publish a stream to the server with the SRT protocol, use this URL:\n\n```\nsrt://localhost:8890?streamid=publish:mystream&pkt_size=1316\n```\n\nReplace `mystream` with any name you want. The resulting stream will be available on path `/mystream`.\n\nIf you need to use the standard stream ID syntax instead of the custom one in use by this server, read [Standard stream ID syntax](../4-other/21-srt-specific-features.md#standard-stream-id-syntax).\n\nIf you want to publish a stream by using a client in listening mode (i.e. with `mode=listener` appended to the URL), read the next section.\n\nSome clients that can publish with SRT are [FFmpeg](15-ffmpeg.md), [GStreamer](16-gstreamer.md), [OBS Studio](17-obs-studio.md).\n" }, { "path": "docs/2-publish/03-srt-cameras-and-servers.md", "content": "# SRT cameras and servers\n\nIn order to ingest a SRT stream from a remote server, camera or client in listening mode (i.e. with `mode=listener` appended to the URL), add the corresponding URL into the `source` parameter of a path:\n\n```yml\npaths:\n proxied:\n # url of the source stream, in the format srt://host:port?streamid=streamid&other_parameters\n source: srt://original-url\n```\n" }, { "path": "docs/2-publish/04-webrtc-clients.md", "content": "# WebRTC clients\n\nWebRTC is an API that makes use of a set of protocols and methods to connect two clients together and allow them to exchange live media or data streams. You can publish a stream with WebRTC and a web browser by visiting:\n\n```\nhttp://localhost:8889/mystream/publish\n```\n\nThe resulting stream will be available on path `/mystream`.\n\nWHIP is a WebRTC extension that allows to publish streams by using a URL, without passing through a web page. This allows to use WebRTC as a general purpose streaming protocol. If you are using a software that supports WHIP (for instance, latest versions of OBS Studio), you can publish a stream to the server by using this URL:\n\n```\nhttp://localhost:8889/mystream/whip\n```\n\nBe aware that not all browsers can read any codec, check [Supported browsers](../4-other/22-webrtc-specific-features.md#supported-browsers).\n\nDepending on the network it might be difficult to establish a connection between server and clients, read [Solving WebRTC connectivity issues](../4-other/22-webrtc-specific-features.md#solving-webrtc-connectivity-issues).\n\nSome clients that can publish with WebRTC and WHIP are [FFmpeg](15-ffmpeg.md), [GStreamer](16-gstreamer.md), [OBS Studio](17-obs-studio.md), [Unity](20-unity.md) and [Web browsers](21-web-browsers.md).\n" }, { "path": "docs/2-publish/05-webrtc-servers.md", "content": "# WebRTC servers\n\nIn order to ingest a WebRTC stream from a remote server, add the corresponding WHEP URL into the `source` parameter of a path:\n\n```yml\npaths:\n proxied:\n # url of the source stream, in the format whep://host:port/path (HTTP) or wheps:// (HTTPS)\n source: wheps://host:port/path\n```\n\nIf the remote server is a _MediaMTX_ instance, remember to add a `/whep` suffix after the stream name, since in _MediaMTX_ [it's part of the WHEP URL](../3-read/03-webrtc.md):\n\n```yml\npaths:\n proxied:\n source: whep://host:port/mystream/whep\n```\n" }, { "path": "docs/2-publish/06-rtsp-clients.md", "content": "# RTSP clients\n\nRTSP is a protocol that allows to publish and read streams. It supports several underlying transport protocols and encryption. In order to publish a stream to the server with the RTSP protocol, use this URL:\n\n```\nrtsp://localhost:8554/mystream\n```\n\nThe resulting stream will be available on path `/mystream`.\n\nSome clients that can publish with RTSP are [FFmpeg](15-ffmpeg.md), [GStreamer](16-gstreamer.md), [OBS Studio](17-obs-studio.md), [Python and OpenCV](18-python-opencv.md).\n\nAdvanced RTSP features and settings are described in [RTSP-specific features](../4-other/23-rtsp-specific-features.md).\n\n## MPEG-TS inside RTSP\n\nSome RTSP clients encode tracks with MPEG-TS before sending them to the server, causing the server to see a single \"MPEG-TS\" track, and preventing track conversion from a protocol to another.\n\nIt's possible to automatically demux these MPEG-TS-encoded streams, by toggling `rtspDemuxMpegts`:\n\n```yml\npathDefaults:\n # Demux MPEG-TS over RTSP into elementary streams.\n # When enabled, RTSP publishers sending MP2T/90000 will be demultiplexed\n # and their elementary streams (H.264, H.265, AAC, etc.) exposed as native tracks.\n # This allows HLS, WebRTC, and other outputs to work transparently with MPEG-TS sources.\n rtspDemuxMpegts: true\n```\n" }, { "path": "docs/2-publish/07-rtsp-cameras-and-servers.md", "content": "# RTSP cameras and servers\n\nMost IP cameras expose their video stream by using a RTSP server that is embedded into the camera itself. In particular, cameras that are compliant with ONVIF profile S or T meet this requirement. You can use _MediaMTX_ to connect to one or several existing RTSP servers and read their media streams:\n\n```yml\npaths:\n proxied:\n # url of the source stream, in the format rtsp://user:pass@host:port/path\n source: rtsp://original-url\n```\n\nThe resulting stream will be available on path `/proxied`.\n\nIt is possible to tune the connection by using some additional parameters:\n\n```yml\npaths:\n proxied:\n # url of the source stream, in the format rtsp://user:pass@host:port/path\n source: rtsp://original-url\n # Transport protocol used to pull the stream. available values are \"automatic\", \"udp\", \"multicast\", \"tcp\".\n rtspTransport: automatic\n # Support sources that don't provide server ports or use random server ports. This is a security issue\n # and must be used only when interacting with sources that require it.\n rtspAnyPort: no\n # Range header to send to the source, in order to start streaming from the specified offset.\n # available values:\n # * clock: Absolute time\n # * npt: Normal Play Time\n # * smpte: SMPTE timestamps relative to the start of the recording\n rtspRangeType:\n # Available values:\n # * clock: UTC ISO 8601 combined date and time string, e.g. 20230812T120000Z\n # * npt: duration such as \"300ms\", \"1.5m\" or \"2h45m\", valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\"\n # * smpte: duration such as \"300ms\", \"1.5m\" or \"2h45m\", valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\"\n rtspRangeStart:\n # Size of the UDP buffer of the RTSP client.\n # This can be increased to mitigate packet losses.\n # It defaults to the default value of the operating system.\n rtspUDPReadBufferSize: 0\n # Range of ports used as source port in outgoing UDP packets.\n rtspUDPSourcePortRange: [10000, 65535]\n```\n\nAll available parameters are listed in the [configuration file](../5-references/1-configuration-file.md).\n\nAdvanced RTSP features and settings are described in [RTSP-specific features](../4-other/23-rtsp-specific-features.md).\n" }, { "path": "docs/2-publish/08-rtmp-clients.md", "content": "# RTMP clients\n\nRTMP is a protocol that allows to read and publish streams. It supports encryption, read [RTMP-specific features](../4-other/24-rtmp-specific-features.md). Streams can be published to the server by using the URL:\n\n```\nrtmp://localhost/mystream\n```\n\nThe resulting stream will be available on path `/mystream`.\n\nSome clients that can publish with RTMP are [FFmpeg](15-ffmpeg.md), [GStreamer](16-gstreamer.md), [OBS Studio](17-obs-studio.md).\n" }, { "path": "docs/2-publish/09-rtmp-cameras-and-servers.md", "content": "# RTMP cameras and servers\n\nYou can use _MediaMTX_ to connect to one or several existing RTMP servers and read their media streams:\n\n```yml\npaths:\n proxied:\n # url of the source stream, in the format rtmp://user:pass@host:port/path\n source: rtmp://original-url\n```\n\nThe resulting stream will be available on path `/proxied`.\n" }, { "path": "docs/2-publish/10-hls-cameras-and-servers.md", "content": "# HLS cameras and servers\n\nHLS is a streaming protocol that works by splitting streams into segments, and by serving these segments and a playlist with the HTTP protocol. You can use _MediaMTX_ to connect to one or several existing HLS servers and read their media streams:\n\n```yml\npaths:\n proxied:\n # url of the playlist of the stream, in the format http://user:pass@host:port/path\n source: http://original-url/stream/index.m3u8\n```\n\nThe resulting stream will be available on path `/proxied`.\n" }, { "path": "docs/2-publish/11-mpeg-ts.md", "content": "# MPEG-TS\n\nThe server supports ingesting MPEG-TS streams, shipped in two different ways (UDP packets or Unix sockets).\n\nIn order to read a UDP MPEG-TS stream, edit `mediamtx.yml` and replace everything inside section `paths` with the following content:\n\n```yml\npaths:\n mypath:\n source: udp+mpegts://238.0.0.1:1234\n```\n\nWhere `238.0.0.1` is the IP for listening packets, in this case a multicast IP.\n\nIf the listening IP is a multicast IP, _MediaMTX_ will listen for incoming packets on the default multicast interface, picked by the operating system. It is possible to specify the interface manually by using the `interface` parameter:\n\n```yml\npaths:\n mypath:\n source: udp+mpegts://238.0.0.1:1234?interface=eth0\n```\n\nIt is possible to restrict who can send packets by using the `source` parameter:\n\n```yml\npaths:\n mypath:\n source: udp+mpegts://0.0.0.0:1234?source=192.168.3.5\n```\n\nSome clients that can publish with UDP and MPEG-TS are [FFmpeg](15-ffmpeg.md) and [GStreamer](16-gstreamer.md).\n\nUnix sockets are more efficient than UDP packets and can be used as transport by specifying the `unix+mpegts` scheme:\n\n```yml\npaths:\n mypath:\n source: unix+mpegts:///tmp/socket.sock\n```\n" }, { "path": "docs/2-publish/12-rtp.md", "content": "# RTP\n\nThe server supports ingesting RTP streams, transmitted with UDP packets.\n\nIn order to read a UDP RTP stream, edit `mediamtx.yml` and replace everything inside section `paths` with the following content:\n\n```yml\npaths:\n mypath:\n source: udp+rtp://238.0.0.1:1234\n rtpSDP: |\n v=0\n o=- 123456789 123456789 IN IP4 192.168.1.100\n s=H264 Video Stream\n c=IN IP4 192.168.1.100\n t=0 0\n m=video 5004 RTP/AVP 96\n a=rtpmap:96 H264/90000\n a=fmtp:96 profile-level-id=42e01e;packetization-mode=1;sprop-parameter-sets=Z0LAHtkDxWhAAAADAEAAAAwDxYuS,aMuMsg==\n```\n\n`rtpSDP` must contain a valid SDP, that is a description of the RTP session.\n\nSome clients that can publish with UDP and MPEG-TS are [FFmpeg](15-ffmpeg.md) and [GStreamer](16-gstreamer.md).\n" }, { "path": "docs/2-publish/13-raspberry-pi-cameras.md", "content": "# Raspberry Pi Cameras\n\n_MediaMTX_ natively supports most Raspberry Pi Camera models, enabling high-quality and low-latency video streaming from the camera to any user, for any purpose. There are some additional requirements:\n\n1. The server must run on a Raspberry Pi, with one of the following operating systems:\n - Raspberry Pi OS Trixie\n - Raspberry Pi OS Bookworm\n - Raspberry Pi OS Bullseye\n\n Both 32-bit and 64-bit architectures are supported.\n\n2. If you are using Raspberry Pi OS Bullseye, make sure that the legacy camera stack is disabled. Type `sudo raspi-config`, then go to `Interfacing options`, `enable/disable legacy camera support`, choose `no`. Reboot the system.\n\nThe setup procedure depends on whether you want to run the server outside or inside Docker:\n\n- If you want to run the standard (non-Dockerized) version of the server:\n 1. Download the server executable. If you're using 64-bit version of the operative system, make sure to pick the `arm64` variant.\n\n 2. Edit `mediamtx.yml` and replace everything inside section `paths` with the following content:\n\n ```yml\n paths:\n cam:\n source: rpiCamera\n ```\n\n The resulting stream will be available on path `/cam`.\n\n- If you want to run the server inside Docker, you need to use the `1-rpi` image and launch the container with some additional flags:\n\n ```sh\n docker run --rm -it \\\n --network=host \\\n --privileged \\\n --tmpfs /dev/shm:exec \\\n -v /run/udev:/run/udev:ro \\\n -e MTX_PATHS_CAM_SOURCE=rpiCamera \\\n bluenviron/mediamtx:1-rpi\n ```\n\nThe Raspberry Pi Camera can be controlled through a wide range of parameters, that are listed in the [configuration file](../5-references/1-configuration-file.md).\n\nBe aware that cameras that require a custom `libcamera` (like some ArduCam products) are not compatible with precompiled binaries and Docker images of _MediaMTX_, since these come with a bundled `libcamera`. If you want to use a custom one, you need to [compile from source](../6-misc/1-compile.md#custom-libcamera).\n\n## Adding audio\n\nIn order to add audio from a USB microphone, install GStreamer and alsa-utils:\n\n```sh\nsudo apt install -y gstreamer1.0-tools gstreamer1.0-rtsp gstreamer1.0-alsa alsa-utils\n```\n\nlist available audio cards with:\n\n```sh\narecord -L\n```\n\nSample output:\n\n```\nsurround51:CARD=ICH5,DEV=0\n Intel ICH5, Intel ICH5\n 5.1 Surround output to Front, Center, Rear and Subwoofer speakers\ndefault:CARD=U0x46d0x809\n USB Device 0x46d:0x809, USB Audio\n Default Audio Device\n```\n\nFind the audio card of the microphone and take note of its name, for instance `default:CARD=U0x46d0x809`. Then create a new path that takes the video stream from the camera and audio from the microphone:\n\n```yml\npaths:\n cam:\n source: rpiCamera\n\n cam_with_audio:\n runOnInit: >\n gst-launch-1.0\n rtspclientsink name=s location=rtsp://localhost:$RTSP_PORT/cam_with_audio\n rtspsrc location=rtsp://127.0.0.1:$RTSP_PORT/cam latency=0 ! rtph264depay ! s.\n alsasrc device=default:CARD=U0x46d0x809 ! opusenc bitrate=16000 ! s.\n runOnInitRestart: yes\n```\n\nThe resulting stream will be available on path `/cam_with_audio`.\n\n## Secondary stream\n\nIt is possible to enable a secondary stream from the same camera, with a different resolution, FPS and codec. Configuration is the same of a primary stream, with `rpiCameraSecondary` set to `true` and parameters adjusted accordingly:\n\n```yml\npaths:\n # primary stream\n rpi:\n source: rpiCamera\n # Width of frames.\n rpiCameraWidth: 1920\n # Height of frames.\n rpiCameraHeight: 1080\n # FPS.\n rpiCameraFPS: 30\n\n # secondary stream\n secondary:\n source: rpiCamera\n # This is a secondary stream.\n rpiCameraSecondary: true\n # Width of frames.\n rpiCameraWidth: 640\n # Height of frames.\n rpiCameraHeight: 480\n # FPS.\n rpiCameraFPS: 10\n # Codec. in case of secondary streams, it defaults to M-JPEG.\n rpiCameraCodec: auto\n # JPEG quality.\n rpiCameraMJPEGQuality: 60\n```\n\nThe secondary stream will be available on path `/secondary`.\n" }, { "path": "docs/2-publish/14-generic-webcams.md", "content": "# Generic webcams\n\nIf the operating system is Linux, edit `mediamtx.yml` and replace everything inside section `paths` with the following content:\n\n```yml\npaths:\n cam:\n runOnInit: ffmpeg -f v4l2 -i /dev/video0 -c:v libx264 -pix_fmt yuv420p -preset ultrafast -b:v 600k -f rtsp rtsp://localhost:$RTSP_PORT/$MTX_PATH\n runOnInitRestart: yes\n```\n\nIf the operating system is Windows:\n\n```yml\npaths:\n cam:\n runOnInit: ffmpeg -f dshow -i video=\"USB2.0 HD UVC WebCam\" -c:v libx264 -pix_fmt yuv420p -preset ultrafast -b:v 600k -f rtsp rtsp://localhost:$RTSP_PORT/$MTX_PATH\n runOnInitRestart: yes\n```\n\nWhere `USB2.0 HD UVC WebCam` is the name of a webcam, that can be obtained with:\n\n```sh\nffmpeg -list_devices true -f dshow -i dummy\n```\n\nThe resulting stream will be available on path `/cam`.\n" }, { "path": "docs/2-publish/15-ffmpeg.md", "content": "# FFmpeg\n\nFFmpeg can publish a stream to the server in several ways. The recommended one consists in publishing with RTSP.\n\n## FFmpeg and RTSP\n\n```sh\nffmpeg -re -stream_loop -1 -i file.mp4 -c copy -f rtsp rtsp://localhost:8554/mystream\n```\n\nThe resulting stream will be available on path `/mystream`.\n\n## FFmpeg and RTMP\n\n```sh\nffmpeg -re -stream_loop -1 -i file.mp4 -c copy -f flv rtmp://localhost:1935/mystream\n```\n\n## FFmpeg and MPEG-TS over UDP\n\nIn _MediaMTX_ configuration, add a path with `source: udp+mpegts://238.0.0.1:1234`. Then:\n\n```sh\nffmpeg -re -stream_loop -1 -i file.mp4 -c copy -f mpegts 'udp://238.0.0.1:1234?pkt_size=1316'\n```\n\n## FFmpeg and MPEG-TS over Unix socket\n\nIn _MediaMTX_ configuration, add a path with `source: unix+mpegts:///tmp/socket.sock`. Then:\n\n```sh\nffmpeg -re -f lavfi -i testsrc=size=1280x720:rate=30 \\\n-c:v libx264 -pix_fmt yuv420p -preset ultrafast -b:v 600k \\\n-f mpegts unix:/tmp/socket.sock\n```\n\n## FFmpeg and RTP over UDP\n\nIn _MediaMTX_ configuration, add a path with `source: udp+rtp://238.0.0.1:1234` and a valid `rtpSDP` (read [RTP](12-rtp.md)). Then:\n\n```sh\nffmpeg -re -f lavfi -i testsrc=size=1280x720:rate=30 \\\n-c:v libx264 -pix_fmt yuv420p -preset ultrafast -b:v 600k \\\n-f rtp udp://238.0.0.1:1234?pkt_size=1316\n```\n\n## FFmpeg and SRT\n\n```sh\nffmpeg -re -stream_loop -1 -i file.mp4 -c copy -f mpegts 'srt://localhost:8890?streamid=publish:stream&pkt_size=1316'\n```\n\n## FFmpeg and WebRTC\n\n```sh\nffmpeg -re -f lavfi -i testsrc=size=1280x720:rate=30 \\\n-f lavfi -i \"sine=frequency=1000:sample_rate=48000\" \\\n-c:v libx264 -pix_fmt yuv420p -preset ultrafast -b:v 600k \\\n-c:a libopus -ar 48000 -ac 2 -b:a 128k \\\n-f whip http://localhost:8889/stream/whip\n```\n\nWARNING: in case of FFmpeg 8.0, a video track and an audio track must both be present.\n" }, { "path": "docs/2-publish/16-gstreamer.md", "content": "# GStreamer\n\nGStreamer can publish a stream to the server in several ways. The recommended one consists in publishing with RTSP.\n\n## GStreamer and RTSP\n\n```sh\ngst-launch-1.0 rtspclientsink name=s location=rtsp://localhost:8554/mystream \\\nfilesrc location=file.mp4 ! qtdemux name=d \\\nd.video_0 ! queue ! s.sink_0 \\\nd.audio_0 ! queue ! s.sink_1\n```\n\nIf the stream is video only:\n\n```sh\ngst-launch-1.0 filesrc location=file.mp4 ! qtdemux name=d \\\nd.video_0 ! rtspclientsink location=rtsp://localhost:8554/mystream\n```\n\nThe resulting stream will be available on path `/mystream`.\n\nFor advanced options, read [RTSP-specific features](../4-other/23-rtsp-specific-features.md).\n\n## GStreamer and RTMP\n\n```sh\ngst-launch-1.0 -v flvmux name=mux ! rtmpsink location=rtmp://localhost/stream \\\nvideotestsrc ! video/x-raw,width=1280,height=720,format=I420 ! x264enc speed-preset=ultrafast bitrate=3000 key-int-max=60 ! video/x-h264,profile=high ! mux. \\\naudiotestsrc ! audioconvert ! avenc_aac ! mux.\n```\n\n## GStreamer and MPEG-TS over UDP\n\n```sh\ngst-launch-1.0 -v mpegtsmux name=mux alignment=1 ! udpsink host=238.0.0.1 port=1234 \\\nvideotestsrc ! video/x-raw,width=1280,height=720,format=I420 ! x264enc speed-preset=ultrafast bitrate=3000 key-int-max=60 ! video/x-h264,profile=high ! mux. \\\naudiotestsrc ! audioconvert ! avenc_aac ! mux.\n```\n\nFor advanced options, read [RTSP-specific features](../4-other/23-rtsp-specific-features.md).\n\n## GStreamer and WebRTC\n\nMake sure that GStreamer version is at least 1.22, and that if the codec is H264, the profile is baseline. Use the `whipclientsink` element:\n\n```sh\ngst-launch-1.0 videotestsrc \\\n! video/x-raw,width=1920,height=1080,format=I420 \\\n! x264enc speed-preset=ultrafast bitrate=2000 \\\n! video/x-h264,profile=baseline \\\n! whipclientsink signaller::whip-endpoint=http://localhost:8889/mystream/whip\n```\n" }, { "path": "docs/2-publish/17-obs-studio.md", "content": "# OBS Studio\n\nOBS Studio can publish streams to the server in several ways. The recommended one consists in publishing with RTMP.\n\n## OBS Studio and RTMP\n\nIn `Settings -> Stream` (or in the Auto-configuration Wizard), use the following parameters:\n\n- Service: `Custom...`\n- Server: `rtmp://localhost/mystream`\n- Stream key: (empty)\n\nSave the configuration and click `Start streaming`.\n\nThe resulting stream will be available on path `/mystream`.\n\nIf you want to generate a stream that can be read with WebRTC, open `Settings -> Output -> Recording` and use the following parameters:\n\n- FFmpeg output type: `Output to URL`\n- File path or URL: `rtsp://localhost:8554/mystream`\n- Container format: `rtsp`\n- Check `show all codecs (even if potentially incompatible)`\n- Video encoder: `h264_nvenc (libx264)`\n- Video encoder settings (if any): `bf=0`\n- Audio track: `1`\n- Audio encoder: `libopus`\n\nThen use the button `Start Recording` (instead of `Start Streaming`) to start streaming.\n\n## OBS Studio and RTMP, multitrack video\n\nOBS Studio can publish multiple video tracks or renditions at once (simulcast). Make sure that the OBS Studio version is ≥ 31.0.0. Open `Settings -> Stream` and use the following parameters:\n\n- Service: `Custom...`\n- Server: `rtmp://localhost/mystream`\n- Stream key: (empty)\n- Turn on `Enable Multitrack Video`\n- Leave `Maximum Streaming Bandwidth` and `Maximum Video Tracks` to `Auto`\n- Turn on `Enable Config Override`\n- Fill `Config Override (JSON)` with the following text:\n\n ```json\n {\n \"encoder_configurations\": [\n {\n \"type\": \"obs_x264\",\n \"width\": 1920,\n \"height\": 1080,\n \"framerate\": {\n \"numerator\": 30,\n \"denominator\": 1\n },\n \"settings\": {\n \"rate_control\": \"CBR\",\n \"bitrate\": 6000,\n \"keyint_sec\": 2,\n \"preset\": \"veryfast\",\n \"profile\": \"high\",\n \"tune\": \"zerolatency\"\n },\n \"canvas_index\": 0\n },\n {\n \"type\": \"obs_x264\",\n \"width\": 640,\n \"height\": 480,\n \"framerate\": {\n \"numerator\": 30,\n \"denominator\": 1\n },\n \"settings\": {\n \"rate_control\": \"CBR\",\n \"bitrate\": 3000,\n \"keyint_sec\": 2,\n \"preset\": \"veryfast\",\n \"profile\": \"main\",\n \"tune\": \"zerolatency\"\n },\n \"canvas_index\": 0\n }\n ],\n \"audio_configurations\": {\n \"live\": [\n {\n \"codec\": \"ffmpeg_aac\",\n \"track_id\": 1,\n \"channels\": 2,\n \"settings\": {\n \"bitrate\": 160\n }\n }\n ]\n }\n }\n ```\n\n This can be adjusted according to specific needs. In particular, the `type` field is used to set the video encoder, and these are the available parameters:\n - `obs_nvenc_av1_tex`: NVIDIA NVENC AV1\n - `obs_nvenc_hevc_tex`: NVIDIA NVENC H265\n - `obs_nvenc_h264_tex`: NVIDIA NVENC H264\n - `av1_texture_amf`: AMD AV1\n - `h265_texture_amf`: AMD H265\n - `h264_texture_amf`: AMD H264\n - `obs_qsv11_av1`: QuickSync AV1\n - `obs_qsv11_v2`: QuickSync H264\n - `obs_x264`: software H264\n\nSave the configuration and click `Start streaming`.\n\nThe resulting stream will be available on path `/mystream`.\n\n## OBS Studio and WebRTC\n\nRecent versions of OBS Studio can also publish streams to the server with the [WebRTC / WHIP protocol](04-webrtc-clients.md) Use the following parameters:\n\n- Service: `WHIP`\n- Server: `http://localhost:8889/mystream/whip`\n\nSave the configuration and click `Start streaming`.\n\nThe resulting stream will be available on path `/mystream`.\n\n## OBS Studio and WebRTC, multitrack video\n\nOBS Studio can publish multiple video tracks or renditions at once (simulcast) with WebRTC / WHIP too. Make sure that the OBS Studio version is ≥ 32.1.0. Open `Settings -> Stream` and use the following parameters:\n\n- Service: `WHIP`\n- Server: `http://localhost:8889/mystream/whip`\n- Simulcast, Total Layers: `2` (or greater)\n\nCurrently it's not possible to change resolution or bitrate (or canvas) of renditions, since quality of secondary renditions is hardcoded as a percentage of the main one. You can find details on the [OBS documentation](https://obsproject.com/kb/whip-streaming-guide).\n\nSave the configuration and click `Start streaming`.\n\nThe resulting stream will be available on path `/mystream`.\n" }, { "path": "docs/2-publish/18-python-opencv.md", "content": "# Python and OpenCV\n\nPython-based software can publish streams to the server with the OpenCV library and its GStreamer plugin, acting as a [RTSP client](06-rtsp-clients.md). OpenCV must be compiled with support for GStreamer, by following this procedure:\n\n```sh\nsudo apt install -y libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-plugins-ugly gstreamer1.0-rtsp python3-dev python3-numpy\ngit clone --depth=1 -b 4.5.4 https://github.com/opencv/opencv\ncd opencv\nmkdir build && cd build\ncmake -D CMAKE_INSTALL_PREFIX=/usr -D WITH_GSTREAMER=ON ..\nmake -j$(nproc)\nsudo make install\n```\n\nYou can check that OpenCV has been installed correctly by running:\n\n```sh\npython3 -c 'import cv2; print(cv2.getBuildInformation())'\n```\n\nCheck that the output contains `GStreamer: YES`.\n\nVideos can then be published with `cv2.VideoWriter`:\n\n```python\nfrom datetime import datetime\nfrom time import sleep, time\n\nimport cv2\nimport numpy as np\n\nfps = 15\nwidth = 800\nheight = 600\ncolors = [\n (0, 0, 255),\n (255, 0, 0),\n (0, 255, 0),\n]\n\nout = cv2.VideoWriter('appsrc ! videoconvert' + \\\n ' ! video/x-raw,format=I420' + \\\n ' ! x264enc speed-preset=ultrafast bitrate=600 key-int-max=' + str(fps * 2) + \\\n ' ! video/x-h264,profile=baseline' + \\\n ' ! rtspclientsink location=rtsp://localhost:8554/mystream',\n cv2.CAP_GSTREAMER, 0, fps, (width, height), True)\nif not out.isOpened():\n raise Exception(\"can't open video writer\")\n\ncurcolor = 0\nstart = time()\n\nwhile True:\n frame = np.zeros((height, width, 3), np.uint8)\n\n # create a rectangle\n color = colors[curcolor]\n curcolor += 1\n curcolor %= len(colors)\n for y in range(0, int(frame.shape[0] / 2)):\n for x in range(0, int(frame.shape[1] / 2)):\n frame[y][x] = color\n\n out.write(frame)\n print(\"%s frame written to the server\" % datetime.now())\n\n now = time()\n diff = (1 / fps) - now - start\n if diff > 0:\n sleep(diff)\n start = now\n```\n\nThe resulting stream will be available on path `/mystream`.\n" }, { "path": "docs/2-publish/19-golang.md", "content": "# Golang\n\nYou can publish a stream to the server by using the Go programming language and the following libraries:\n\n- [gortsplib](https://github.com/bluenviron/gortsplib) to publish with RTSP.\n- [gortmplib](https://github.com/bluenviron/gortmplib) to publish with RTMP.\n\nBoth powers _MediaMTX_ itself. In the repositories of these projects there are several examples on how to connect to a server and push data.\n" }, { "path": "docs/2-publish/20-unity.md", "content": "# Unity\n\nSoftware written with the Unity Engine can publish a stream to the server by using the [WebRTC protocol](04-webrtc-clients.md).\n\nCreate a new Unity project or open an existing one.\n\nOpen _Window -> Package Manager_, click on the plus sign, _Add Package by name..._ and insert `com.unity.webrtc`. Wait for the package to be installed.\n\nIn the _Project_ window, under `Assets`, create a new C# Script called `WebRTCPublisher.cs` with this content:\n\n```cs\nusing System.Collections;\nusing UnityEngine;\nusing Unity.WebRTC;\nusing UnityEngine.Networking;\n\npublic class WebRTCPublisher : MonoBehaviour\n{\n public string url = \"http://localhost:8889/unity/whip\";\n public int videoWidth = 1280;\n public int videoHeight = 720;\n\n private RTCPeerConnection pc;\n private MediaStream videoStream;\n\n void Start()\n {\n pc = new RTCPeerConnection();\n Camera sourceCamera = gameObject.GetComponent();\n videoStream = sourceCamera.CaptureStream(videoWidth, videoHeight);\n foreach (var track in videoStream.GetTracks())\n {\n pc.AddTrack(track);\n }\n\n StartCoroutine(WebRTC.Update());\n StartCoroutine(createOffer());\n }\n\n private IEnumerator createOffer()\n {\n var op = pc.CreateOffer();\n yield return op;\n if (op.IsError) {\n Debug.LogError(\"CreateOffer() failed\");\n yield break;\n }\n\n yield return setLocalDescription(op.Desc);\n }\n\n private IEnumerator setLocalDescription(RTCSessionDescription offer)\n {\n var op = pc.SetLocalDescription(ref offer);\n yield return op;\n if (op.IsError) {\n Debug.LogError(\"SetLocalDescription() failed\");\n yield break;\n }\n\n yield return postOffer(offer);\n }\n\n private IEnumerator postOffer(RTCSessionDescription offer)\n {\n var content = new System.Net.Http.StringContent(offer.sdp);\n content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue(\"application/sdp\");\n var client = new System.Net.Http.HttpClient();\n\n var task = System.Threading.Tasks.Task.Run(async () => {\n var res = await client.PostAsync(new System.UriBuilder(url).Uri, content);\n res.EnsureSuccessStatusCode();\n return await res.Content.ReadAsStringAsync();\n });\n yield return new WaitUntil(() => task.IsCompleted);\n if (task.Exception != null) {\n Debug.LogError(task.Exception);\n yield break;\n }\n\n yield return setRemoteDescription(task.Result);\n }\n\n private IEnumerator setRemoteDescription(string answer)\n {\n RTCSessionDescription desc = new RTCSessionDescription();\n desc.type = RTCSdpType.Answer;\n desc.sdp = answer;\n var op = pc.SetRemoteDescription(ref desc);\n yield return op;\n if (op.IsError) {\n Debug.LogError(\"SetRemoteDescription() failed\");\n yield break;\n }\n\n yield break;\n }\n\n void OnDestroy()\n {\n pc?.Close();\n pc?.Dispose();\n videoStream?.Dispose();\n }\n}\n```\n\nIn the _Hierarchy_ window, find or create a scene and a camera, then add the `WebRTCPublisher.cs` script as component of the camera, by dragging it inside the _Inspector_ window. then Press the _Play_ button at the top of the page.\n\nThe resulting stream will be available on path `/unity`.\n" }, { "path": "docs/2-publish/21-web-browsers.md", "content": "# Web browsers\n\nWeb browsers can publish a stream to the server by using the [WebRTC protocol](04-webrtc-clients.md). Start the server and open the web page:\n\n```\nhttp://localhost:8889/mystream/publish\n```\n\nThe resulting stream will be available on path `/mystream`.\n\nThis web page can be embedded into another web page by using an iframe:\n\n```html\n\n```\n\nFor more advanced setups, you can create and serve a custom web page by starting from the [source code of the WebRTC publish page](https://github.com/bluenviron/mediamtx/blob/{version_tag}/internal/servers/webrtc/publish_index.html). In particular, there's a ready-to-use, standalone JavaScript class for publishing streams with WebRTC, available in [publisher.js](https://github.com/bluenviron/mediamtx/blob/{version_tag}/internal/servers/webrtc/publisher.js).\n" }, { "path": "docs/2-publish/index.md", "content": "# Publish\n" }, { "path": "docs/3-read/01-overview.md", "content": "# Read a stream\n\nLive streams can be read from the server with the following protocols and codecs:\n\n| protocol | variants | codecs |\n| ------------------------------ | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| [SRT clients](02-srt.md) | | **Video**: H265, H264, MPEG-4 Video (H263, Xvid), MPEG-1/2 Video
**Audio**: Opus, MPEG-4 Audio (AAC), MPEG-1/2 Audio (MP3), AC-3
**Other**: KLV |\n| [WebRTC clients](03-webrtc.md) | WHEP | **Video**: AV1, VP9, VP8, H265, H264
**Audio**: Opus, G722, G711 (PCMA, PCMU)
**Other**: KLV |\n| [RTSP clients](04-rtsp.md) | UDP, UDP-Multicast, TCP, RTSPS | **Video**: AV1, VP9, VP8, H265, H264, MPEG-4 Video (H263, Xvid), MPEG-1/2 Video, M-JPEG
**Audio**: Opus, MPEG-4 Audio (AAC), MPEG-1/2 Audio (MP3), AC-3, G726, G722, G711 (PCMA, PCMU), LPCM
**Other**: KLV, MPEG-TS, any RTP-compatible codec |\n| [RTMP clients](05-rtmp.md) | RTMP, RTMPS, Enhanced RTMP | **Video**: AV1, VP9, H265, H264
**Audio**: Opus, MPEG-4 Audio (AAC), MPEG-1/2 Audio (MP3), AC-3, G711 (PCMA, PCMU), LPCM |\n| [HLS](06-hls.md) | Low-Latency HLS, MP4-based HLS, legacy HLS | **Video**: AV1, VP9, H265, H264
**Audio**: Opus, MPEG-4 Audio (AAC) |\n\nWe provide instructions for reading with the following software:\n\n- [FFmpeg](07-ffmpeg.md)\n- [GStreamer](08-gstreamer.md)\n- [VLC](09-vlc.md)\n- [OBS Studio](10-obs-studio.md)\n- [Python and OpenCV](11-python-opencv.md)\n- [Golang](12-golang.md)\n- [Unity](13-unity.md)\n- [Web browsers](14-web-browsers.md)\n" }, { "path": "docs/3-read/02-srt.md", "content": "# SRT clients\n\nSRT is a protocol that allows to publish and read live data stream, providing encryption, integrity and a retransmission mechanism. It is usually used to transfer media streams encoded with MPEG-TS. In order to read a stream from the server with the SRT protocol, use this URL:\n\n```\nsrt://localhost:8890?streamid=read:mystream\n```\n\nReplace `mystream` with the path name.\n\nIf you need to use the standard stream ID syntax instead of the custom one in use by this server, read [Standard stream ID syntax](../4-other/21-srt-specific-features.md#standard-stream-id-syntax).\n\nSome clients that can read with SRT are [FFmpeg](07-ffmpeg.md), [GStreamer](08-gstreamer.md) and [VLC](09-vlc.md).\n" }, { "path": "docs/3-read/03-webrtc.md", "content": "# WebRTC clients\n\nWebRTC is an API that makes use of a set of protocols and methods to connect two clients together and allow them to exchange live media or data streams. You can read a stream with WebRTC and a web browser by visiting:\n\n```\nhttp://localhost:8889/mystream\n```\n\nWHEP is a WebRTC extension that allows to read streams by using a URL, without passing through a web page. This allows to use WebRTC as a general purpose streaming protocol. If you are using a software that supports WHEP, you can read a stream from the server by using this URL:\n\n```\nhttp://localhost:8889/mystream/whep\n```\n\nBe aware that not all browsers can read any codec, check [Supported browsers](../4-other/22-webrtc-specific-features.md#supported-browsers).\n\nDepending on the network it may be difficult to establish a connection between server and clients, read [Solving WebRTC connectivity issues](../4-other/22-webrtc-specific-features.md#solving-webrtc-connectivity-issues).\n\nSome clients that can read with WebRTC and WHEP are [FFmpeg](07-ffmpeg.md), [GStreamer](08-gstreamer.md), [Unity](13-unity.md) and [web browsers](14-web-browsers.md).\n" }, { "path": "docs/3-read/04-rtsp.md", "content": "# RTSP clients\n\nRTSP is a protocol that allows to publish and read streams. It supports several underlying transport protocols and encryption (read [RTSP-specific features](../4-other/23-rtsp-specific-features.md)). In order to read a stream with the RTSP protocol, use this URL:\n\n```\nrtsp://localhost:8554/mystream\n```\n\nSome clients that can read with RTSP are [FFmpeg](07-ffmpeg.md), [GStreamer](08-gstreamer.md) and [VLC](09-vlc.md).\n" }, { "path": "docs/3-read/05-rtmp.md", "content": "# RTMP clients\n\nRTMP is a protocol that allows to read and publish streams. It supports encryption, read [RTMP-specific features](../4-other/24-rtmp-specific-features.md). Streams can be read from the server by using the URL:\n\n```\nrtmp://localhost/mystream\n```\n\nSome clients that can read with RTMP are [FFmpeg](07-ffmpeg.md), [GStreamer](08-gstreamer.md) and [VLC](09-vlc.md).\n" }, { "path": "docs/3-read/06-hls.md", "content": "# HLS\n\nHLS is a protocol that works by splitting streams into segments, and by serving these segments and a playlist with the HTTP protocol. You can use _MediaMTX_ to generate an HLS stream, that is accessible through a web page:\n\n```\nhttp://localhost:8888/mystream\n```\n\nand can also be accessed without using the browsers, by software that supports the HLS protocol (for instance VLC or _MediaMTX_ itself) by using this URL:\n\n```\nhttp://localhost:8888/mystream/index.m3u8\n```\n\nSome clients that can read with HLS are [FFmpeg](07-ffmpeg.md), [GStreamer](08-gstreamer.md), [VLC](09-vlc.md) and [web browsers](14-web-browsers.md).\n" }, { "path": "docs/3-read/07-ffmpeg.md", "content": "# FFmpeg\n\nFFmpeg can read a stream from the server in several ways. The recommended one consists in reading with RTSP.\n\n## FFmpeg and RTSP\n\n```sh\nffmpeg -i rtsp://localhost:8554/mystream -c copy output.mp4\n```\n\n## FFmpeg and RTMP\n\n```sh\nffmpeg -i rtmp://localhost/mystream -c copy output.mp4\n```\n\nIn order to read AV1, VP9, H265, Opus, AC3 tracks and in order to read multiple video or audio tracks, the `-rtmp_enhanced_codecs` flag must be present:\n\n```sh\nffmpeg -rtmp_enhanced_codecs ac-3,av01,avc1,ec-3,fLaC,hvc1,.mp3,mp4a,Opus,vp09 \\\n-i rtmp://localhost/mystream -c copy output.mp4\n```\n\n## FFmpeg and SRT\n\n```sh\nffmpeg -i 'srt://localhost:8890?streamid=read:test' -c copy output.mp4\n```\n" }, { "path": "docs/3-read/08-gstreamer.md", "content": "# GStreamer\n\nGStreamer can read a stream from the server in several ways. The recommended one consists in reading with RTSP.\n\n## GStreamer and RTSP\n\n```sh\ngst-launch-1.0 rtspsrc location=rtsp://127.0.0.1:8554/mystream latency=0 ! decodebin ! autovideosink\n```\n\nFor advanced options, read [RTSP-specific features](../4-other/23-rtsp-specific-features.md).\n\n## GStreamer and WebRTC\n\nGStreamer also supports reading streams with WebRTC/WHEP, although track codecs must be specified in advance through the `video-caps` and `audio-caps` parameters. Furthermore, if audio is not present, `audio-caps` must be set anyway and must point to a PCMU codec. For instance, the command for reading a video-only H264 stream is:\n\n```sh\ngst-launch-1.0 whepsrc whep-endpoint=http://127.0.0.1:8889/stream/whep use-link-headers=true \\\nvideo-caps=\"application/x-rtp,media=video,encoding-name=H264,payload=127,clock-rate=90000\" \\\naudio-caps=\"application/x-rtp,media=audio,encoding-name=PCMU,payload=0,clock-rate=8000\" \\\n! rtph264depay ! decodebin ! autovideosink\n```\n\nWhile the command for reading an audio-only Opus stream is:\n\n```sh\ngst-launch-1.0 whepsrc whep-endpoint=\"http://127.0.0.1:8889/stream/whep\" use-link-headers=true \\\naudio-caps=\"application/x-rtp,media=audio,encoding-name=OPUS,payload=111,clock-rate=48000,encoding-params=(string)2\" \\\n! rtpopusdepay ! decodebin ! autoaudiosink\n```\n\nWhile the command for reading a H264 and Opus stream is:\n\n```sh\ngst-launch-1.0 whepsrc whep-endpoint=http://127.0.0.1:8889/stream/whep use-link-headers=true \\\nvideo-caps=\"application/x-rtp,media=video,encoding-name=H264,payload=127,clock-rate=90000\" \\\naudio-caps=\"application/x-rtp,media=audio,encoding-name=OPUS,payload=111,clock-rate=48000,encoding-params=(string)2\" \\\n! decodebin ! autovideosink\n```\n" }, { "path": "docs/3-read/09-vlc.md", "content": "# VLC\n\nVLC can read a stream from the server in several ways. The recommended one consists in reading with RTSP:\n\n```sh\nvlc --network-caching=50 rtsp://localhost:8554/mystream\n```\n\n## RTSP and Ubuntu compatibility\n\nThe VLC shipped with Ubuntu 21.10 doesn't support playing RTSP due to a license issue (read [here](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=982299) and [here](https://stackoverflow.com/questions/69766748/cvlc-cannot-play-rtsp-omxplayer-instead-can)). To fix the issue, remove the default VLC instance and install the snap version:\n\n```sh\nsudo apt purge -y vlc\nsnap install vlc\n```\n\n## Encrypted RTSP compatibility\n\nAt the moment VLC doesn't support reading encrypted RTSP streams. However, you can use a proxy like [stunnel](https://www.stunnel.org) or [nginx](https://nginx.org/) or a local _MediaMTX_ instance to decrypt streams before reading them.\n" }, { "path": "docs/3-read/10-obs-studio.md", "content": "# OBS Studio\n\nOBS Studio can read streams from the server by using the [RTSP protocol](04-rtsp.md).\n\nOpen OBS, click on _Add Source_, _Media source_, _OK_, uncheck _Local file_, insert in _Input_:\n\n```\nrtsp://localhost:8554/stream\n```\n\nThen _Ok_.\n" }, { "path": "docs/3-read/11-python-opencv.md", "content": "# Python and OpenCV\n\nPython-based software can read streams from the server with the OpenCV library, acting as a [RTSP client](04-rtsp.md).\n\n```python\nimport cv2\n\ncap = cv2.VideoCapture('rtsp://localhost:8554/mystream')\nif not cap.isOpened():\n raise Exception(\"can't open video capture\")\n\nwhile True:\n ret, frame = cap.read()\n if not ret:\n raise Exception(\"can't receive frame\")\n\n cv2.imshow('frame', frame)\n\n if cv2.waitKey(1) == ord('q'):\n break\n\ncap.release()\ncv2.destroyAllWindows()\n```\n" }, { "path": "docs/3-read/12-golang.md", "content": "# Golang\n\nYou can read a stream from the server by using the Go programming language and the following libraries:\n\n- [gortsplib](https://github.com/bluenviron/gortsplib) to read with RTSP.\n- [gortmplib](https://github.com/bluenviron/gortmplib) to read with RTMP.\n- [gohlslib](https://github.com/bluenviron/gohlslib) to read with HLS.\n\nAll these power _MediaMTX_ itself. In the repositories of these projects there are several examples on how to connect to a server and read data.\n" }, { "path": "docs/3-read/13-unity.md", "content": "# Unity\n\nSoftware written with the Unity Engine can read a stream from the server by using the [WebRTC protocol](03-webrtc.md).\n\nCreate a new Unity project or open an existing one.\n\nOpen _Window -> Package Manager_, click on the plus sign, _Add Package by name..._ and insert `com.unity.webrtc`. Wait for the package to be installed.\n\nIn the _Project_ window, under `Assets`, create a new C# Script called `WebRTCReader.cs` with this content:\n\n```cs\nusing System.Collections;\nusing UnityEngine;\nusing Unity.WebRTC;\n\npublic class WebRTCReader : MonoBehaviour\n{\n public string url = \"http://localhost:8889/stream/whep\";\n\n private RTCPeerConnection pc;\n private MediaStream receiveStream;\n\n void Start()\n {\n UnityEngine.UI.RawImage rawImage = gameObject.GetComponentInChildren();\n AudioSource audioSource = gameObject.GetComponentInChildren();\n pc = new RTCPeerConnection();\n receiveStream = new MediaStream();\n\n pc.OnTrack = e =>\n {\n receiveStream.AddTrack(e.Track);\n };\n\n receiveStream.OnAddTrack = e =>\n {\n if (e.Track is VideoStreamTrack videoTrack)\n {\n videoTrack.OnVideoReceived += (tex) =>\n {\n rawImage.texture = tex;\n };\n }\n else if (e.Track is AudioStreamTrack audioTrack)\n {\n audioSource.SetTrack(audioTrack);\n audioSource.loop = true;\n audioSource.Play();\n }\n };\n\n RTCRtpTransceiverInit init = new RTCRtpTransceiverInit();\n init.direction = RTCRtpTransceiverDirection.RecvOnly;\n pc.AddTransceiver(TrackKind.Audio, init);\n pc.AddTransceiver(TrackKind.Video, init);\n\n StartCoroutine(WebRTC.Update());\n StartCoroutine(createOffer());\n }\n\n private IEnumerator createOffer()\n {\n var op = pc.CreateOffer();\n yield return op;\n if (op.IsError) {\n Debug.LogError(\"CreateOffer() failed\");\n yield break;\n }\n\n yield return setLocalDescription(op.Desc);\n }\n\n private IEnumerator setLocalDescription(RTCSessionDescription offer)\n {\n var op = pc.SetLocalDescription(ref offer);\n yield return op;\n if (op.IsError) {\n Debug.LogError(\"SetLocalDescription() failed\");\n yield break;\n }\n\n yield return postOffer(offer);\n }\n\n private IEnumerator postOffer(RTCSessionDescription offer)\n {\n var content = new System.Net.Http.StringContent(offer.sdp);\n content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue(\"application/sdp\");\n var client = new System.Net.Http.HttpClient();\n\n var task = System.Threading.Tasks.Task.Run(async () => {\n var res = await client.PostAsync(new System.UriBuilder(url).Uri, content);\n res.EnsureSuccessStatusCode();\n return await res.Content.ReadAsStringAsync();\n });\n yield return new WaitUntil(() => task.IsCompleted);\n if (task.Exception != null) {\n Debug.LogError(task.Exception);\n yield break;\n }\n\n yield return setRemoteDescription(task.Result);\n }\n\n private IEnumerator setRemoteDescription(string answer)\n {\n RTCSessionDescription desc = new RTCSessionDescription();\n desc.type = RTCSdpType.Answer;\n desc.sdp = answer;\n var op = pc.SetRemoteDescription(ref desc);\n yield return op;\n if (op.IsError) {\n Debug.LogError(\"SetRemoteDescription() failed\");\n yield break;\n }\n\n yield break;\n }\n\n void OnDestroy()\n {\n pc?.Close();\n pc?.Dispose();\n receiveStream?.Dispose();\n }\n}\n```\n\nEdit the `url` variable according to your needs.\n\nIn the _Hierarchy_ window, find or create a scene. Inside the scene, add a _Canvas_. Inside the Canvas, add a _Raw Image_ and an _Audio Source_. Then add the `WebRTCReader.cs` script as component of the canvas, by dragging it inside the _Inspector_ window. then Press the _Play_ button at the top of the page.\n" }, { "path": "docs/3-read/14-web-browsers.md", "content": "# Web browsers\n\nWeb browsers can read a stream from the server in several ways.\n\n## Web browsers and WebRTC\n\nYou can read a stream by using the [WebRTC protocol](03-webrtc.md) by visiting the web page:\n\n```\nhttp://localhost:8889/mystream\n```\n\nSee [Embed streams in a website](../4-other/14-embed-streams-in-a-website.md) for instructions on how to embed the stream into an external website.\n\n## Web browsers and HLS\n\nWeb browsers can also read a stream with the [HLS protocol](06-hls.md). Latency is higher but there are fewer problems related to connectivity between server and clients, furthermore the server load can be balanced by using a common HTTP CDN (like Cloudflare or CloudFront), and this allows to handle an unlimited amount of readers. Visit the web page:\n\n```\nhttp://localhost:8888/mystream\n```\n\nSee [Embed streams in a website](../4-other/14-embed-streams-in-a-website.md) for instructions on how to embed the stream into an external website.\n" }, { "path": "docs/3-read/index.md", "content": "# Read\n" }, { "path": "docs/4-other/02-configuration.md", "content": "# Configuration\n\nAll the configuration parameters are listed and commented in the [configuration file](../5-references/1-configuration-file.md) (`mediamtx.yml`).\n\n## Change the configuration\n\nThere are several ways to change the configuration:\n\n1. By editing the configuration file, that is\n - included into the release bundle\n - available in the root folder of the Docker image (`/mediamtx.yml`); it can be overridden in this way:\n\n ```sh\n docker run --rm -it --network=host -v \"$PWD/mediamtx.yml:/mediamtx.yml:ro\" bluenviron/mediamtx:1\n ```\n\n The configuration can be changed dynamically when the server is running (hot reloading) by writing to the configuration file. Changes are detected and applied without disconnecting existing clients, whenever it's possible.\n\n2. By overriding configuration parameters with environment variables, in the format `MTX_PARAMNAME`, where `PARAMNAME` is the uppercase name of a parameter. For instance, the `rtspAddress` parameter can be overridden in the following way:\n\n ```\n MTX_RTSPADDRESS=\"127.0.0.1:8554\" ./mediamtx\n ```\n\n Parameters that have array as value can be overridden by setting a comma-separated list. For example:\n\n ```\n MTX_RTSPTRANSPORTS=\"tcp,udp\"\n ```\n\n Parameters in maps can be overridden by using underscores, in the following way:\n\n ```\n MTX_PATHS_TEST_SOURCE=rtsp://myurl ./mediamtx\n ```\n\n Parameters in lists can be overridden in the same way as parameters in maps, using their position like an additional key. This is particularly useful if you want to use internal users but define credentials through environment variables:\n\n ```\n MTX_AUTHINTERNALUSERS_0_USER=username\n MTX_AUTHINTERNALUSERS_0_PASS=password\n ```\n\n This method is particularly useful when using Docker; any configuration parameter can be changed by passing environment variables with the `-e` flag:\n\n ```\n docker run --rm -it --network=host -e MTX_PATHS_TEST_SOURCE=rtsp://myurl bluenviron/mediamtx:1\n ```\n\n3. By using the [Control API](18-control-api.md).\n\n## Encrypt the configuration\n\nThe configuration file can be entirely encrypted for security purposes by using the `crypto_secretbox` function of the NaCL function. An online tool for performing this operation is [available here](https://play.golang.org/p/rX29jwObNe4).\n\nAfter performing the encryption, put the base64-encoded result into the configuration file, and launch the server with the `MTX_CONFKEY` variable:\n\n```\nMTX_CONFKEY=mykey ./mediamtx\n```\n" }, { "path": "docs/4-other/03-authentication.md", "content": "# Authentication\n\n_MediaMTX_ can be configured to ask clients for credentials, either in the form of username/password or a string-based token. These credentials are then validated through a chosen method.\n\n## Credential validation\n\nCredentials can be validated through one of these methods:\n\n- Internal database: credentials are stored in the configuration file\n- External HTTP server: an external HTTP URL is contacted to perform authentication\n- External JWT provider: an external identity server provides signed tokens that are then verified by the server\n\n### Internal database\n\nThe internal authentication method is the default one. Users are stored inside the configuration file, in this format:\n\n```yml\nauthInternalUsers:\n # Username. 'any' means any user, including anonymous ones.\n - user: any\n # Password. Not used in case of 'any' user.\n pass:\n # IPs or networks allowed to use this user. An empty list means any IP.\n ips: []\n # Permissions.\n permissions:\n # Available actions are: publish, read, playback, api, metrics, pprof.\n - action: publish\n # Paths can be set to further restrict access to a specific path.\n # An empty path means any path.\n # Regular expressions can be used by using a tilde as prefix.\n path:\n - action: read\n path:\n - action: playback\n path:\n```\n\nOnly clients that provide a valid username and password will be able to perform a certain action.\n\nIf storing plain credentials in the configuration file is a security problem, username and passwords can be stored as hashed strings. The Argon2 and SHA256 hashing algorithms are supported. To use Argon2, the string must be hashed using Argon2id (recommended) or Argon2i:\n\n```\necho -n \"mypass\" | argon2 saltItWithSalt -id -l 32 -e\n```\n\nThen stored with the `argon2:` prefix:\n\n```yml\nauthInternalUsers:\n - user: argon2:$argon2id$v=19$m=4096,t=3,p=1$MTIzNDU2Nzg$OGGO0eCMN0ievb4YGSzvS/H+Vajx1pcbUmtLp2tRqRU\n pass: argon2:$argon2i$v=19$m=4096,t=3,p=1$MTIzNDU2Nzg$oct3kOiFywTdDdt19kT07hdvmsPTvt9zxAUho2DLqZw\n permissions:\n - action: publish\n```\n\nTo use SHA256, the string must be hashed with SHA256 and encoded with base64:\n\n```\necho -n \"mypass\" | openssl dgst -binary -sha256 | openssl base64\n```\n\nThen stored with the `sha256:` prefix:\n\n```yml\nauthInternalUsers:\n - user: sha256:j1tsRqDEw9xvq/D7/9tMx6Jh/jMhk3UfjwIB2f1zgMo=\n pass: sha256:BdSWkrdV+ZxFBLUQQY7+7uv9RmiSVA8nrPmjGjJtZQQ=\n permissions:\n - action: publish\n```\n\n**WARNING**: enable encryption or use a VPN to ensure that no one is intercepting the credentials in transit.\n\n### External HTTP server\n\nAuthentication can be delegated to an external HTTP server:\n\n```yml\nauthMethod: http\nauthHTTPAddress: http://myauthserver/auth\n```\n\nEach time a user needs to be authenticated, the specified URL will be requested with the POST method and this payload:\n\n```json\n{\n \"user\": \"user\",\n \"password\": \"password\",\n \"token\": \"token\",\n \"ip\": \"ip\",\n \"action\": \"publish|read|playback|api|metrics|pprof\",\n \"path\": \"path\",\n \"protocol\": \"rtsp|rtmp|hls|webrtc|srt\",\n \"id\": \"id\",\n \"query\": \"query\"\n}\n```\n\nIf the URL returns a status code that begins with `20` (i.e. `200`), authentication is successful, otherwise it fails. Be aware that it's perfectly normal for the authentication server to receive requests with empty users and passwords, i.e.:\n\n```json\n{\n \"user\": \"\",\n \"password\": \"\"\n}\n```\n\nThis happens because RTSP clients don't provide credentials until they are asked to. In order to receive the credentials, the authentication server must reply with status code `401`, then the client will send credentials.\n\nSome actions can be excluded from the process:\n\n```yml\n# Actions to exclude from HTTP-based authentication.\n# Format is the same as the one of user permissions.\nauthHTTPExclude:\n - action: api\n - action: metrics\n - action: pprof\n```\n\nIf the authentication server uses HTTPS and has a self-signed or invalid TLS certificate, you can provide the fingerprint of the certificate to validate it anyway:\n\n```yml\nauthMethod: http\nauthHTTPAddress: https://myauthserver/auth\nauthHTTPFingerprint: 33949e05fffb5ff3e8aa16f8213a6251b4d9363804ba53233c4da9a46d6f2739\n```\n\nThe fingerprint can be obtained with:\n\n```sh\nopenssl s_client -connect myauthserver:443 /dev/null | sed -n '/BEGIN/,/END/p' > server.crt\nopenssl x509 -in server.crt -noout -fingerprint -sha256 | cut -d \"=\" -f2 | tr -d ':'\n```\n\n### External JWT provider\n\nAuthentication can be delegated to an external identity server, that is capable of generating JWTs and provides a JWKS endpoint. With respect to the HTTP-based method, this has the advantage that the external server is contacted once, and not for every request, greatly improving performance. In order to use the JWT-based authentication method, set `authMethod` and `authJWTJWKS`:\n\n```yml\nauthMethod: jwt\nauthJWTJWKS: http://my_identity_server/jwks_endpoint\nauthJWTClaimKey: mediamtx_permissions\n```\n\nUsers are expected to pass the encoded JWT as token.\n\nThe JWT is expected to contain a claim, with a list of permissions in the same format as the one of user permissions:\n\n```json\n{\n \"mediamtx_permissions\": [\n {\n \"action\": \"publish\",\n \"path\": \"\"\n }\n ]\n}\n```\n\nIf the JWKS server uses TLS and has a self-signed or invalid TLS certificate, you can provide the fingerprint of the certificate to validate it anyway:\n\n```yml\nauthMethod: jwt\nauthJWTJWKS: https://my_identity_server/jwks_endpoint\nauthJWTJWKSFingerprint: 33949e05fffb5ff3e8aa16f8213a6251b4d9363804ba53233c4da9a46d6f2739\nauthJWTClaimKey: mediamtx_permissions\n```\n\nThe fingerprint can be obtained with:\n\n```sh\nopenssl s_client -connect my_identity_server:443 /dev/null | sed -n '/BEGIN/,/END/p' > server.crt\nopenssl x509 -in server.crt -noout -fingerprint -sha256 | cut -d \"=\" -f2 | tr -d ':'\n```\n\nOptionally, the JWT `iss` (issuer) and `aud` (audience) claims can be validated by setting `authJWTIssuer` and `authJWTAudience`. When set, tokens that don't contain the expected values will be rejected:\n\n```yml\nauthMethod: jwt\nauthJWTJWKS: http://my_identity_server/jwks_endpoint\nauthJWTClaimKey: mediamtx_permissions\nauthJWTIssuer: http://my_identity_server\nauthJWTAudience: mediamtx\n```\n\nLeave these fields empty to skip validation of the respective claims.\n\n#### Keycloak setup\n\nHere's a tutorial on how to setup the [Keycloak identity server](https://www.keycloak.org/) in order to provide JWTs.\n\n1. Start Keycloak:\n\n ```sh\n docker run --name=keycloak -p 8080:8080 \\\n -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin \\\n quay.io/keycloak/keycloak:23.0.7 start-dev\n ```\n\n2. Open the Keycloak web UI on http://localhost:8080, click on _Administration Console_ and log in.\n\n3. Click on _master_ in the top left corner, _Create realm_, set realm name to `mediamtx`, _Create_.\n\n4. Open page _Client scopes_, _Create client scope_, set name to `mediamtx`, _Save_.\n\n5. Open tab _Mappers_, _Configure a new Mapper_, _User Attribute_:\n - Name: `mediamtx_permissions`\n - User Attribute: `mediamtx_permissions`\n - Token Claim Name: `mediamtx_permissions`\n - Claim JSON Type: `JSON`\n - Multivalued: `On`\n\n Save.\n\n6. Open page _Clients_, _Create client_, set Client ID to `mediamtx`, _Next_, _Client authentication_ `On`, _Next_, _Save_.\n\n7. Open tab _Credentials_, copy client secret somewhere.\n\n8. Open tab _Client scopes_, set _Assigned type_ of all existing client scopes to _Optional_. This decreases the length of the JWT, since many clients impose limits on it.\n\n9. In tab _Client scopes_, _Add client scope_, Select `mediamtx`, _Add_, _Default_.\n\n10. Open page _Users_, _Add user_, Username `testuser`, _Create_, Tab _Credentials_, _Set password_, pick a password, _Save_.\n\n11. Open tab _Attributes_, _Add an attribute_:\n - Key: `mediamtx_permissions`\n - Value: `{\"action\":\"publish\", \"path\": \"\"}`\n\n You can add as many attributes with key `mediamtx_permissions` as you want, each with a single permission in it.\n\n12. In MediaMTX, use the following JWKS URL:\n\n ```yml\n authJWTJWKS: http://localhost:8080/realms/mediamtx/protocol/openid-connect/certs\n ```\n\n13. Perform authentication on Keycloak:\n\n ```\n curl \\\n -d \"client_id=mediamtx\" \\\n -d \"client_secret=$CLIENT_SECRET\" \\\n -d \"username=$USER\" \\\n -d \"password=$PASS\" \\\n -d \"grant_type=password\" \\\n http://localhost:8080/realms/mediamtx/protocol/openid-connect/token\n ```\n\n The JWT is inside the `access_token` key of the response:\n\n ```json\n {\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyNzVjX3ptOVlOdHQ0TkhwWVk4Und6ZndUclVGSzRBRmQwY3lsM2wtY3pzIn0.eyJleHAiOjE3MDk1NTUwOTIsImlhdCI6MTcwOTU1NDc5MiwianRpIjoiMzE3ZTQ1NGUtNzczMi00OTM1LWExNzAtOTNhYzQ2ODhhYWIxIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL3JlYWxtcy9tZWRpYW10eCIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiI2NTBhZDA5Zi03MDgxLTQyNGItODI4Ni0xM2I3YTA3ZDI0MWEiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJtZWRpYW10eCIsInNlc3Npb25fc3RhdGUiOiJjYzJkNDhjYy1kMmU5LTQ0YjAtODkzZS0wYTdhNjJiZDI1YmQiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIi8qIl0sInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJvZmZsaW5lX2FjY2VzcyIsInVtYV9hdXRob3JpemF0aW9uIiwiZGVmYXVsdC1yb2xlcy1tZWRpYW10eCJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoibWVkaWFtdHggcHJvZmlsZSBlbWFpbCIsInNpZCI6ImNjMmQ0OGNjLWQyZTktNDRiMC04OTNlLTBhN2E2MmJkMjViZCIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwibWVkaWFtdHhfcGVybWlzc2lvbnMiOlt7ImFjdGlvbiI6InB1Ymxpc2giLCJwYXRocyI6ImFsbCJ9XSwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdHVzZXIifQ.Gevz7rf1qHqFg7cqtSfSP31v_NS0VH7MYfwAdra1t6Yt5rTr9vJzqUeGfjYLQWR3fr4XC58DrPOhNnILCpo7jWRdimCnbPmuuCJ0AYM-Aoi3PAsWZNxgmtopq24_JokbFArY9Y1wSGFvF8puU64lt1jyOOyxf2M4cBHCs_EarCKOwuQmEZxSf8Z-QV9nlfkoTUszDCQTiKyeIkLRHL2Iy7Fw7_T3UI7sxJjVIt0c6HCNJhBBazGsYzmcSQ_GrmhbUteMTg00o6FicqkMBe99uZFnx9wIBm_QbO9hbAkkzF923I-DTAQrFLxT08ESMepDwmzFrmnwWYBLE3u8zuUlCA\",\n \"expires_in\": 300,\n \"refresh_expires_in\": 1800,\n \"refresh_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI3OTI3Zjg4Zi05YWM4LTRlNmEtYWE1OC1kZmY0MDQzZDRhNGUifQ.eyJleHAiOjE3MDk1NTY1OTIsImlhdCI6MTcwOTU1NDc5MiwianRpIjoiMGVhZWFhMWItYzNhMC00M2YxLWJkZjAtZjI2NTRiODlkOTE3IiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL3JlYWxtcy9tZWRpYW10eCIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9yZWFsbXMvbWVkaWFtdHgiLCJzdWIiOiI2NTBhZDA5Zi03MDgxLTQyNGItODI4Ni0xM2I3YTA3ZDI0MWEiLCJ0eXAiOiJSZWZyZXNoIiwiYXpwIjoibWVkaWFtdHgiLCJzZXNzaW9uX3N0YXRlIjoiY2MyZDQ4Y2MtZDJlOS00NGIwLTg5M2UtMGE3YTYyYmQyNWJkIiwic2NvcGUiOiJtZWRpYW10eCBwcm9maWxlIGVtYWlsIiwic2lkIjoiY2MyZDQ4Y2MtZDJlOS00NGIwLTg5M2UtMGE3YTYyYmQyNWJkIn0.yuXV8_JU0TQLuosNdp5xlYMjn7eO5Xq-PusdHzE7bsQ\",\n \"token_type\": \"Bearer\",\n \"not-before-policy\": 0,\n \"session_state\": \"cc2d48cc-d2e9-44b0-893e-0a7a62bd25bd\",\n \"scope\": \"mediamtx profile email\"\n }\n ```\n\n## Providing username and password\n\n### RTSP\n\nPrepend username and password and a `@` to the host:\n\n```\nrtsp rtsp://myuser:mypass@localhost:8554/mystream\n```\n\n### RTMP\n\nUse the `user` and `pass` query parameters:\n\n```\nrtmp://localhost/mystream?user=myuser&pass=mypass\n```\n\n### SRT\n\nAppend username and password to `streamid`:\n\n```\nsrt://localhost:8890?streamid=publish:mystream:user:pass&pkt_size=1316\n```\n\n### HLS and WebRTC\n\nUsername and password can be passed through the `Authorization: Basic` HTTP header:\n\n```\nAuthorization: Basic base64(user:pass)\n```\n\nWhen using a web browser, a dialog is first shown to users, asking for credentials, and then the header is automatically inserted into every request. If you need to automatically fill credentials from a parent web page, read [Embed streams in a website](14-embed-streams-in-a-website.md).\n\nIf the `Authorization: Basic` header cannot be used (for instance, in software like OBS Studio, which only allows to provide a \"Bearer Token\"), credentials can be passed through the `Authorization: Bearer` header (i.e. the \"Bearer Token\" in OBS), where the value is the concatenation of username and password, separated by a colon:\n\n```\nAuthorization: Bearer username:password\n```\n\n## Providing tokens / JWTs\n\n### RTSP\n\nPass the token as a query parameter:\n\n```\nrtsp://localhost:8554/mystream?jwt=jwt\n```\n\nWARNING: FFmpeg implementation of RTSP does not support URLs that are longer than 4096 characters (this is the [MAX_URL_SIZE constant](https://github.com/FFmpeg/FFmpeg/blob/f951aa9ef382d6bb517e05d04d52710f751de427/libavformat/internal.h#L30)), therefore you have to configure your identity server in order to produce JWTs that are shorter than this threshold.\n\n### RTMP\n\nPass the token as a query parameter:\n\n```\nrtmp://localhost/mystream?jwt=jwt\n```\n\nWARNING: FFmpeg implementation of RTMP does not support URLs that are longer than 1024 characters (this is the [TCURL_MAX_LENGTH constant](https://github.com/FFmpeg/FFmpeg/blob/f951aa9ef382d6bb517e05d04d52710f751de427/libavformat/rtmpproto.c#L55)), therefore you have to configure your identity server in order to produce JWTs that are shorter than this threshold.\n\n### SRT\n\nPass the token as password, with an arbitrary user:\n\n```\nsrt://localhost:8890?streamid=publish:mystream:user:jwt&pkt_size=1316\n```\n\nWARNING: SRT does not support Stream IDs that are longer than 512 characters, therefore you have to configure your identity server in order to produce JWTs that are shorter than this threshold.\n\n### HLS and WebRTC\n\nThe token can be passed through the `Authorization: Bearer` header:\n\n```\nAuthorization: Bearer MY_JWT\n```\n\nIn OBS Studio, this is the \"Bearer Token\" field.\n\nIf the `Authorization: Bearer` token cannot be directly provided (for instance, with web browsers that directly access _MediaMTX_ and show a credential dialog), you can pass the token as password, using an arbitrary user.\n\nIn web browsers, if you need to automatically fill credentials from a parent web page, read [Embed streams in a website](14-embed-streams-in-a-website.md).\n" }, { "path": "docs/4-other/04-remuxing-reencoding-compression.md", "content": "# Re-encoding\n\nTo change the format, codec or compression of a stream, use _FFmpeg_ or _GStreamer_ together with _MediaMTX_. For instance, to re-encode an existing stream, that is available in the `/original` path, and publish the resulting stream in the `/compressed` path, edit `mediamtx.yml` and replace everything inside section `paths` with the following content:\n\n```yml\npaths:\n compressed:\n original:\n runOnReady: >\n ffmpeg -i rtsp://localhost:$RTSP_PORT/$MTX_PATH\n -c:v libx264 -pix_fmt yuv420p -preset ultrafast -b:v 600k\n -max_muxing_queue_size 1024 -f rtsp rtsp://localhost:$RTSP_PORT/compressed\n runOnReadyRestart: yes\n```\n" }, { "path": "docs/4-other/05-always-available.md", "content": "# Always-available\n\nWhen the publisher or source of a stream is offline, the server can be configured to fill gaps in the stream with an offline segment that is played on repeat until a publisher comes back online. This allows readers to stay connected regardless of the state of the stream. The offline segment and online stream are concatenated without re-encoding any frame, using the original codec.\n\nThis feature can be enabled by toggling the `alwaysAvailable` flag and filling `alwaysAvailableTracks`:\n\n```yml\npaths:\n mypath:\n alwaysAvailable: true\n alwaysAvailableTracks:\n # Available values are: AV1, VP9, H265, H264, Opus, MPEG4Audio, G711, LPCM\n - codec: H264\n # in case of MPEG4Audio, G711, LPCM, sampleRate and ChannelCount must be provided too.\n # sampleRate: 48000\n # channelCount: 2\n # in case of G711, muLaw must be provided too.\n # muLaw: false\n```\n\nBy default, the server uses a default offline segment with the text \"STREAM IS OFFLINE\". The segment can be replaced with an external MP4 file:\n\n```yml\npaths:\n mypath:\n alwaysAvailable: true\n alwaysAvailableFile: \"./h264.mp4\"\n```\n" }, { "path": "docs/4-other/06-record.md", "content": "# Record\n\nLive streams be recorded to disk and played back with the following file containers and codecs:\n\n| container | codecs |\n| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| fMP4 | **Video**: AV1, VP9, H265, H264, MPEG-4 Video (H263, Xvid), MPEG-1/2 Video, M-JPEG
**Audio**: Opus, MPEG-4 Audio (AAC), MPEG-1/2 Audio (MP3), AC-3, G711 (PCMA, PCMU), LPCM |\n| MPEG-TS | **Video**: H265, H264, MPEG-4 Video (H263, Xvid), MPEG-1/2 Video
**Audio**: Opus, MPEG-4 Audio (AAC), MPEG-1/2 Audio (MP3), AC-3 |\n\n## Usage\n\nTo record available streams to disk, set the `record` parameter in the configuration file:\n\n```yml\npathDefaults:\n # Record streams to disk.\n record: yes\n```\n\nIt's also possible to specify additional parameters:\n\n```yml\npathDefaults:\n # Record streams to disk.\n record: yes\n # Path of recording segments.\n # Extension is added automatically.\n # Available variables are %path (path name), %Y %m %d (year, month, day),\n # %H %M %S (hours, minutes, seconds), %f (microseconds), %z (time zone), %s (unix epoch).\n recordPath: ./recordings/%path/%Y-%m-%d_%H-%M-%S-%f\n # Format of recorded segments.\n # Available formats are \"fmp4\" (fragmented MP4) and \"mpegts\" (MPEG-TS).\n recordFormat: fmp4\n # fMP4 segments are concatenation of small MP4 files (parts), each with this duration.\n # MPEG-TS segments are concatenation of 188-bytes packets, flushed to disk with this period.\n # When a system failure occurs, the last part gets lost.\n # Therefore, the part duration is equal to the RPO (recovery point objective).\n recordPartDuration: 1s\n # This prevents RAM exhaustion.\n recordMaxPartSize: 50M\n # Minimum duration of each segment.\n recordSegmentDuration: 1h\n # Delete segments after this timespan.\n # Set to 0s to disable automatic deletion.\n recordDeleteAfter: 1d\n```\n\nAll available recording parameters are listed in the [configuration file](../5-references/1-configuration-file.md).\n\n## Remote upload\n\nTo upload recordings to a remote location, you can use _MediaMTX_ together with [rclone](https://github.com/rclone/rclone), a command line tool that provides file synchronization capabilities with a huge variety of services (including S3, FTP, SMB, Google Drive):\n\n1. Download and install [rclone](https://github.com/rclone/rclone).\n\n2. Configure _rclone_:\n\n ```sh\n rclone config\n ```\n\n3. Place `rclone` into the `runOnInit` and `runOnRecordSegmentComplete` hooks:\n\n ```yml\n pathDefaults:\n # this is needed to sync segments after a crash.\n # replace myconfig with the name of the rclone config.\n runOnInit: rclone sync -v ./recordings myconfig:/my-path/recordings\n\n # this is called when a segment has been finalized.\n # replace myconfig with the name of the rclone config.\n runOnRecordSegmentComplete: rclone sync -v --min-age=1ms ./recordings myconfig:/my-path/recordings\n ```\n\n If you want to delete local segments after they are uploaded, replace `rclone sync` with `rclone move`.\n" }, { "path": "docs/4-other/07-playback.md", "content": "# Playback\n\nExisting recordings can be played back to users through a dedicated HTTP server, that can be enabled inside the configuration:\n\n```yml\nplayback: yes\nplaybackAddress: :9996\n```\n\nThe server provides an endpoint to list recorded timespans:\n\n```\nhttp://localhost:9996/list?path=[mypath]&start=[start]&end=[end]\n```\n\nWhere:\n\n- [mypath] is the name of a path\n- [start] (optional) is the start date in [RFC3339 format](https://www.utctime.net/)\n- [end] (optional) is the end date in [RFC3339 format](https://www.utctime.net/)\n\nThe server will return a list of timespans in JSON format:\n\n```json\n[\n {\n \"start\": \"2006-01-02T15:04:05Z07:00\",\n \"duration\": 60.0,\n \"url\": \"http://localhost:9996/get?path=[mypath]&start=2006-01-02T15%3A04%3A05Z07%3A00&duration=60.0\"\n },\n {\n \"start\": \"2006-01-02T15:07:05Z07:00\",\n \"duration\": 32.33,\n \"url\": \"http://localhost:9996/get?path=[mypath]&start=2006-01-02T15%3A07%3A05Z07%3A00&duration=32.33\"\n }\n]\n```\n\nThe server provides an endpoint to download recordings:\n\n```\nhttp://localhost:9996/get?path=[mypath]&start=[start]&duration=[duration]&format=[format]\n```\n\nWhere:\n\n- [mypath] is the path name\n- [start] is the start date in [RFC3339 format](https://www.utctime.net/)\n- [duration] is the maximum duration of the recording in seconds\n- [format] (optional) is the output format of the stream. Available values are \"fmp4\" (default) and \"mp4\"\n\nAll parameters must be [url-encoded](https://www.urlencoder.org/). For instance:\n\n```\nhttp://localhost:9996/get?path=mypath&start=2024-01-14T16%3A33%3A17%2B00%3A00&duration=200.5\n```\n\nThe resulting stream uses the fMP4 format, that is natively compatible with any browser, therefore its URL can be directly inserted into a \\