Mema::PluginProcessingStateMessage Class Reference

Carries the plugin enabled and pre/post insertion state between Mema and Mema.Re. More...

#include <MemaMessages.h>

Inheritance diagram for Mema::PluginProcessingStateMessage:

Collaboration diagram for Mema::PluginProcessingStateMessage:

Public Member Functions
	PluginProcessingStateMessage ()=default
	PluginProcessingStateMessage (bool enabled, bool post)
	PluginProcessingStateMessage (const juce::MemoryBlock &blob)
	~PluginProcessingStateMessage ()=default
bool	isEnabled () const
	Returns whether plugin processing is enabled.
bool	isPost () const
	Returns whether the plugin is inserted post-matrix (true) or pre-matrix (false).
Public Member Functions inherited from Mema::SerializableMessage
	SerializableMessage ()=default
virtual	~SerializableMessage ()=default
void	setId (int id)
	Tags the message with a connection-id used for echo-suppression on the server.
int	getId () const
	Returns the connection-id tag, or -1 if not set.
bool	hasUserId () const
	Returns true when a non-default connection-id has been assigned.
const SerializableMessageType	getType () const
	Returns the concrete message type discriminator.
juce::MemoryBlock	getSerializedMessage () const
	Serialises the message to a MemoryBlock ready to send over the socket.

Protected Member Functions
juce::MemoryBlock	createSerializedContent (size_t &contentSize) const override
	Subclass hook — produces the type-specific payload bytes (everything after the type discriminator).
Protected Member Functions inherited from Mema::SerializableMessage
std::uint32_t	ReadUint32 (const char *buffer)
	Reads a big-endian uint32 from buffer.
std::uint16_t	ReadUint16 (const char *buffer)
	Reads a big-endian uint16 from buffer.

Additional Inherited Members
Public Types inherited from Mema::SerializableMessage
enum	SerializableMessageType {   None = 0 ,   EnvironmentParameters ,   AnalyzerParameters ,   ReinitIOCount ,   AudioInputBuffer ,   AudioOutputBuffer ,   DataTrafficTypeSelection ,   ControlParameters ,   PluginParameterInfos ,   PluginParameterValue ,   PluginProcessingState }
Static Public Member Functions inherited from Mema::SerializableMessage
static SerializableMessage *	initFromMemoryBlock (const juce::MemoryBlock &blob)
	Deserialises a raw TCP frame into the correct concrete SerializableMessage subclass.
static void	freeMessageData (SerializableMessage *message)
	Type-correctly destroys a SerializableMessage* returned by initFromMemoryBlock().
Protected Attributes inherited from Mema::SerializableMessage
SerializableMessageType	m_type = SerializableMessageType::None
	Type discriminator stored in the first 4 bytes of every serialised frame.
int	m_userId = -1
	Optional connection-id tag for echo-suppression (-1 = not set).

Detailed Description

Carries the plugin enabled and pre/post insertion state between Mema and Mema.Re.

Sent by MemaProcessor to all connected Mema.Re clients whenever the plugin enabled or pre/post state changes. Also sent from PluginControlComponent (Mema.Re side) back to Mema when the user clicks the enabled or pre/post buttons.

Wire payload: enabled (bool) + post (bool).

Definition at line 1167 of file MemaMessages.h.

Constructor & Destructor Documentation

PluginProcessingStateMessage() [1/3]

Mema::PluginProcessingStateMessage::PluginProcessingStateMessage ( )

default

PluginProcessingStateMessage() [2/3]

Mema::PluginProcessingStateMessage::PluginProcessingStateMessage ( bool  enabled, bool  post  )

inline

Definition at line 1171 of file MemaMessages.h.

References Mema::SerializableMessage::m_type, and Mema::SerializableMessage::PluginProcessingState.

PluginProcessingStateMessage() [3/3]

Mema::PluginProcessingStateMessage::PluginProcessingStateMessage ( const juce::MemoryBlock &  blob )

inline

Definition at line 1178 of file MemaMessages.h.

References Mema::SerializableMessage::m_type, and Mema::SerializableMessage::PluginProcessingState.

~PluginProcessingStateMessage()

Mema::PluginProcessingStateMessage::~PluginProcessingStateMessage ( )

default

Member Function Documentation

createSerializedContent()

juce::MemoryBlock Mema::PluginProcessingStateMessage::createSerializedContent ( size_t &  contentSize ) const

inlineoverrideprotectedvirtual

Subclass hook — produces the type-specific payload bytes (everything after the type discriminator).

Parameters

contentSize

Set by the implementation to the byte count of the returned block.

Returns

A MemoryBlock containing only the payload (no type prefix).

Implements Mema::SerializableMessage.

Definition at line 1200 of file MemaMessages.h.

isEnabled()

bool Mema::PluginProcessingStateMessage::isEnabled ( ) const

inline

Returns whether plugin processing is enabled.

Definition at line 1195 of file MemaMessages.h.

isPost()

bool Mema::PluginProcessingStateMessage::isPost ( ) const

inline

Returns whether the plugin is inserted post-matrix (true) or pre-matrix (false).

Definition at line 1197 of file MemaMessages.h.

---

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

• Source/MemaProcessor/MemaMessages.h