Document playbackUrlSchemes/playbackUrlHosts in the plugin API docs - #216
Open
kineticman wants to merge 1 commit into
Open
Document playbackUrlSchemes/playbackUrlHosts in the plugin API docs#216kineticman wants to merge 1 commit into
kineticman wants to merge 1 commit into
Conversation
These fields were added to StreamVaultPluginManifest and are required for StreamVault to ever invoke MSG_PREPARE_PLAYBACK or MSG_REWRITE_CAST_URL on a plugin, but were never documented. A plugin advertising playback.prepare or cast.rewriteUrl without declaring these fields silently never receives those messages, since absent routing metadata is treated as owning no URLs rather than a wildcard.
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
1 participant
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.
Problem
StreamVaultPluginManifest.playbackUrlSchemes/playbackUrlHosts(added in082a94bf) control whetherMSG_PREPARE_PLAYBACK/MSG_REWRITE_CAST_URLare ever sent to a plugin —playbackCandidates()/ownsPlaybackUrl()inPluginPlaybackRouting.kttreat an absent/empty list as owning no URLs, not a wildcard.docs/PLUGIN_API.mdnever mentions either field, so a plugin author following the published docs has no way to know this is required, and theirplayback.prepare/cast.rewriteUrlcapability will silently never fire even though it's advertised and otherwise correctly implemented.Ran into this concretely with a third-party plugin (StreamVault Adaptive Bridge) that advertises
playback.prepare, correctly implementsMSG_PREPARE_PLAYBACK, and proxies channels through its own localhttp://127.0.0.1:<port>/play/{id}server — but never declaredplaybackUrlSchemes/playbackUrlHosts, so playback always fell through to StreamVault's generic extractors instead. Filed the corresponding fix against that plugin: jopsis/StreamVault-IPTV-Plugin-Adaptive-Bridge#4.Change
playbackUrlSchemes/playbackUrlHoststo the example manifest JSON."*"as an explicit opt-in), that it's a separate/earlier filter than the per-callhandledfield, and that it's only readable frommanifest_json(no individual fallbackmeta-datakey exists for it).handled=falseparagraph to note that manifest-level routing narrows the candidate set first.Docs-only change, no app code touched.