Fix profile README: librtmp2-server now integrates the librtmp2 crate#2
Merged
Merged
Conversation
The RTMP/E-RTMP listener was previously documented as pending, but librtmp2-server's src/server.rs already wires in librtmp2::server::Server and Cargo.toml depends on the librtmp2 crate directly. Update the architecture diagram, feature list, roadmap, and use-case table to reflect the completed integration instead of describing it as in-progress.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughDocumentation-only update to profile/README.md reflecting that librtmp2 is now integrated into librtmp2-server for RTMP/RTMPS listening. Text in dependency notes, architecture description/diagram, quick start, use cases, and roadmap checkboxes were revised from "pending"/"not yet" to completed status. ChangesREADME librtmp2 Integration Status Update
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Pull request overview
Updates the organization profile README to reflect that librtmp2-server now integrates the librtmp2 crate (rather than describing it as blocked/in-progress), and adjusts the architecture description/diagram and roadmap accordingly.
Changes:
- Updates multiple references from “pending integration” to “integration complete” for
librtmp2-server↔librtmp2. - Refreshes the architecture note/diagram and use-case guidance to match the new state.
- Marks the relevant roadmap items as completed.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **[.github](https://github.com/OpenRTMP/.github)** — Organization documentation and CI/CD | ||
|
|
||
| > **Note:** `librtmp2` and `librtmp2-server` are both Rust today, but they are separate codebases — `librtmp2-server` does not yet depend on the `librtmp2` crate for its RTMP listener. See [Architecture](#architecture) below. | ||
| > **Note:** `librtmp2` and `librtmp2-server` are both Rust today, and separate codebases — `librtmp2-server` depends on the `librtmp2` crate to drive its RTMP/RTMPS listener. See [Architecture](#architecture) below. |
| ## Architecture | ||
|
|
||
| `librtmp2` and `librtmp2-server` are both Rust, but independent codebases today — the server does not yet depend on the `librtmp2` crate for its RTMP listener. | ||
| `librtmp2` and `librtmp2-server` are both Rust, independent codebases — `librtmp2-server` depends on the `librtmp2` crate to drive its RTMP/RTMPS listener. |
| ``` | ||
|
|
||
| See [librtmp2-server README](https://github.com/OpenRTMP/librtmp2-server#build) for configuration and deployment. Note: RTMP ingest is not yet live — see the Architecture section above. | ||
| See [librtmp2-server README](https://github.com/OpenRTMP/librtmp2-server#build) for configuration and deployment. RTMP/RTMPS ingest runs via the embedded `librtmp2` crate — see the Architecture section above. |
| |----------|----------| | ||
| | **OBS/FFmpeg Plugin** | Use `librtmp2` (Rust, FFI-compatible) to add RTMP ingest support from any language | | ||
| | **Private RTMP Relay** | Build on `librtmp2`; `librtmp2-server` is not yet protocol-capable | | ||
| | **Private RTMP Relay** | Build on `librtmp2` directly, or run `librtmp2-server`, which embeds it | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
librtmp2-serveras not yet wired up ("blocked on librtmp2 crate integration"). That's stale:librtmp2-server'sCargo.tomldepends directly on thelibrtmp2crate, andsrc/server.rsalready useslibrtmp2::server::Server/librtmp2::types::ServerConfigto drive its listener.Test plan
librtmp2-server'sCargo.toml(librtmp2 = { git = ... }dependency) andsrc/server.rs(imports and useslibrtmp2::server::Server)Generated by Claude Code
Summary by CodeRabbit
librtmp2crate.