Chime TTS

https://nimroddolev.github.io/chime_tts/
Admin
The official site for Chime TTS documentation, explanations and usage examples. Locally combine...
Tokens:10,462
Snippets:157
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Play Chime Before TTS

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

This example shows how to play a predefined chime sound before the TTS message using the `chime_path` parameter.

```yaml
action: chime_tts.say
target:
  entity_id:
    - media_player.living_room
data:
  tts_platform: google_translate
  message: Hello world!
  chime_path: tada
```

--------------------------------

### Play Chimes Before and After TTS

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

This example combines `chime_path` and `end_chime_path` to play chimes both before and after the TTS message.

```yaml
action: chime_tts.say
target:
  entity_id:
    - media_player.living_room
data:
  tts_platform: google_translate
  message: Hello world!
  chime_path: drumroll
  end_chime_path: /media/sounds/doorbell.mp3
```

--------------------------------

### Chime TTS Say with Audio Conversion

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

Use `audio_conversion` to specify FFmpeg arguments for audio processing. This example sets the audio volume to 50%.

```yaml
action: chime_tts.say
target:
  entity_id:
    - media_player.kitchen
data:
  chime_path: bells
  message: Audio at 50% volume
  tts_platform: google_translate
  tld: com.au
  audio_conversion: Volume 50%

```

--------------------------------

### Basic TTS Audio

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

A fundamental example of using the `chime_tts.say` action. It requires a media player target and specifies the TTS platform and message.

```yaml
action: chime_tts.say
target:
  entity_id:
    - media_player.living_room
data:
  tts_platform: google_translate
  message: Hello world!
```

--------------------------------

### Musical TTS Sequence

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

This complex example demonstrates creating a musical sequence by providing a list of TTS messages, each with custom pitch, speed, and offset values.

```yaml
action: chime_tts.say
target:
  entity_id:
    - media_player.kitchen
    - media_player.dining_room
data:
  tts_platform: google_translate
  message:
    - tts: Laah
      pitch: -12
      speed: 90
    - tts: Laah
      pitch: 0
      speed: 125
      offset: -400
    - tts: Laah
      pitch: 4
      speed: 90
      offset: -400
    - tts: Laah
      pitch: 7
      speed: 125
      offset: -400
    - tts: Laah
      pitch: -15
      speed: 90
      offset: -400
    - tts: Laah
      pitch: -3
      speed: 125
      offset: -400
    - tts: Laah
      pitch: 1
      speed: 90
      offset: -400
    - tts: Laah
      pitch: 4
      speed: 125
      offset: -400
    - tts: Laah
      pitch: -19
      speed: 90
      offset: -400
    - tts: Laah
      pitch: -7
      speed: 125
      offset: -400
    - tts: Laah
      pitch: -3
      speed: 90
      offset: -400
    - tts: Laah
      pitch: 0
      speed: 125
      offset: -400
    - tts: Laah
      pitch: -17
      speed: 90
      offset: -400
    - tts: Laah
      pitch: -5
      speed: 125
      offset: -400
    - tts: Laah
      pitch: -1
      speed: 90
      offset: -400
    - tts: Laah
      pitch: 2
      speed: 125
      offset: -400
    - tts: Laah
      pitch: 12
      speed: 70
      offset: -4916
    - tts: Laah
      pitch: 12
      speed: 70
      offset: -4340
    - tts: Laah
      pitch: 12
      speed: 39.05
      offset: -3950
    - tts: Laah
      pitch: 12
      speed: 125
      offset: -2300
    - tts: Laah
      pitch: 11
      speed: 90
      offset: -2150
    - tts: Laah
      pitch: 9
      speed: 125
      offset: -1800
    - tts: Laah
      pitch: 11
      speed: 90
      offset: -1600
    - tts: Laah
      pitch: 12
      speed: 125
      offset: -1200
    - tts: Laah
      pitch: 15
      speed: 90
      offset: -1000
```

--------------------------------

### Chime TTS Say with Repeated Chime Segment

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

This example shows how to repeat a chime segment multiple times using the 'repeat' parameter, with an offset.

