Skip to content

docs: update for pipecat PR #6576 #1686

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
markbackman merged 2 commits into from
Nov 7, 2026
+146 −118
Merged

docs: update for pipecat PR #6576 #1686

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
ab33cf2
Update serializer pages for audio_in/out_sample_rate (pipecat PR #6576)
github-actions[bot] Nov 7, 2026
786d543
chore: format docs and regenerate llms.txt
github-actions[bot] Nov 7, 2026
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
14 changes: 8 additions & 6 deletions api-reference/server/services/serializers/exotel.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,14 @@ Before using ExotelFrameSerializer, you need:

### InputParams

| Parameter | Type | Default | Description |
| ---------------------------- | --------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `exotel_sample_rate` | `int` | `8000` | Sample rate used by Exotel (Hz). |
| `sample_rate` | `int` | `None` | Optional override for pipeline input sample rate. When `None`, uses the pipeline's configured rate. |
| `ignore_rtvi_messages` | `bool` | `True` | Whether to ignore RTVI protocol messages during serialization. |
| `resampler_clear_after_secs` | `float \| None` | `0.2` | Seconds of inactivity after which the stream resampler clears its internal history to avoid audio artefacts. Set to `None` to never clear (recommended for telephony providers with irregular gaps). |
| Parameter | Type | Default | Description |
| ---------------------------- | --------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `audio_in_sample_rate` | `int` | `8000` | Sample rate of the audio Exotel sends (Hz). Incoming audio is converted to the pipeline's input rate. |
| `audio_out_sample_rate` | `int` | `8000` | Sample rate of the audio sent to Exotel (Hz). |
| `exotel_sample_rate` | `int \| None` | `None` | _Deprecated since 1.16.0._ Use `audio_in_sample_rate` and `audio_out_sample_rate` instead. Removed in 2.0.0. |
| `sample_rate` | `int \| None` | `None` | _Deprecated since 1.16.0._ Has no effect: incoming audio is converted to `PipelineParams.audio_in_sample_rate`. Removed in 2.0.0. |
| `ignore_rtvi_messages` | `bool` | `True` | Whether to ignore RTVI protocol messages during serialization. |
| `resampler_clear_after_secs` | `float \| None` | `0.2` | _Deprecated since 1.16.0._ Has no effect. No replacement. Removed in 2.0.0. |

## Usage

Expand Down
28 changes: 15 additions & 13 deletions api-reference/server/services/serializers/genesys.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,19 +63,21 @@ Before using GenesysAudioHookSerializer, you need:

### InputParams

| Parameter | Type | Default | Description |
| ---------------------------- | ---------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `genesys_sample_rate` | `int` | `8000` | Sample rate used by Genesys (Hz). |
| `sample_rate` | `int` | `None` | Optional override for pipeline input sample rate. When `None`, uses the pipeline's configured rate. |
| `channel` | `AudioHookChannel` | `"external"` | Which audio channels to process: `"external"` (customer), `"internal"` (agent), or `"both"` (stereo). |
| `media_format` | `AudioHookMediaFormat` | `"PCMU"` | Audio format: `"PCMU"` (mu-law) or `"L16"` (16-bit linear PCM). |
| `process_external` | `bool` | `True` | Whether to process external (customer) audio. |
| `process_internal` | `bool` | `False` | Whether to process internal (agent) audio. |
| `supported_languages` | `list[str]` | `None` | List of language codes the bot supports (e.g., `["en-US", "es-ES"]`). |
| `selected_language` | `str` | `None` | Default language code to use. |
| `start_paused` | `bool` | `False` | Whether Genesys starts the audio stream paused. Send `create_resume_request()` to start it. |
| `ignore_rtvi_messages` | `bool` | `True` | Whether to ignore RTVI protocol messages during serialization. |
| `resampler_clear_after_secs` | `float \| None` | `0.2` | Seconds of inactivity after which the stream resampler clears its internal history to avoid audio artefacts. Set to `None` to never clear (recommended for telephony providers with irregular gaps). |
| Parameter | Type | Default | Description |
| ---------------------------- | ---------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------- |
| `audio_in_sample_rate` | `int` | `8000` | Sample rate of the audio Genesys sends (Hz). Incoming audio is converted to the pipeline's input rate. |
| `audio_out_sample_rate` | `int` | `8000` | Sample rate of the audio sent to Genesys (Hz). |
| `genesys_sample_rate` | `int \| None` | `None` | _Deprecated since 1.16.0._ Use `audio_in_sample_rate` and `audio_out_sample_rate` instead. Removed in 2.0.0. |
| `sample_rate` | `int \| None` | `None` | _Deprecated since 1.16.0._ Has no effect: incoming audio is converted to `PipelineParams.audio_in_sample_rate`. Removed in 2.0.0. |
| `channel` | `AudioHookChannel` | `"external"` | Which audio channels to process: `"external"` (customer), `"internal"` (agent), or `"both"` (stereo). |
| `media_format` | `AudioHookMediaFormat` | `"PCMU"` | Audio format: `"PCMU"` (mu-law) or `"L16"` (16-bit linear PCM). |
| `process_external` | `bool` | `True` | Whether to process external (customer) audio. |
| `process_internal` | `bool` | `False` | Whether to process internal (agent) audio. |
| `supported_languages` | `list[str]` | `None` | List of language codes the bot supports (e.g., `["en-US", "es-ES"]`). |
| `selected_language` | `str` | `None` | Default language code to use. |
| `start_paused` | `bool` | `False` | Whether Genesys starts the audio stream paused. Send `create_resume_request()` to start it. |
| `ignore_rtvi_messages` | `bool` | `True` | Whether to ignore RTVI protocol messages during serialization. |
| `resampler_clear_after_secs` | `float \| None` | `0.2` | _Deprecated since 1.16.0._ Has no effect. No replacement. Removed in 2.0.0. |

## Usage

Expand Down
23 changes: 12 additions & 11 deletions api-reference/server/services/serializers/jambonz.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The verb needs three settings stated explicitly:

- `bidirectionalAudio.streaming` defaults to `false`. While it is, audio sent back is ignored and the caller hears nothing.
- `sampleRate` defaults to `8000`. Other allowed values are 16000, 24000, 48000 and 64000.
- `bidirectionalAudio.sampleRate` has no default. Set it to the same value as `sampleRate`: the serializer sends audio at the `sampleRate` from the preamble, so a mismatch plays back too fast or too slow.
- `bidirectionalAudio.sampleRate` has no default. Set it to the same value as `sampleRate`, or set the serializer's `audio_out_sample_rate` to it: the serializer sends audio at the `sampleRate` from the preamble unless `audio_out_sample_rate` is set, so a mismatch plays back too fast or too slow.
- `mixType` must be `mono`. Audio is dropped with a warning for `stereo` or `mixed`.
- Set `passDtmf` to receive keypad digits as `InputDTMFFrame`.

Expand All @@ -76,23 +76,24 @@ The verb needs three settings stated explicitly:

| Parameter | Type | Default | Description |
| ---------------------------- | --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `jambonz_sample_rate` | `int \| None` | `None` | Overrides the rate jambonz forks audio at. When `None`, the rate comes from the connection's preamble. |
| `sample_rate` | `int \| None` | `None` | Optional override for the pipeline input sample rate. When `None`, uses the pipeline's configured rate. |
| `audio_in_sample_rate` | `int \| None` | `None` | Overrides the rate jambonz forks audio at. When `None`, the rate comes from the connection's preamble. |
| `audio_out_sample_rate` | `int \| None` | `None` | The rate jambonz reads the audio sent back at, the verb's `bidirectionalAudio.sampleRate`. When `None`, audio is sent at the preamble's rate. |
| `disconnect_on_end` | `bool` | `True` | Sends `disconnect` when the pipeline ends, which ends the `listen` verb so jambonz runs the verb's `actionHook` or hangs up. Needs no API credentials. |
| `ignore_rtvi_messages` | `bool` | `True` | Whether to ignore RTVI protocol messages during serialization. |
| `resampler_clear_after_secs` | `float \| None` | `None` | Seconds of inactivity after which the stream resampler clears its internal history. `None` never clears. |
| `resampler_clear_after_secs` | `float \| None` | `0.2` | _Deprecated since 1.16.0._ Has no effect. No replacement. Removed in 2.0.0. |

### Properties

Populated from the preamble once it arrives.

| Property | Type | Description |
| --------------------- | ---------------- | ------------------------------------------ |
| `jambonz_sample_rate` | `int \| None` | The rate jambonz is forking the call at. |
| `mix_type` | `str \| None` | The channel layout stated in the preamble. |
| `call_sid` | `str \| None` | The jambonz call identifier. |
| `trace_id` | `str \| None` | The jambonz trace identifier. |
| `call_meta` | `dict[str, Any]` | A copy of the full preamble. |
| Property | Type | Description |
| ----------------------- | ---------------- | ------------------------------------------ |
| `audio_in_sample_rate` | `int \| None` | The rate jambonz is forking the call at. |
| `audio_out_sample_rate` | `int \| None` | The rate the serializer sends audio at. |
| `mix_type` | `str \| None` | The channel layout stated in the preamble. |
| `call_sid` | `str \| None` | The jambonz call identifier. |
| `trace_id` | `str \| None` | The jambonz trace identifier. |
| `call_meta` | `dict[str, Any]` | A copy of the full preamble. |

## Usage

Expand Down
16 changes: 9 additions & 7 deletions api-reference/server/services/serializers/plivo.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,13 +100,15 @@ Before using PlivoFrameSerializer, you need:

### InputParams

| Parameter | Type | Default | Description |
| ---------------------------- | --------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `plivo_sample_rate` | `int` | `8000` | Sample rate used by Plivo (Hz). |
| `sample_rate` | `int` | `None` | Optional override for pipeline input sample rate. When `None`, uses the pipeline's configured rate. |
| `auto_hang_up` | `bool` | `True` | Whether to automatically terminate the call on `EndFrame` or `CancelFrame`. |
| `ignore_rtvi_messages` | `bool` | `True` | Whether to ignore RTVI protocol messages during serialization. |
| `resampler_clear_after_secs` | `float \| None` | `0.2` | Seconds of inactivity after which the stream resampler clears its internal history to avoid audio artefacts. Set to `None` to never clear (recommended for telephony providers with irregular gaps). |
| Parameter | Type | Default | Description |
| ---------------------------- | --------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `audio_in_sample_rate` | `int` | `8000` | Sample rate of the audio Plivo sends (Hz). Incoming audio is converted to the pipeline's input rate. |
| `audio_out_sample_rate` | `int` | `8000` | Sample rate of the audio sent to Plivo (Hz). |
| `plivo_sample_rate` | `int \| None` | `None` | _Deprecated since 1.16.0._ Use `audio_in_sample_rate` and `audio_out_sample_rate` instead. Removed in 2.0.0. |
| `sample_rate` | `int \| None` | `None` | _Deprecated since 1.16.0._ Has no effect: incoming audio is converted to `PipelineParams.audio_in_sample_rate`. Removed in 2.0.0. |
| `auto_hang_up` | `bool` | `True` | Whether to automatically terminate the call on `EndFrame` or `CancelFrame`. |
| `ignore_rtvi_messages` | `bool` | `True` | Whether to ignore RTVI protocol messages during serialization. |
| `resampler_clear_after_secs` | `float \| None` | `0.2` | _Deprecated since 1.16.0._ Has no effect. No replacement. Removed in 2.0.0. |

## Usage

Expand Down
Loading
Loading