Skip to content

Add LiveAvatar Stop Session API Call + README Fix #4195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tinalenguyen merged 2 commits into from
Dec 8, 2025
+23 −1
Merged

Add LiveAvatar Stop Session API Call + README Fix #4195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b02c3d
update readme and add stop session call
tinalenguyen Dec 8, 2025
72f558e
fix
tinalenguyen Dec 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion livekit-plugins/livekit-plugins-liveavatar/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

Support for the [Heygen LiveAvatar](https://www.liveavatar.com/) virtual avatar.

See [https://docs.livekit.io/agents/integrations/avatar/heygen/](https://docs.livekit.io/agents/integrations/avatar/liveavatar/) for more information.
See [https://docs.livekit.io/agents/integrations/avatar/liveavatar/](https://docs.livekit.io/agents/integrations/avatar/liveavatar/) for more information.

10 changes: 10 additions & 0 deletions livekit-plugins/livekit-plugins-liveavatar/livekit/plugins/liveavatar/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,16 @@ async def start_streaming_session(self, session_id: str, session_token: str) ->
response_data = await self._post(endpoint="/start", payload=payload, headers=headers)
return response_data

async def stop_streaming_session(self, session_id: str, session_token: str) -> dict[str, Any]:
"""Stop the streaming session"""
payload = {
"session_id": session_id,
"reason": "USER_DISCONNECTED",
}
headers = {"content-type": "application/json", "Authorization": f"Bearer {session_token}"}
response_data = await self._post(endpoint="/stop", payload=payload, headers=headers)
return response_data

async def _post(
self, *, endpoint: str, payload: dict[str, Any], headers: dict[str, Any]
) -> dict[str, Any]:
Expand Down
12 changes: 12 additions & 0 deletions livekit-plugins/livekit-plugins-liveavatar/livekit/plugins/liveavatar/avatar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ def __init__(
conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
) -> None:
self._avatar_id = avatar_id or os.getenv("LIVEAVATAR_AVATAR_ID")
self._session_id: str | None = None
self._session_token: str | None = None
self._api = LiveAvatarAPI(api_key=api_key, api_url=api_url, conn_options=conn_options)

self._avatar_participant_identity = avatar_participant_identity or _AVATAR_AGENT_IDENTITY
Expand Down Expand Up @@ -231,5 +233,15 @@ async def _recv_task() -> None:
finally:
await utils.aio.cancel_and_wait(*io_tasks)
await utils.aio.cancel_and_wait(*self._tasks)
try:
if self._session_id and self._session_token:
data = await self._api.stop_streaming_session(
self._session_id, self._session_token
)
if data["code"] <= 200:
logger.info(f"LiveAvatar session stopped: {self._session_id}")
except Exception as e:
logger.warning(f"Failed to stop LiveAvatar session: {e}", exc_info=True)

await self._audio_buffer.aclose()
await ws_conn.close()
Loading