```yaml
action: chime_tts.say
target:
  entity_id: media_player.macbook_air
data:
  tts_platform: google_translate
  message:
    - chime: https://www.zapsplat.com/wp-content/uploads/2015/sound-effects-three/household_clock_cuckoo_strike_001.mp3
      repeat: 3
      offset: -800
    - tts: It's 3 o'clock

```

--------------------------------

### Chime TTS Say with Delay Segment

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

This example illustrates how to introduce a delay between TTS messages using the 'delay' segment type.

```yaml
action: chime_tts.say
target:
  entity_id: media_player.kitchen_speaker
data:
  tts_platform: google_translate
  message:
    - tts: Hey, do you hear that? Just listen.
    - delay: 1000
    - tts: Yep, sounds like clothes waiting to be moved to the dryer

```

--------------------------------

### Play Chime After TTS

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

This example demonstrates playing a chime sound from your media folder after the TTS message using the `end_chime_path` parameter.

```yaml
action: chime_tts.say
target:
  entity_id:
    - media_player.living_room
data:
  tts_platform: google_translate
  message: Hello world!
  end_chime_path: /media/sounds/doorbell.mp3
```

--------------------------------

### Raise TTS Pitch

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

Use the `tts_pitch` parameter to raise the pitch of the TTS audio. This example sets the pitch to 5.

```yaml
action: chime_tts.say
target:
  entity_id:
    - media_player.kitchen
    - media_player.dining_room
data:
  chime_path: chord
  message: The washing's done!
  tts_platform: amazon_polly
  tts_pitch: 5
```

--------------------------------

### Chime TTS Say with Multiple TTS Segments

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

This example shows how to construct complex notifications using multiple TTS message segments, overriding parameters like cache, offset, language, and TTS platform for individual segments.

```yaml
action: chime_tts.say
target:
  entity_id: media_player.kitchen_speaker
data:
  chime_path: classical
  end_chime_path: marimba
  tts_platform: google_translate
  cache: false
  language: en
  message:
    - tts: May I please have your attention?
      cache: true
    - tts: It is officially time to move the washing to the dryer
      offset: 3000
      options:
        tld: co.uk
    - tts: Vámonos!
      language: es
      options:
        tld: es
      tts_speed: 115
    - type: tts
      message: Let's go!
      tts_platform: amazon_polly

```

--------------------------------

### Chime TTS: Options - Voice

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Specify the voice to be used for TTS playback, for example, 'Wendy'.

```yaml
options:
  voice: Wendy
```

--------------------------------

### Chime TTS Say with Chime and TTS Segments

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

This example demonstrates combining chime sounds and TTS messages within a single notification, including delays between segments.

```yaml
action: chime_tts.say
target:
  entity_id: media_player.kitchen_speaker
data:
  chime_path: toast
  end_chime_path: tada
  tts_platform: google_translate
  message:
    - tts: And the winner is, drumroll please
    - chime: drumroll
      offset: 500
    - tts: You!
      offset: 0
    - chime: /config/media/sounds/my_chimes/hooray.mp3
    - tts: You get to move the washing to the dryer!
    - chime: dun_dun_dun
    - tts: Sorry. You're the only one with arms.

```

--------------------------------

### Lower TTS Pitch

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

Use the `tts_pitch` parameter to lower the pitch of the TTS audio. This example sets the pitch to -7.

```yaml
action: chime_tts.say
target:
  entity_id:
    - media_player.kitchen
    - media_player.dining_room
data:
  chime_path: chord
  message: The washing's done!
  tts_platform: amazon_polly
  tts_pitch: -7
```

--------------------------------

### Increase TTS Speed

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

Use the `tts_speed` parameter to increase the playback speed of the TTS audio. This example sets the speed to 150.

```yaml
action: chime_tts.say
target:
  entity_id:
    - media_player.kitchen
    - media_player.dining_room
data:
  chime_path: bells_2
  message: The washing's done!
  tts_platform: amazon_polly
  tts_speed: 150
```

--------------------------------

### Decrease TTS Speed

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

Use the `tts_speed` parameter to decrease the playback speed of the TTS audio. This example sets the speed to 75.

