Neighborly Package Megalodon

    @curiousmedia/vo-player

    1.5.0 • Public • Published

    VOPlayer

    VO Controller designed for handling Springroll 2.0 voVolume state, and for playing only one sound instance at a time with CreateJS Sound

    You can pass in a single UID String to the player to play or an Array of String UIDs and Numbers to play the Voiceover sequentially

    with the Numbers being a delay in between Voiceover audio files.

    new VOPlayer(volume)

    Constructor

    Param Type Default Description
    volume Number 1 volume to play the sound instances at defaults to 1

    voPlayer.volume

    Set the volume for this and the current instance playing

    Param Type Description
    volume Number volume to set

    voPlayer.volume

    Return the current volume level set on the VOPlayer

    voPlayer.instance

    Return the current instance of VO playing

    voPlayer.chain

    Return the current chain instance

    voPlayer.play(audio)

    Stop the current instance and play the new audio instance

    Param Type Description
    audio String/Array audio string UID name or Array of UID names and numbers for delay if needed

    voPlayer.pause()

    Pause the current VO instance

    voPlayer.resume()

    Resume the current VO instance

    voPlayer.stop()

    Stop the currently playing instance

    voPlayer.handleInstanceComplete(event)

    (Private) Handles what to do when an instance 'complete' event is called

    Param Type
    event Event

    voPlayer.handleChainComplete()

    Handle the completion of the chain

    Install

    npm i @curiousmedia/vo-player

    DownloadsWeekly Downloads

    0

    Version

    1.5.0

    License

    MIT

    Unpacked Size

    118 kB

    Total Files

    12

    Last publish

    Collaborators

    • cm-gregory
    • kyfoote
    • curiousjason
    • eaglstun
    • ishoa