Community-maintained integration. This service is built and maintained by bitHuman. Pipecat does not test or officially support it. Please report issues and request changes on the source repository. Learn more about community integrations.
Overview
BitHumanVideoService takes your bot’s TTS audio and turns it into a talking avatar.
It pushes OutputImageRawFrame (RGB) and the matching TTSAudioRawFrame, so the mouth
and the voice leave together. The avatar renders in your own process through the
bithuman Python SDK. Expression 2 animates any character from one portrait;
Essence 2 renders a photoreal person from one portrait.
Interruptions are handled: on InterruptionFrame the avatar drops the reply in flight
and goes back to idle.
Installation
Prerequisites
bitHuman account setup
- Create an account at www.bithuman.ai and create an API secret.
- Download an avatar model (
.imx). See docs.bithuman.ai.
Required environment variables
BITHUMAN_API_SECRET: your bitHuman API secret.BITHUMAN_MODEL_PATH: path to the.imxmodel (or passmodel_path).
Configuration
Constructor parameters forBitHumanVideoService:
The service has no runtime-updatable Settings yet.
Session time is metered while the avatar is open (talking or idle). It closes on
EndFrame, CancelFrame or cleanup.
Usage
video_out_enabled=True on the transport. The service logs the frame size on the
first frame; set video_out_width and video_out_height to match.
A complete example is in the
repository.