WebSliderRelay Class Reference

Helper class that relays audio parameter information to an object inside a WebBrowserComponent. More...

#include <juce_WebControlRelays.h>

Inheritance diagram for WebSliderRelay:

Classes
struct	Listener

Public Member Functions
	WebSliderRelay (StringRef nameIn)
	Creating a relay will ensure that a Javascript object under the provided name will be available in the specified WebBrowserComponent's context.
void	setValue (float newValue)
float	getValue () const
void	addListener (Listener *l)
void	removeListener (Listener *l)
WebBrowserComponent::Options	buildOptions (const WebBrowserComponent::Options &initialOptions) override
void	emitEvent (const var &payload)
Public Member Functions inherited from OptionsBuilder< WebBrowserComponent::Options >
virtual	~OptionsBuilder ()=default
WebBrowserComponent::Options	buildOptions ()

Detailed Description

Helper class that relays audio parameter information to an object inside a WebBrowserComponent.

In order to create a relay you need to specify an identifier for the relayed state. This will result in a Javascript object becoming available inside the WebBrowserComponent under the provided identifier.

Pass the relay object to WebBrowserComponent::Options::withOptionsFrom() to associate it with a WebBrowserComponent instance.

You can then use a WebSliderParameterAttachment as you would a SliderAttachment, to attach the relay to a RangedAudioParameter. This will synchronise the state and events of the Javascript object with the audio parameter at all times.

// Add a relay to your AudioProcessorEditor members
WebSliderRelay cutoffSliderRelay { "cutoffSlider" };
WebBrowserComponent webComponent { WebBrowserComponent::Options{}::withOptionsFrom (cutoffSliderRelay) };

// In your Javascript GUI code you obtain an object from the framework
import * as Juce from "juce-framework-frontend";
const sliderState = Juce.getSliderState("cutoffSlider");

See also

WebSliderParameterAttachment

Constructor & Destructor Documentation

WebSliderRelay()

WebSliderRelay::WebSliderRelay

(

StringRef

nameIn

)

Creating a relay will ensure that a Javascript object under the provided name will be available in the specified WebBrowserComponent's context.

Use the frontend framework's getSliderState function with the same name to get a hold of this object.

Member Function Documentation

setValue()

void WebSliderRelay::setValue

(

float

newValue

)

getValue()

float WebSliderRelay::getValue

(

)

const

addListener()

void WebSliderRelay::addListener

(

Listener *

l

)

removeListener()

void WebSliderRelay::removeListener

(

Listener *

l

)

buildOptions()

WebBrowserComponent::Options WebSliderRelay::buildOptions ( const WebBrowserComponent::Options & initialOptions )

overridevirtual

Implements OptionsBuilder< WebBrowserComponent::Options >.

emitEvent()

void WebSliderRelay::emitEvent

(

const var &

payload

)

---

The documentation for this class was generated from the following file:

• juce_WebControlRelays.h