Skip to content

Commit 4fbaab4

Browse files
author
Amin
committed
update doc
1 parent f6e89b9 commit 4fbaab4

File tree

2 files changed

+24
-10
lines changed

2 files changed

+24
-10
lines changed

README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,24 @@
33
[![PHP Version](https://img.shields.io/badge/php-%3E%3D8.4-blue.svg)](https://php.net/)
44
[![License](https://img.shields.io/badge/license-BSD-blue.svg)](LICENSE)
55

6-
A PHP library for parsing and generating RTP (Session Description Protocol). This package supports media negotiation, ICE parameters, RTP fingerprints, and codec configurations used in WebRTC.
6+
A PHP library for handling RTP (Real-time Transport Protocol) packets. This package provides tools for encoding, decoding, parsing, and analyzing RTP streams—useful for WebRTC, VoIP, and media streaming applications.
77

8-
## Features
8+
## Features
99

10-
- Parse and build RTP offers and answers
11-
- Support for ICE, RTP, RTP, SCTP, and media attributes
12-
- Codec negotiation helpers
10+
- Encode and decode RTP packets
11+
- Extract RTP header fields
12+
- Support for common RTP payload types
1313

1414

1515
## Requirements
1616

17-
- PHP ≥ 8.4
17+
- **PHP ≥ 8.4** with FFI extension enabled
18+
- Linux (Windows and macOS support planned for future releases)
19+
- FFmpeg/libav shared libraries (libavcodec, libavfilter, etc.)
20+
- Compatible with FFmpeg **version 7.1.1**
21+
- libopus development libraries
22+
- libvpx development libraries
23+
- Compatible with libvpx **version 1.15.0**
1824

1925
## Documentation
2026

@@ -43,5 +49,12 @@ BSD 3-Clause License. See [LICENSE](LICENSE) for details.
4349

4450
## References
4551

46-
- [RFC 4566 – RTP: Session Description Protocol](https://datatracker.ietf.org/doc/html/rfc4566)
47-
- [RFC 8829 – WebRTC RTP Usage](https://datatracker.ietf.org/doc/html/rfc8829)
52+
- [RFC 3550 - RTP: A Transport Protocol for Real-Time Applications](https://tools.ietf.org/html/rfc3550)
53+
54+
- [RFC 3551 – RTP Profile for Audio and Video Conferences with Minimal Control](https://datatracker.ietf.org/doc/html/rfc3551)
55+
56+
- [RFC 4585 – Extended RTP Profile for RTCP-Based Feedback (RTP/AVPF)](https://datatracker.ietf.org/doc/html/rfc4585)
57+
58+
- [RFC 8285 – RTP Header Extension for Mid and RID (used in WebRTC)](https://datatracker.ietf.org/doc/html/rfc8285)
59+
60+
- [RFC 5761 – Multiplexing RTP and RTCP on a Single Port](https://datatracker.ietf.org/doc/html/rfc5761)

composer.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
{
22
"name": "quasarstream/rtp",
33
"type": "library",
4-
"description": "A PHP library for parsing and generating RTP (Session Description Protocol).",
4+
"description": "A PHP library for handling RTP (Real-time Transport Protocol) packets.",
55
"keywords": [
6+
"webrtc",
67
"rtp",
7-
"rtp"
8+
"real-time-transport-protocol"
89
],
910
"homepage": "https://www.quasarstream.com/webrtc",
1011
"license": "BSD-3-Clause",

0 commit comments

Comments
 (0)