```yaml
action: chime_tts.say
target:
  entity_id:
    - media_player.kitchen
    - media_player.dining_room
data:
  chime_path: bells_2
  message: The washing's done!
  tts_platform: amazon_polly
  tts_speed: 75
```

--------------------------------

### Basic Chime TTS Notification

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/notify/sending

Send a simple reminder notification using Chime TTS. This example uses the default chime path and volume level.

```yaml
action: notify.reminder
data:
  message: "Don't forget to pick up the kids!"

```

--------------------------------

### Chime TTS Say with Language and TLD

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

Specify language and TLD to play TTS audio with a different accent using Google Translate TTS. This example uses French language and TLD.

```yaml
action: chime_tts.say
target:
  entity_id:
    - media_player.kitchen
    - media_player.dining_room
data:
  chime_path: tada
  message: le lavage est fait!
  tts_platform: google_translate
  language: fr
  tld: fr

```

--------------------------------

### Chime TTS Say with Positive Offset (Delay)

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

Use a positive offset to add a delay between chimes and TTS audio. This example delays the TTS message by 2000ms.

```yaml
action: chime_tts.say
target:
  entity_id:
    - media_player.kitchen
    - media_player.dining_room
data:
  chime_path: drumroll
  end_chime_path: tada
  message: The suspense is killing me
  tts_platform: google_translate
  offset: 2000

```

--------------------------------

### Chime TTS Say with Negative Offset (Overlay)

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

Use a negative offset to overlay chimes and TTS audio. This example overlays the chime and TTS message with an offset of -2100ms.

```yaml
action: chime_tts.say
target:
  entity_id:
    - media_player.kitchen
    - media_player.dining_room
data:
  chime_path: soft
  message: It's time to go to work
  tts_platform: google_translate
  offset: -2100

```

--------------------------------

### Basic Chime TTS Notify Entry

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/notify/adding

A basic configuration for a Chime TTS notify entry. Use this for simple notification setups with a defined name, platform, media players, chime sound, TTS platform, and language.

```yaml
notify:
  - name: announcements
    platform: chime_tts
    entity_id:
      - media_player.kitchen
      - media_player.office
    chime_path: soft
    tts_platform: cloud
    language: en-AU

```

--------------------------------

### Basic `chime_tts.say` Call with Custom Chime

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action

Demonstrates how to use a custom chime by its file name without the full path or extension. This requires the chime to be in the configured Custom Chimes Folder and a restart of Home Assistant.

```yaml
action: chime_tts.say
data:
  chime_path: bell
  message: Someone's at the door
target:
  entity_id:
    - media_player.kitchen
    - media_player.living_room
    - media_player.garage
```

--------------------------------

### Local File Chime Path

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Use a local audio file as a chime by providing its file path.

```yaml
chime_path: /media/sounds/notification.mp3
```

--------------------------------

### Full Path to Custom Chime

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action

Shows how to specify the full path to a custom chime audio file. This method is an alternative to using the chime's file name directly when it's in the Custom Chimes Folder.

```yaml
action: chime_tts.say
data:
  chime_path: /media/chime_tts/custom_chimes/bell.mp3
  message: Someone's at the door
target:
  entity_id:
    - media_player.kitchen
    - media_player.living_room
    - media_player.garage
```

--------------------------------

### Local File End Chime Path

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Use a local audio file as an end chime by providing its file path.

```yaml
end_chime_path: /media/sounds/notification.mp3
```

--------------------------------

### TTS Platform Configuration

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Specify the TTS platform to be used for generating TTS audio. This requires the TTS platform to be added to your Home Assistant instance beforehand.

```yaml
tts_platform: amazon_polly
```

--------------------------------

### Volume Level (Single Media Player)

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Set a uniform volume level (0.0 - 1.0) for all media players involved in the action.

```yaml
volume_level: 0.75
```

--------------------------------

### Notify Evening Entry

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/notify

This demonstrates a simplified notify action call using a pre-configured 'evening' notify entry.

```yaml
action: notify.evening
data:
  message: Someone's at the door
```

--------------------------------

