# Stop Voice

## Description

```javascript
'stop voice [voice_id] [with fade <time>]'
```

The stop voice action will let you stop either all voices currently playing or only one in specific. To learn more about voices, read the [Play Voice documentation](/documentation/script-actions/play-voice.md).

**Note**: Voice audio is automatically stopped when the player advances to the next statement. This action is useful when you want to stop a voice before the player proceeds, or when you have looping voice audio.

**Action ID**: `Stop`

**Reversible**: Yes (restores the previously playing voices from history)

**Requires User Interaction**: No

## Parameters

| Name      | Type     | Description                                                                                        |
| --------- | -------- | -------------------------------------------------------------------------------------------------- |
| voice\_id | `string` | Optional. The name of the specific voice you want to stop. If omitted, all voices will be stopped. |
| fade      | `number` | Optional. Fade out time in seconds.                                                                |

## Examples

### Stop a Specific Voice

The following will stop a specific voice, identified by its name.

{% tabs %}
{% tab title="Script" %}

```javascript
monogatari.script({
    'Start': [
        'play voice dialog_002 with loop',
        'The previous voice will be repeating itself over and over',
        'play voice dialog_001',
        'Two voices are currently playing',
        'stop voice dialog_002',
        'Now the first one has stopped and the second one will stop as soon as it ends',
        'end'
    ]
});
```

{% endtab %}

{% tab title="Voice Assets" %}

```javascript
monogatari.assets('voices', {
    'dialog_001': 'dialog_file_1.mp3',
    'dialog_002': 'dialog_file_2.mp3'
});
```

{% endtab %}
{% endtabs %}

### Stop All Voices

The following will stop all voices currently playing.

{% tabs %}
{% tab title="Script" %}

```javascript
monogatari.script({
    'Start': [
        'play voice dialog_002 with loop',
        'The previous voice will be repeating itself over and over',
        'play voice dialog_001',
        'Two voices are currently playing',
        'stop voice',
        'No voice is playing now',
        'end'
    ]
});
```

{% endtab %}

{% tab title="Voice Assets" %}

```javascript
monogatari.assets('voices', {
    'dialog_001': 'dialog_file_1.mp3',
    'dialog_002': 'dialog_file_2.mp3'
});
```

{% endtab %}
{% endtabs %}

### Fade Out Effect

The following will stop the voice with a fade out effect. You can also use a fade out effect when stopping all voices.

{% tabs %}
{% tab title="Script" %}

```javascript
monogatari.script({
    'Start': [
        'play voice dialog_002 with loop',
        'The previous voice will be repeating itself over and over',
        'play voice dialog_001',
        'Two voices are currently playing',
        'stop voice dialog_002 with fade 2',
        'The looping voice fades out...',
        'end'
    ]
});
```

{% endtab %}

{% tab title="Voice Assets" %}

```javascript
monogatari.assets('voices', {
    'dialog_001': 'dialog_file_1.mp3',
    'dialog_002': 'dialog_file_2.mp3'
});
```

{% endtab %}
{% endtabs %}

### Fade Out All Voices

```javascript
'stop voice with fade 3'  // Fade out all voices over 3 seconds
```

## Related Actions

* [Play Voice](/documentation/script-actions/play-voice.md) - Play voice audio
* [Pause](https://github.com/Monogatari/Documentation/blob/master/script-actions/pause.md) - Pause playing media (can be resumed later)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.monogatari.io/documentation/script-actions/stop-voice.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.