From f34e13de7df162802eb427fc5ca7783765a62ffe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robb=20B=C3=B6hnke?= <212465+robb@users.noreply.github.com> Date: Wed, 18 Jan 2023 14:16:38 +0100 Subject: [PATCH] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 2511a51..8f8b496 100644 --- a/README.md +++ b/README.md @@ -194,6 +194,10 @@ static func shine(angle: Angle, duration: Double = 1.0) -> AnyChangeEffect Triggers a sound effect as feedback whenever a value changes. +This effect will not interrupt or duck any other audio that may currently playing. It may also not triggered based on the setting of the user's silent switch or playback device. + +To relay important information to the user, you should always accompany audio effects with visual cues. + - `soundEffect`: The sound effect to trigger. ```swift