Umsci
Upmix Spatial Control Interface — OCA/OCP.1 spatial audio utility
Loading...
Searching...
No Matches
DeviceController::RemObjAddr Struct Reference

Two-dimensional address of a remote object on the DS100. More...

#include <DeviceController.h>

Public Member Functions

 RemObjAddr ()
 
 RemObjAddr (const RemObjAddr &rhs)
 
 RemObjAddr (std::int16_t a, std::int16_t b)
 
juce::String toNiceString () const
 
juce::String toString () const
 
bool fromString (const juce::String &commaseparatedStringRepresentation)
 
bool operator== (const RemObjAddr &rhs) const
 
bool operator!= (const RemObjAddr &rhs) const
 
bool operator< (const RemObjAddr &rhs) const
 
bool operator> (const RemObjAddr &rhs) const
 
RemObjAddroperator= (const RemObjAddr &rhs)
 

Static Public Member Functions

static juce::String toString (const std::vector< RemObjAddr > &RemObjAddrs)
 
static RemObjAddr createFromString (const juce::String &commaseparatedStringRepresentation)
 
static std::vector< RemObjAddrcreateFromListString (const juce::String &objectListStringRepresentation)
 

Public Attributes

std::int16_t pri
 Primary index (channel, speaker, group, zone…). 0 = not used.
 
std::int16_t sec
 Secondary index (mapping area, output ch, group…). 0 = not used.
 

Static Public Attributes

static constexpr std::int16_t sc_INV = 0
 

Detailed Description

Two-dimensional address of a remote object on the DS100.

Most DS100 OCA objects are indexed by one or two integers:

  • pri (primary) — channel number, typically 1-based. For matrix inputs this is the sound-object/input-channel index (1–128). For matrix outputs this is the output/speaker index (1–64). For function groups / reverb zones this is the group/zone index.
  • sec (secondary / record) — used only where a second dimension exists: mapping area index (1–4) for CoordinateMapping objects, output channel for MatrixNode (cross-point) objects, function-group index for SoundObjectRouting objects.

When a dimension is unused, the field is set to sc_INV (== 0), which is the "invalid / not applicable" sentinel.

Definition at line 182 of file DeviceController.h.

Constructor & Destructor Documentation

◆ RemObjAddr() [1/3]

DeviceController::RemObjAddr::RemObjAddr ( )
inline

Definition at line 189 of file DeviceController.h.

References pri, sc_INV, and sec.

Referenced by createFromString().

◆ RemObjAddr() [2/3]

DeviceController::RemObjAddr::RemObjAddr ( const RemObjAddr rhs)
inline

Definition at line 194 of file DeviceController.h.

◆ RemObjAddr() [3/3]

DeviceController::RemObjAddr::RemObjAddr ( std::int16_t  a,
std::int16_t  b 
)
inline

Definition at line 198 of file DeviceController.h.

References pri, and sec.

Member Function Documentation

◆ createFromListString()

static std::vector< RemObjAddr > DeviceController::RemObjAddr::createFromListString ( const juce::String &  objectListStringRepresentation)
inlinestatic

Definition at line 248 of file DeviceController.h.

References createFromString().

◆ createFromString()

static RemObjAddr DeviceController::RemObjAddr::createFromString ( const juce::String &  commaseparatedStringRepresentation)
inlinestatic

Definition at line 239 of file DeviceController.h.

References RemObjAddr().

Referenced by createFromListString().

◆ fromString()

bool DeviceController::RemObjAddr::fromString ( const juce::String &  commaseparatedStringRepresentation)
inline

Definition at line 227 of file DeviceController.h.

References pri, and sec.

◆ operator!=()

bool DeviceController::RemObjAddr::operator!= ( const RemObjAddr rhs) const
inline

Definition at line 264 of file DeviceController.h.

◆ operator<()

bool DeviceController::RemObjAddr::operator< ( const RemObjAddr rhs) const
inline

Definition at line 268 of file DeviceController.h.

References pri, and sec.

◆ operator=()

RemObjAddr & DeviceController::RemObjAddr::operator= ( const RemObjAddr rhs)
inline

Definition at line 277 of file DeviceController.h.

References pri, and sec.

◆ operator==()

bool DeviceController::RemObjAddr::operator== ( const RemObjAddr rhs) const
inline

Definition at line 260 of file DeviceController.h.

References pri, and sec.

◆ operator>()

bool DeviceController::RemObjAddr::operator> ( const RemObjAddr rhs) const
inline

Definition at line 272 of file DeviceController.h.

◆ toNiceString()

juce::String DeviceController::RemObjAddr::toNiceString ( ) const
inline

Definition at line 203 of file DeviceController.h.

References pri, sc_INV, and sec.

Referenced by DeviceController::SetObjectValue().

◆ toString() [1/2]

juce::String DeviceController::RemObjAddr::toString ( ) const
inline

Definition at line 214 of file DeviceController.h.

References pri, and sec.

◆ toString() [2/2]

static juce::String DeviceController::RemObjAddr::toString ( const std::vector< RemObjAddr > &  RemObjAddrs)
inlinestatic

Definition at line 218 of file DeviceController.h.

Member Data Documentation

◆ pri

std::int16_t DeviceController::RemObjAddr::pri

Primary index (channel, speaker, group, zone…). 0 = not used.

Definition at line 184 of file DeviceController.h.

Referenced by fromString(), operator<(), operator=(), operator==(), RemObjAddr(), RemObjAddr(), DeviceController::SetObjectValue(), toNiceString(), and toString().

◆ sc_INV

constexpr std::int16_t DeviceController::RemObjAddr::sc_INV = 0
staticconstexpr

◆ sec

std::int16_t DeviceController::RemObjAddr::sec

Secondary index (mapping area, output ch, group…). 0 = not used.

Definition at line 185 of file DeviceController.h.

Referenced by fromString(), operator<(), operator=(), operator==(), RemObjAddr(), RemObjAddr(), toNiceString(), and toString().


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