### Chime Path Presets

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Use one of the predefined Chime TTS presets for the audio to insert before the TTS audio.

```yaml
chime_path: ba_dum_tss
```

--------------------------------

### Home Assistant Configuration for External URL

Source: https://nimroddolev.github.io/chime_tts/docs/quick-start/additional-requirements

Configure your Home Assistant's `external_url` and `internal_url` in `configuration.yaml` to ensure public accessibility of media files for Alexa devices.

```yaml
homeassistant:
  external_url: "https://YOUR_NABU_CASA_ADDRESS.ui.nabu.casa/"
  internal_url: "http://192.168.X.X:8123/"

```

--------------------------------

### End Chime Path Presets

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Use one of the predefined Chime TTS presets for the audio to insert after the TTS audio.

```yaml
end_chime_path: ba_dum_tss
```

--------------------------------

### Chime TTS: Audio Conversion - FFmpeg Arguments

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Provide any valid FFmpeg arguments for audio conversion.

```yaml
audio_conversion: "-y -ac 2 -codec:a libmp3lame -b:a 48k -ar 24000 -write_xing 0"
```

--------------------------------

### chime_tts.say_url Action Call

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say_url-action

This snippet shows how to call the chime_tts.say_url action with a message, chime path, and TTS platform. Ensure the chime_path and tts_platform are correctly configured in your integration.

```yaml
action: chime_tts.say_url
data:
  chime_path: toast
  message: May I have your attention, please?
  tts_platform: google_translate

```

--------------------------------

### chime_tts.say_url Result (Public URL)

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say_url-action

This is the expected result when the chime_tts.say_url folder path is configured within the public 'www' folder. The 'url' key will contain the accessible path to the audio file.

```json
{
  url: https://{YOUR-HOME-ASSISTANT-ADDRESS}:8123/local/chime_tts/gtv7ju45.mp3
  media_content_id: null,
  duration: 4.069,
  success: true
}

```

--------------------------------

### Chime TTS Say Action

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/notify

This is a detailed chime_tts.say action call with various parameters configured.

```yaml
action: chime_tts.say
data:
  chime_path: soft
  offset: -2250
  message: Someone's at the door
  tts_platform: google_translate
  language: en
  tld: com.au
  volume_level: 0.65
  cache: true
  join_players: true
  unjoin_players: true
  announce: true
target:
  entity_id:
    - media_player.kitchen
    - media_player.living_room
    - media_player.garage
```

--------------------------------

### Replay Previous TTS Action

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/replay-action

Use this action to repeat the last `chime_tts.say` call without needing to specify parameters again. It has no configurable parameters.

```yaml
action: chime_tts.replay
data:  

```

--------------------------------

### Volume Level (Multiple Media Players)

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Set individual volume levels for each media player entity by providing a dictionary.

```yaml
volume_level:
  media_player.kitchen: 1.00
  media_player.bedroom: 0.45
  media_player.living_room: 0.75
  media_player.study: 0.5
```

--------------------------------

### Enable Chime TTS Debug Logging

Source: https://nimroddolev.github.io/chime_tts/docs/support

Enable debug logging for the Chime TTS integration in Home Assistant to capture detailed log messages for troubleshooting.

```yaml
action: logger.set_level
data:
  custom_components.chime_tts: debug

```

--------------------------------

### Remote URL End Chime Path

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Use an audio file from a remote URL as an end chime by providing its web address.

```yaml
end_chime_path: https://www.website.com/sounds/notification.ogg
```

--------------------------------

### Custom Chime Path

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Specify a custom chime sound by providing its name, assuming it's located in the Custom Chimes Folder.

```yaml
chime_path: My Custom Chime
```

--------------------------------

### Remote URL Chime Path

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Use an audio file from a remote URL as a chime by providing its web address.

```yaml
chime_path: https://www.website.com/sounds/notification.ogg
```

--------------------------------

### Chime Segment with Offset

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Shows how to insert a chime at a specific point in the message using the `chime` segment type and the `offset` parameter. Supports custom audio file paths.

