Let a host start and observe a clip generation - #173
Merged
Conversation
|
🎉 This PR is included in version 2.19.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Generation could only be started from the SDK's own toolbar, and only its own overlay could see
the result. An application embedding Studio with custom UI, a batch action or a test harness
could do neither. Clip capture — the same shape of per-clip async operation — was already public
on both counts.
generateClip(clipId)starts a generation for a prompt-bearing clip. The threeclip:generation*events move onto the public event map beside the capture events, so a host cansubscribe through
edit.events.No behaviour changes. The event strings are unchanged, the method body is untouched, and the
transient generation state stays out of the edit document as before.
One thing the docstring now states that a host needs: removing the clip, reloading the edit or
disposing it leaves the generation with no completed or failed event after its started. Anything
tracking progress from events alone has to handle that.
Verify:
npm run verify:ci— lint, typecheck, coverage (2053 tests), build, package contract.tests/generation-public-api.test.tsdrives the SDK only through public API and fails all threecases if
generateClipis stubbed out.