@mediamonks/use-channels v1.0.1

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();