Skip to content

Commit

Permalink
Update Stopping-Audio.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JujuAdams committed Sep 18, 2024
1 parent c940b3f commit 0faf0a6
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/6.1/Stopping-Audio.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,13 +118,13 @@ No example provided.

#### **Description**

*Returns:* Boolean
*Returns:* Boolean, whether the target voice will stop playing imminently

|Name |Datatype|Purpose |
|-------|--------|----------------------------|
|`voice`|voice |Voice to target |

Returns whether the target voice will stop playing imminently. The tolerance for this test is set by the `VINYL_WILL_STOP_TOLERANCE` macro (see `__VinylConfigMacros()`).
Returns whether the target voice will stop playing imminently. The tolerance for this test is set by the `VINYL_WILL_STOP_TOLERANCE` macro (see `__VinylConfigMacros()`). If a voice is paused then this function will return `false`. If a voice has already been stopped, this function will return `true`. A looping voice will return `false` (this includes queues that are set to loop).

#### **Example**

Expand Down

0 comments on commit 0faf0a6

Please sign in to comment.