Docs/Migration: 1.x → 2.x breaking API changes are not documented (package rename, ConnectChecker rename)
Maintainers usually reply within 2 days
@pedroSG94 is already working on this.
Since Jul 30, 2026.
Assessment
This issue has not been assessed yet.
Description
Summary
RootEncoder 2.x introduced significant breaking changes to the public API compared to 1.x. These changes are not reflected in the README or a migration guide, which makes upgrading unnecessarily painful. This issue documents what changed and requests a migration guide.
Affected versions
Migrating from library:1.x → library:2.4.7
Breaking changes discovered
1. Package rename for streaming classes
| 1.x | 2.x |
|---|---|
com.pedro.rtplibrary.rtmp.RtmpCamera1 |
com.pedro.library.rtmp.RtmpCamera1 |
com.pedro.rtplibrary.rtsp.RtspCamera1 |
com.pedro.library.rtsp.RtspCamera1 |
2. ConnectCheckerRtmp replaced by ConnectChecker
| 1.x | 2.x |
|---|---|
com.pedro.rtmp.utils.ConnectCheckerRtmp |
com.pedro.common.ConnectChecker |
3. Callback method renames (removed protocol-specific suffixes)
| 1.x callback | 2.x callback |
|---|---|
onConnectionSuccessRtmp() |
onConnectionSuccess() |
onConnectionFailedRtmp(reason) |
onConnectionFailed(reason) |
onNewBitrateRtmp(bitrate) |
onNewBitrate(bitrate) (from BitrateChecker) |
onDisconnectRtmp() |
onDisconnect() |
onAuthErrorRtmp() |
onAuthError() |
onAuthSuccessRtmp() |
onAuthSuccess() |
| (not present) | onConnectionStarted(url) |
4. prepareVideo signature change
// 1.x
boolean prepareVideo(int width, int height, int fps, int bitrate, CameraHelper.Facing facing)
// 2.x
boolean prepareVideo(int width, int height, int fps, int bitrate, int rotation)
5. GlInterface.setCustomImageToStream() / clearCustomImageToStream() removed
In 2.x the static-image injection API was removed. The replacement is to use BaseFilterRender via glInterface.setFilter(...), but there is no documented equivalent for injecting a static bitmap frame.
Request
Please add a MIGRATION.md or a "Migrating from 1.x to 2.x" section in the README. Even a brief table of renames would save users hours of debugging.
Thank you for the great library!
- Dominant language
- Kotlin
- Stars
- 3k
- Forks
- 946
- Avg merge
- 4d 6h
- Merged PRs (30d)
- 9
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from pedroSG94/RootEncoder
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
pedroSG94/RootEncoder#2213 ·
Maintainers usually reply within 2 days
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
pedroSG94/RootEncoder#2207 · 1 reaction ·
Maintainers usually reply within 2 days
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
pedroSG94/RootEncoder#2203 ·
Maintainers usually reply within 2 days
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
pedroSG94/RootEncoder#2192 · 2 comments ·
Maintainers usually reply within 2 days
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
pedroSG94/RootEncoder#2177 · 44 comments ·
Maintainers usually reply within 2 days
All issues in pedroSG94/RootEncoder
Similar issues
-
afk-ok area:data-quality importer size:S
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
enorm-labs/event-junkie#3301 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
rustyrazorblade/easy-db-lab#1017 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
callstack/react-native-brownfield#492 · 1 comment ·
Maintainers usually reply within 4 days