wavelength 1.0.0
Loading...
Searching...
No Matches
MuteVocalsPacket Class Reference

Packet that reports the vocals of a track of a remix section muted or restored. More...

#include <mutevocalspacket.h>

Inheritance diagram for MuteVocalsPacket:
Collaboration diagram for MuteVocalsPacket:

Public Member Functions

 ~MuteVocalsPacket () override=default
 Destroy the object.
 MuteVocalsPacket ()
 Construct a packet with no section and no track.
void * operator new (size_t nSize)
 Allocate a packet, billed to the class name.
void operator delete (void *pBlock)
 Release a packet.
Message * Clone () override
 Produce a heap copy of this packet.
int Type () override
 Report this packet's registered identity.
const char * GetName () const override
 Report this packet's class name.
void PrintExtra (PrnStream &stream) const override
 Write the track and the mute state to a diagnostic stream.
void saveGuts (BinStream &stream) const override
 Write the section, the track, and the mute state packed into one byte.
void restoreGuts (BinStream &stream) override
 Read the byte saveGuts() writes back into the fields.
int GetMute () const
void SetMute (int nMute)
int GetSection () const
void SetSection (int nSection)
int GetTrack () const
void SetTrack (int nTrack)
Public Member Functions inherited from ExternalPacket
 ExternalPacket (unsigned char nFlags=0, int nReceiver=kAllPeers)
 Construct a packet from an unset sender.
int Route () override
 Report that a received packet goes to the sink of TheNetTransport.
Public Member Functions inherited from Packet
void PrintExtra (PrnStream &stream) const override
 Write the sender and the receiver that are set, as from: and to:.
unsigned char GetFlags () const
int GetReceiver () const
int GetSender () const
void SetSender (int nSender)
Public Member Functions inherited from Message
virtual ~Message ()
 Vtable slot 1.
virtual ~Message ()
virtual void Unused1 ()
 Not called by the control.

Static Public Member Functions

static Message * New ()
 Produce a default-constructed packet on the heap.
Static Public Member Functions inherited from Message
static Message * NewMessage (int nType)
 Produce a message of the identified class through the factory list.

Additional Inherited Members

Public Types inherited from Packet
enum  RouteFlag { kRouteTransport = 1 , kRouteLaunchpad = 2 }
 Bits of Route(). More...
Static Public Attributes inherited from Packet
static constexpr int kUnset = -2
 Value of mSender and mReceiver that marks the member as unset.
static constexpr int kAllPeers = -1
 Value of mReceiver that addresses every peer.
static constexpr unsigned char kFlagOrdered = 1
 Bit of mFlags that LaunchpadRT::Send() turns into the second delivery bit of the session library.
static constexpr unsigned char kFlagGuaranteed = 2
 Bit of mFlags that NetTransport::Send() turns into its guaranteed delivery bit.
Protected Member Functions inherited from Packet
 Packet (unsigned char nFlags, int nReceiver)
 Construct a packet from an unset sender.

Detailed Description

Packet that reports the vocals of a track of a remix section muted or restored.

The RTTI records the class as deriving from ExternalPacket. Delivery is guaranteed. The members Clone(), Type(), and GetName() are inline.

Constructor & Destructor Documentation

◆ ~MuteVocalsPacket()

MuteVocalsPacket::~MuteVocalsPacket ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0033c568
Ghidra address:
PAL: 0x003a9aa0

◆ MuteVocalsPacket()

MuteVocalsPacket::MuteVocalsPacket ( )
inline

Construct a packet with no section and no track.

Inline. New() expands it.

Member Function Documentation

◆ New()

Message * MuteVocalsPacket::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x00123378
Ghidra address:
PAL: 0x00124af8

◆ operator new()

void * MuteVocalsPacket::operator new ( size_t nSize)
inline

Allocate a packet, billed to the class name.

Parameters
nSizeThe object size the compiler supplies.
Returns
The block.

◆ operator delete()

void MuteVocalsPacket::operator delete ( void * pBlock)
inline

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * MuteVocalsPacket::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x0033c608
Ghidra address:
PAL: 0x003a9b40

Implements Message.

◆ Type()

int MuteVocalsPacket::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nMuteVocalsPacketType.
Ghidra address:
NTSC-U/C: 0x0033c688
Ghidra address:
PAL: 0x003a9bc0

Implements Message.

◆ GetName()

const char * MuteVocalsPacket::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal MuteVocalsPacket.
Ghidra address:
NTSC-U/C: 0x0033c698
Ghidra address:
PAL: 0x003a9bd0

Implements Message.

◆ PrintExtra()

void MuteVocalsPacket::PrintExtra ( PrnStream & stream) const
overridevirtual

Write the track and the mute state to a diagnostic stream.

Parameters
streamThe stream to write to.
Ghidra address:
NTSC-U/C: 0x00127a38
Ghidra address:
PAL: 0x00129230

Reimplemented from Message.

◆ saveGuts()

void MuteVocalsPacket::saveGuts ( BinStream & stream) const
overridevirtual

Write the section, the track, and the mute state packed into one byte.

The section takes the low four bits, the track the next three, and the mute state the top bit.

Parameters
streamThe stream to write to.
Ghidra address:
NTSC-U/C: 0x00127918
Ghidra address:
PAL: 0x00129128

Reimplemented from Message.

◆ restoreGuts()

void MuteVocalsPacket::restoreGuts ( BinStream & stream)
overridevirtual

Read the byte saveGuts() writes back into the fields.

Parameters
streamThe stream to read from.
Ghidra address:
NTSC-U/C: 0x001279b0
Ghidra address:
PAL: 0x001291b8

Reimplemented from Message.

◆ GetMute()

int MuteVocalsPacket::GetMute ( ) const
inline
Returns
Whether the vocals are muted.

◆ SetMute()

void MuteVocalsPacket::SetMute ( int nMute)
inline
Parameters
nMuteWhether the vocals are muted.

◆ GetSection()

int MuteVocalsPacket::GetSection ( ) const
inline
Returns
The section.

◆ SetSection()

void MuteVocalsPacket::SetSection ( int nSection)
inline
Parameters
nSectionThe section.

◆ GetTrack()

int MuteVocalsPacket::GetTrack ( ) const
inline
Returns
The track.

◆ SetTrack()

void MuteVocalsPacket::SetTrack ( int nTrack)
inline
Parameters
nTrackThe track.

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