Umsci
Upmix Spatial Control Interface — OCA/OCP.1 spatial audio utility
Loading...
Searching...
No Matches
UmsciConnectingComponent Class Reference

Fullscreen progress overlay shown while the OCP.1 connection is being established, subscriptions are being set up, or initial values are being read. More...

#include <UmsciConnectingComponent.h>

+ Inheritance diagram for UmsciConnectingComponent:
+ Collaboration diagram for UmsciConnectingComponent:

Public Types

enum  Status {
  Connecting ,
  Subscribing ,
  Reading
}
 Mirrors the subset of DeviceController::State values that this component visualises. The caller maps device states to these. More...
 

Public Member Functions

 UmsciConnectingComponent ()
 
 ~UmsciConnectingComponent () override
 
void setConnectionStatus (Status status)
 Updates the status text label to reflect the current connection phase.
 
void setConnectionParameters (const juce::IPAddress &ip, int port)
 Updates the "connecting to ip:port" description line.
 
void paint (juce::Graphics &g) override
 
void resized () override
 
void lookAndFeelChanged () override
 

Detailed Description

Fullscreen progress overlay shown while the OCP.1 connection is being established, subscriptions are being set up, or initial values are being read.

MainComponent switches to this component (hiding UmsciControlComponent) when DeviceController::onStateChanged reports any state between Connecting and GetValues inclusive. When the device reaches the Connected state this overlay is hidden and the control component is shown.

Displays a JUCE indeterminate ProgressBar and a text description of the current phase plus the target IP:port.

Definition at line 37 of file UmsciConnectingComponent.h.

Member Enumeration Documentation

◆ Status

Mirrors the subset of DeviceController::State values that this component visualises. The caller maps device states to these.

Enumerator
Connecting 

TCP connect in progress.

Subscribing 

AddSubscription commands sent, waiting for ACKs.

Reading 

GetValue responses being collected (DeviceController::GetValues state).

Definition at line 44 of file UmsciConnectingComponent.h.

Constructor & Destructor Documentation

◆ UmsciConnectingComponent()

UmsciConnectingComponent::UmsciConnectingComponent ( )

Definition at line 23 of file UmsciConnectingComponent.cpp.

◆ ~UmsciConnectingComponent()

UmsciConnectingComponent::~UmsciConnectingComponent ( )
override

Definition at line 30 of file UmsciConnectingComponent.cpp.

Member Function Documentation

◆ lookAndFeelChanged()

void UmsciConnectingComponent::lookAndFeelChanged ( )
override

Definition at line 82 of file UmsciConnectingComponent.cpp.

◆ paint()

void UmsciConnectingComponent::paint ( juce::Graphics &  g)
override

Definition at line 60 of file UmsciConnectingComponent.cpp.

◆ resized()

void UmsciConnectingComponent::resized ( )
override

Definition at line 68 of file UmsciConnectingComponent.cpp.

◆ setConnectionParameters()

void UmsciConnectingComponent::setConnectionParameters ( const juce::IPAddress &  ip,
int  port 
)

Updates the "connecting to ip:port" description line.

Definition at line 54 of file UmsciConnectingComponent.cpp.

◆ setConnectionStatus()

void UmsciConnectingComponent::setConnectionStatus ( Status  status)

Updates the status text label to reflect the current connection phase.

Definition at line 34 of file UmsciConnectingComponent.cpp.

References Connecting, Reading, and Subscribing.


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