```yaml
action: chime_tts.say
target:
  entity_id: media_player.kitchen_speaker
data:
  chime_path: toast
  end_chime_path: tada
  tts_platform: google_translate
  message:
    - tts: And the winner is, drumroll please
    - chime: drumroll
      offset: 500
    - tts: You!
      offset: 0
    - chime: /config/media/sounds/my_chimes/hooray.mp3
    - tts: You get to move the washing to the dryer!
```

--------------------------------

### Chime TTS: Announce Feature

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Set to true to pause current media, play TTS, and resume media afterwards. Works natively on supported platforms and is simulated for others.

```yaml
announce: true
```

--------------------------------

### Repeat Parameter for Message Segments

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Demonstrates the `repeat` parameter, which can be applied to any message segment type (`tts`, `chime`, `delay`) to specify how many times that segment should be repeated.

```yaml
action: chime_tts.say
target:
  entity_id: media_player.macbook_air
data:
  tts_platform: google_translate
  message:
    - chime: https://www.zapsplat.com/wp-content/uploads/2015/sound-effects-three/household_clock_cuckoo_strike_001.mp3
      repeat: 3
      offset: -800
    - tts: It's 3 o'clock
```

--------------------------------

### chime_tts.say_url Result (Media Content ID)

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say_url-action

This is the expected result when the chime_tts.say_url folder path is configured within the 'media' folder. The 'media_content_id' key will contain a reference usable with media players.

```json
{
  url: null
  media_content_id: media-source://media_source/local/chime_tts/gtv7ju45.mp3,
  duration: 4.069,
  success: true
}

```

--------------------------------

### Chime TTS Say with Join Players

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/examples

Use `join_players` to play the announcement across multiple speakers simultaneously. `unjoin_players` is also set to true for subsequent announcements.

```yaml
action: chime_tts.say
target:
  entity_id:
    - media_player.kitchen
    - media_player.dining_room
    - media_player.bedroom
data:
  chime_path: tada
  message: The washing's done!
  tts_platform: amazon_polly
  join_players: true
  unjoin_players: true

```

--------------------------------

### Custom End Chime Path

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Specify a custom chime sound by providing its name, assuming it's located in the Custom Chimes Folder, to be played after the TTS audio.

```yaml
end_chime_path: My Custom Chime
```

--------------------------------

### Chime TTS: Join Players

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Set to true to play audio simultaneously on multiple media_player entities that support speaker groups.

```yaml
join_players: true
```

--------------------------------

### Advanced Message: TTS, Chime, Delay Segments

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Use a YAML sequence for the `message` parameter to combine TTS speech, chimes, and delays within a single action. This allows for complex audio sequences.

```yaml
action: chime_tts.say
target:
  entity_id: media_player.kitchen_speaker
data:
  chime_path: chord
  end_chime_path: tada
  offset: 0
  tts_platform: google_translate
  language: en
  message:
    - tts: Greetings friend!
      tts_platform: amazon_polly
    - chime: bells_2
    - tts: Hola amigo!
      language: es
      options:
        tld: es
      offset: 500
    - delay: 1000
    - tts: G'day mate!
      cache: true
      tts_speed: 115
      options:
        tld: com.au
```

--------------------------------

### Offset for Audio Timing

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Adjust the timing between audio segments. Positive values add a delay, while negative values overlay audio.

```yaml
offset: 500
```

```yaml
offset: -500
```

--------------------------------

### Chime TTS: Cache Audio

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Set to true to save generated audio to the cache for reuse in future action calls.

```yaml
cache: true
```

--------------------------------

### Chime TTS: Audio Conversion - Volume

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Set audio volume to 200% of the original using the 'Volume 200%' argument.

```yaml
audio_conversion: "Volume 200%"
```

--------------------------------

### Chime TTS: Audio Conversion for Alexa

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Use 'Alexa' to convert audio for playback on Alexa media_players.

```yaml
audio_conversion: Alexa
```

--------------------------------

### TTS Speed Configuration

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Control the speech synthesis speed, ranging from 1% to 500% of the default speed.

```yaml
tts_speed: 150
```

--------------------------------

