wx44wx/pipecat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update COMMUNITY_INTEGRATIONS.md for Settings alias class

Browse Source
This commit is contained in:
Mark Backman
2026-03-09 10:24:24 -04:00
parent cd28c82de3
commit f7dc13c0de
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
COMMUNITY_INTEGRATIONS.md
View File

@@ -271,12 +271,15 @@ The rule of thumb: if a caller might send an update frame to change it at runtim
#### Wiring settings into `__init__` #### Wiring settings into `__init__`
Accept an **optional** `settings` parameter. Build a `default_settings` object with all fields set to real values, then merge any caller overrides with `apply_update`: Accept an **optional** `settings` parameter. Build a `default_settings` object with all fields set to real values, then merge any caller overrides with `apply_update`.
Add a `Settings` **class attribute** that points to your settings dataclass. This lets callers access the settings class through the service itself (e.g. `MyTTSService.Settings(...)`) without a separate import:
```python ```python
from typing import Optional from typing import Optional
class MyTTSService(TTSService): class MyTTSService(TTSService):
Settings = MyTTSSettings
_settings: MyTTSSettings _settings: MyTTSSettings
def __init__( def __init__(
@@ -311,10 +314,10 @@ This pattern lets callers override only what they care about:
# Uses all defaults # Uses all defaults
svc = MyTTSService(api_key="sk-xxx") svc = MyTTSService(api_key="sk-xxx")
# Overrides just the voice # Overrides just the voice — access Settings through the service class
svc = MyTTSService( svc = MyTTSService(
api_key="sk-xxx", api_key="sk-xxx",
settings=MyTTSSettings(voice="custom-voice"), settings=MyTTSService.Settings(voice="custom-voice"),
) )
``` ```