npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mediamonks/use-channels

v1.0.1

Published

React hook for using Channels

Downloads

1

Readme

use-channels

A set of hooks for using the Channels package in a React project.

Installation

npm install @mediamonks/use-channels

Overview

  • ChannelsProvider: component that creates a Channels instance
  • useChannels: returns the Channels instance
  • useVolumeChange: adds listeners for volume changes
  • usePanningChange: adds listeners for pan changes
  • usePlayingSounds: keeps track of sounds that are being played

ChannelsProvider

Before being able to use useChannels, somewhere in your React application (probably at the root of the app tree), a <ChannelsProvider> component must be present. This will create a Channels instance and provide it through React Context to the component's children.

import { ChannelsProvider } from '@mediamonks/use-channels';

export const ParentComponent = () => {
   return <ChannelsProvider
        soundsExtension="mp3"
        soundsPath={'path/to/files'}
    >
        <App />
    </ChannelsProvider>
}

The available props for the ChannelProvider are taken directly from the Channels constructor (of whichever version you have installed), so check the Channels package for more information.

The children of the ChannelsProvider can either be a ReactNode (as shown in the example above), or a function that returns a ReactNode. In the latter, the created Channels instance is provided as the first parameter:

export const ParentComponent = () => {
    const [isLoadComplete, setIsLoadComplete] = useState(false);
    
    return <ChannelsProvider
        soundsExtension="mp3"
        soundsPath={'path/to/files'}
    >
       {(channelsInstance) => {
           channelsInstance.loadSounds().then(() => setIsLoadComplete(true))
           return isLoadComplete ?  <App /> : <Spinner />;
       }}
    </ChannelsProvider>
}

useChannels

The Channels instance from the ChannelsProvider is available in all child components by using the useChannels hook:

import { useChannels } from '@mediamonks/use-channels';


export const ChildComponent = () => {
    const channelsInstance = useChannels();
    
    const onClick = () => {
        channelsInstance.play('my-sound');
    }
    
    return <button onClick={onClick}>play!</button>
    
}

useVolumeChange

useVolumeChange makes listening to volume changes a bit easier. It has an optional target prop, which can either be a Channel or a PlayingSound. When omitted, changes refer to the main volume.

import { useVolumeChange } from '@mediamonks/use-channels';

// listen to main volume changes
useVolumeChange({
    onChange: (value: number) => {
        // ...
    },
});

// listen to channel volume changes
useVolumeChange({
    target: myChannel,
    onChange: (value: number) => {
        // ...
    },
});

usePanningChange

usePanningChange is nearly identical to useVolumeChange but listens to changes in panning values.

usePlayingSounds

The usePlayingSounds hook keeps track of a list of all the currently playing sounds.

import { usePlayingSounds } from '@mediamonks/use-channels';

const playingSounds = usePlayingSounds();