### Final Delay

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Specify a delay in milliseconds to be inserted after all chimes and TTS audio have completed.

```yaml
final_delay: 200
```

--------------------------------

### TTS Pitch Configuration

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Adjust the pitch of the TTS audio in semitones. Positive values increase pitch, negative values decrease it.

```yaml
tts_pitch: 2
```

--------------------------------

### TTS Segment with Overridden Parameters

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Demonstrates using the `tts` segment type within a message sequence to override parameters like `cache`, `offset`, `language`, and `tts_platform` for individual segments.

```yaml
action: chime_tts.say
target:
  entity_id: media_player.kitchen_speaker
data:
  chime_path: classical
  end_chime_path: marimba
  tts_platform: google_translate
  cache: false
  language: en
  message:
    - tts: May I please have your attention?
      cache: true
    - tts: It is officially time to move the washing to the dryer
      offset: 3000
      options:
        tld: co.uk
    - tts: Vámonos!
      language: es
      options:
        tld: es
      tts_speed: 115
    - type: tts
      message: Let's go!
      tts_platform: amazon_polly
```

--------------------------------

### Chime TTS: Fade Audio

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Set to true to fade out and pause current media, play TTS with a fade-in, and resume media.

```yaml
fade_audio: true
```

--------------------------------

### Crossfade Duration

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Set the duration in milliseconds for gradually fading between audio segments.

```yaml
crossfade: 500
```

--------------------------------

### Clear All Chime TTS and HA TTS Cache

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/clear_cache-action

Use this snippet to clear all types of cached audio files including local chime files, temporary TTS files, publicly accessible TTS files, and Home Assistant's TTS cache. This is useful for ensuring the latest audio is generated and freeing up disk space.

```yaml
action: chime_tts.clear_cache
data:
  clear_chimes_cache: true
  clear_temp_tts_cache: true
  clear_www_tts_cache: true
  clear_ha_tts_cache: true

```

--------------------------------

### Advanced Chime TTS Notify Entry

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/notify/adding

An advanced configuration for a Chime TTS notify entry. This includes additional parameters for voice, volume, announcement behavior, and player management.

```yaml
notify:
  - name: reminder
    platform: chime_tts
    chime_path: whistle
    entity_id:
      - media_player.kitchen
      - media_player.living_room
      - media_player.study
      - media_player.bedroom
      - media_player.spotify
    tts_platform: cloud
    language: en-AU
    voice: TinaNeural
    volume_level: 1
    announce: true
    join_players: true
    unjoin_players: true

```

--------------------------------

### Home Assistant Configuration for Alexa TTS

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action

This configuration is required for Chime TTS playback on Alexa smart speakers using the Alexa Media Player integration. It sets the external and internal URLs for Home Assistant, which Alexa speakers need to access audio files.

```yaml
homeassistant:
  external_url: "https://[REPLACE WITH YOUR PUBLIC ADDRESS]:8123/"
  internal_url: "http://[REPLACE WITH YOUR LOCAL IP ADDRESS]:8123/"
```

--------------------------------

### Delay Segment for Pausing

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Illustrates the use of the `delay` segment type to introduce pauses within the TTS message, useful for dramatic effect or pacing.

```yaml
action: chime_tts.say
target:
  entity_id: media_player.kitchen_speaker
data:
  tts_platform: google_translate
  message:
    - tts: Hey, do you hear that? Just listen.
    - delay: 1000
    - tts: Yep, sounds like clothes waiting to be moved to the dryer
```

--------------------------------

### Chime TTS: Unjoin Players

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/actions/say-action/parameters

Set to true to unjoin speakers after playback has completed.

```yaml
unjoin_players: true
```

--------------------------------

### Chime TTS Notification with Parameter Overrides

Source: https://nimroddolev.github.io/chime_tts/docs/documentation/notify/sending

Send a reminder notification with Chime TTS, overriding the default chime path and volume level. This allows for custom sounds and loudness.

```yaml
action: notify.reminder
data:
  message: "Don't forget to pick up the kids!"
  data:
    chime_path: /media/sounds/chimes/urgent.mp3
    volume_level: 1.0

```
Tokens:
Raw