feat(examples): add LemonSlice avatar with switchable personas#5834
Merged
Conversation
A new example that talks to a LemonSlice video avatar with a roster of
16 personas (California-girl influencer, Pixar fox, anime cat girl, etc).
The playground dropdown fires `set_avatar` RPC; the agent swaps voice +
system prompt live and rotates the avatar mid-conversation, with a
short Bluetooth-pairing-style hold-tone playing during the swap.
Framework changes the example relies on:
* `BaseAvatarSession.aclose()` now kicks the avatar participant via
`JobContext.api.room.remove_participant`. Per-provider implementations
no longer need to roll their own RoomService cleanup.
* `BaseAvatarSession.wait_for_join(timeout=30.0)` exposes the existing
`_wait_avatar_join` task so callers can synchronise on the avatar
being fully joined + its video track published.
* `utils.wait_for_participant` and `wait_for_track_publication` gained
optional `timeout` kwargs (mirrors asyncio.wait_for semantics).
* `lemonslice.AvatarSession.start()` rebinds `agent_session.output.audio`
BEFORE the slow upstream HTTP call, so audio buffers for the new
avatar identity instead of getting lost while the session is
spinning up.
Deployment:
* `playground.yaml` carries the avatar entry's pixel icon, accent,
persona dropdown, and the live `agent_id`.
* `deploy-examples.yml` matrix adds `avatar`.
* Secrets (`LEMONSLICE_API_KEY`) are set out-of-band once via
`lk agent update-secrets`, as discussed.
…only Drops out-of-scope hops that were bundled into the original avatar PR: - framework changes (BaseAvatarSession.aclose remove_participant + wait_for_join, wait_for_participant timeout) → moved to a separate PR - lemonslice plugin output-bind reorder → moved to a separate PR - playground.yaml hotel-receptionist entry + reformatting + workflow matrix entry (avatar is deployed manually for now)
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
|
|
||
| state = State(persona=initial, avatar=make_avatar(initial)) | ||
| await state.avatar.start(session, room=ctx.room) | ||
| await state.avatar.wait_for_join() |
Contributor
There was a problem hiding this comment.
🔴 Calling non-existent method wait_for_join() on AvatarSession causes AttributeError at runtime
The agent calls state.avatar.wait_for_join() at lines 69 and 107, but this method does not exist on lemonslice.AvatarSession or its base class AvatarSession (livekit-agents/livekit/agents/voice/avatar/_types.py:66). The base class has a private _wait_avatar_join() coroutine and a _wait_avatar_join_task attribute, but no public wait_for_join() method. This will raise AttributeError on every agent startup and every persona switch, making the example completely non-functional.
Comparison with existing lemonslice example
The existing lemonslice avatar example at examples/avatar_agents/lemonslice/agent_worker.py:47 simply calls await avatar.start(session, room=ctx.room) without any wait_for_join() call — start() already internally creates the _wait_avatar_join_task that waits for the avatar participant to join and publish a video track.
Prompt for agents
The method `wait_for_join()` does not exist on `lemonslice.AvatarSession` or its base class `AvatarSession` (defined in `livekit-agents/livekit/agents/voice/avatar/_types.py`). It is called on lines 69 and 107 of `examples/avatar/agent.py`. The base class has a private `_wait_avatar_join_task` (an asyncio.Task) that is created during `start()` — it waits for the avatar participant to join the room and publish a video track. If the intent is to await that internal task, one option is to await `state.avatar._wait_avatar_join_task` directly (though accessing private attributes is fragile). A better approach would be to either (a) add a public `wait_for_join()` method to the base `AvatarSession` class in `_types.py` that awaits `_wait_avatar_join_task`, or (b) remove the `wait_for_join()` calls entirely as the existing lemonslice example (`examples/avatar_agents/lemonslice/agent_worker.py`) does not use it and works fine without it.
Was this helpful? React with 👍 or 👎 to provide feedback.
3 tasks
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.
No description provided.