Skip to content

Return the RTMP publishing address from registerRtmpInput - #299

Merged
Gawor270 merged 2 commits into
mainfrom
fce-3761
Sep 14, 2026
Merged

Gawor270 merged 2 commits into
mainfrom
fce-3761

Conversation

@Gawor270

Copy link
Copy Markdown
Member

Description

The composition API now reports a complete RTMP publish URL where it previously reported only a port.

  • Regenerated the composition client: RegisterInputResponse.port is replaced by publishUrl
  • registerRtmpInput returns the publish URL instead of void, throwing when the server omits it
  • Covered the new return value and the missing-URL case in tests

Motivation and Context

The publish address can no longer be derived from the composition origin and a port, so the server supplies the whole URL.

Documentation impact

  • Documentation update required

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

The register-input response now reports publish_url in place of port.
The server now reports a complete publish URL, so the caller no longer has
to build one from the composition origin and a port.
@linear

linear Bot commented Sep 10, 2026

Copy link
Copy Markdown

FCE-3761

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The PR description flags a required documentation update for this breaking change, but no documentation changes are included.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Updates the Composition client to reflect a server-side change where RTMP inputs now return a full publish URL (instead of a derivable port), and exposes that URL via registerRtmpInput.

Changes:

  • Regenerates the Composition OpenAPI client model to replace RegisterInputResponse.port with publishUrl.
  • Changes CompositionClient.registerRtmpInput to return the RTMP publish URL and throw if the server omits it.
  • Updates/extends Composition client tests to cover the new response shape and the missing-URL error case.
File summaries
File Description
packages/js-server-sdk/tests/composition.test.ts Updates serialization expectations and adds tests for registerRtmpInput returning/throwing based on publish_url.
packages/js-server-sdk/src/composition.ts Makes registerRtmpInput return publishUrl and throw UnknownException when absent.
packages/composition-openapi/src/generated/models/RegisterInputResponse.ts Regenerated OpenAPI model mapping publish_url ⇄ publishUrl (replacing port).
Review details
  • Files reviewed: 2/3 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread packages/js-server-sdk/src/composition.ts
@Gawor270 Gawor270 self-assigned this Sep 10, 2026
@Gawor270
Gawor270 merged commit c1ad0b3 into main Sep 14, 2026
3 checks passed
@Gawor270
Gawor270 deleted the fce-3761 branch September 14, 2026 08:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants