Browser.element but with the ability to play sounds.

Browser.document but with the ability to play sounds.

Browser.application but with the ability to play sounds.

The top level model for our program. This contains the model for your app as well as extra data needed to keep track of what audio is playing.

The top level msg for our program. This contains the msg type your app uses in addition to msgs that are needed to handle when audio gets loaded.

Information about audio files you have loaded. This is passed as a parameter to your update, view, subscriptions, and audio functions.

An audio command.

Load audio from a url.

These are possible errors we can get when loading an audio source file.

• FailedToDecode: This means we got the data but we couldn't decode it. One likely reason for this is that your url points to the wrong place and you're trying to decode a 404 page instead.
• NetworkError: We couldn't reach the url. Either it's some kind of CORS issue, the server is down, or you're disconnected from the internet.
• UnknownError: We don't know what happened but your audio didn't load!
• ErrorThatHappensWhen...: Yes, there's a good reason for this. If you need to load more than 1000 sounds make an issue about it on github and I'll see what I can do.

Audio data we can use to play sounds

Map a command from one type to another. Conceptually the same as Cmd.map.

Combine multiple commands into a single command. Conceptually the same as Cmd.batch.

A command that does nothing. Conceptually the same as Cmd.none.

Some kind of sound we want to play. To create Audio start with audio.

Play audio from an audio source at a given time. This is the same as using audioWithConfig audioDefaultConfig.

Note that in some browsers audio will be muted until user interacts with the webpage.

Combine multiple Audios into a single Audio.

The sound of no sound at all.

Get how long an audio source plays for.

Play audio from an audio source at a given time with config.

Note that in some browsers audio will be muted until user interacts with the webpage.

Default config used for audioWithConfig.

Extra settings when playing audio from a file.

-- Here we play a song at half speed and it skips the first 15 seconds of the song.
audioWithConfig
    { loop = Nothing
    , playbackRate = 0.5
    , startAt = Duration.seconds 15
    }
    myCoolSong
    songStartTime

Control how audio loops. loopEnd defines where (relative to the start of the audio) the audio should loop and loopStart defines where it should loop to.

-- Here we have a song that plays an intro once and then loops between the 10 second point and the end of the song.
let
    default =
        Audio.audioDefaultConfig


    -- This package doesn't support getting how long a sound plays for so we need to hard code it instead.
    songLength =
        Duration.seconds 120
in
audioWithConfig
    { default | loop = Just { loopStart = Duration.seconds 10, loopEnd = songLength } }
    coolBackgroundMusic
    startTime

Scale how loud a given Audio is. 1 preserves the current volume, 0.5 halves it, and 0 mutes it. If the the volume is less than 0, 0 will be used instead.

Scale how loud some Audio is at different points in time. The volume will transition linearly between those points. The points in time don't need to be sorted but they need to be unique.

import Audio
import Duration
import Time




-- Here we define an audio function that fades in to full volume and then fades out until it's muted again.
--
--  1                ________
--                 /         \
--  0 ____________/           \_______
--     t ->    fade in     fade out
fadeInOut fadeInTime fadeOutTime audio =
    Audio.scaleVolumeAt
        [ ( Duration.subtractFrom fadeInTime Duration.second, 0 )
        , ( fadeInTime, 1 )
        , ( fadeOutTime, 1 )
        , ( Duration.addTo fadeOutTime Duration.second, 0 )
        ]
        audio

Add an offset to the audio.

import Audio
import Duration


delayByOneSecond audio =
    Audio.offsetBy Duration.second audio

Lamdera.frontend but with the ability to play sounds (highly experimental, just ignore this for now).

Use this function when migrating your model in Lamdera.

Use this function when migrating messages in Lamdera.