Skip to content

Docs recipe: pause the avatar for video/interactive content, then resume #40

Description

@zoharbabin

Why

A common integration pattern — pause the talking avatar while showing a video or other interactive content, then resume once it finishes — is fully supported by existing SDK primitives, but there's no documented recipe showing how to wire it end to end. Integrators currently have to reverse-engineer the right combination of client commands from the reference docs alone.

What

A documented, runnable recipe: pause the avatar, show a video/interactive element, detect completion, and resume the avatar/conversation cleanly, using only existing public SDK primitives (docs/CLIENT-COMMANDS.md, ./experience).

How

  • Write the recipe as a short guide with a minimal runnable example (plain HTML/JS, consistent with the SDK's existing "no build step" philosophy).
  • Cover both directions explicitly: pausing before content starts, and resuming reliably even if the content is skipped or fails to load (don't leave the avatar stuck paused).
  • Cross-link from docs/CLIENT-COMMANDS.md and GETTING-STARTED.md.

Success criteria

  • The recipe runs as-is against a live session and produces the pause → show → resume flow with no custom glue code beyond what's shown.
  • Both the happy path and the "content never completes" edge case are covered.
  • Linked from at least two existing docs pages so it's discoverable from where an integrator would naturally look.

Where it lives

Docs only — no new SDK export. Uses existing ./experience client commands.

Priority / Labels

Medium. Pure documentation gap; the capability already exists and works, it's just not written down anywhere.


Part of #46.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationpriority:mediumValuable but not urgentroadmapTracked as part of the SDK capability roadmap

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions