Zrythm
a highly automated and intuitive digital audio workstation
Loading...
Searching...
No Matches
ExtPort Struct Reference

External port. More...

#include <dsp/ext_port.h>

Collaboration diagram for ExtPort:

Public Member Functions

MALLOC NONNULL char * ext_port_get_id (ExtPort *ext_port)
 Returns a unique identifier (full name prefixed with backend type).
 
NONNULL char * ext_port_get_friendly_name (ExtPort *self)
 Returns a user-friendly display name (eg, to be used in dropdowns).
 

Data Fields

int schema_version
 
void * jport
 JACK port.
 
char * full_name
 Full port name, used also as ID.
 
char * short_name
 Short port name.
 
char * alias1
 Alias #1 if any.
 
char * alias2
 Alias #2 if any.
 
int num_aliases
 
void * mme_dev
 
unsigned int rtaudio_channel_idx
 RtAudio channel index.
 
char * rtaudio_dev_name
 RtAudio device name.
 
unsigned int rtaudio_id
 RtAudio device index.
 
bool rtaudio_is_input
 Whether the channel is input.
 
bool rtaudio_is_duplex
 
void * rtaudio_dev
 
unsigned int rtmidi_id
 RtMidi port index.
 
void * rtmidi_dev
 
ExtPortType type
 
bool is_midi
 True if MIDI, false if audio.
 
int hw_processor_index
 Index in the HW processor (cache for real-time use)
 
HardwareProcessorhw_processor
 Pointer to owner hardware processor, if any.
 
bool active
 Whether the port is active and receiving events (for use by hw processor).
 
bool pending_reconnect
 Set to true when a hardware port is disconnected.
 
Portport
 Temporary port to receive data.
 

Detailed Description

External port.

Definition at line 76 of file ext_port.h.

Field Documentation

◆ active

bool ExtPort::active

Whether the port is active and receiving events (for use by hw processor).

Definition at line 155 of file ext_port.h.

◆ alias1

char* ExtPort::alias1

Alias #1 if any.

Definition at line 94 of file ext_port.h.

◆ alias2

char* ExtPort::alias2

Alias #2 if any.

Definition at line 97 of file ext_port.h.

◆ full_name

char* ExtPort::full_name

Full port name, used also as ID.

Definition at line 88 of file ext_port.h.

◆ hw_processor

HardwareProcessor* ExtPort::hw_processor

Pointer to owner hardware processor, if any.

Definition at line 151 of file ext_port.h.

◆ hw_processor_index

int ExtPort::hw_processor_index

Index in the HW processor (cache for real-time use)

Definition at line 148 of file ext_port.h.

◆ is_midi

bool ExtPort::is_midi

True if MIDI, false if audio.

Definition at line 144 of file ext_port.h.

◆ jport

void* ExtPort::jport

JACK port.

Definition at line 84 of file ext_port.h.

◆ mme_dev

void* ExtPort::mme_dev

Definition at line 110 of file ext_port.h.

◆ num_aliases

int ExtPort::num_aliases

Definition at line 99 of file ext_port.h.

◆ pending_reconnect

bool ExtPort::pending_reconnect

Set to true when a hardware port is disconnected.

Hardware processor will then attempt to reconnect next scan.

Definition at line 164 of file ext_port.h.

◆ port

Port* ExtPort::port

Temporary port to receive data.

Definition at line 169 of file ext_port.h.

◆ rtaudio_channel_idx

unsigned int ExtPort::rtaudio_channel_idx

RtAudio channel index.

Definition at line 114 of file ext_port.h.

◆ rtaudio_dev

void* ExtPort::rtaudio_dev

Definition at line 129 of file ext_port.h.

◆ rtaudio_dev_name

char* ExtPort::rtaudio_dev_name

RtAudio device name.

Definition at line 117 of file ext_port.h.

◆ rtaudio_id

unsigned int ExtPort::rtaudio_id

RtAudio device index.

Definition at line 120 of file ext_port.h.

◆ rtaudio_is_duplex

bool ExtPort::rtaudio_is_duplex

Definition at line 124 of file ext_port.h.

◆ rtaudio_is_input

bool ExtPort::rtaudio_is_input

Whether the channel is input.

Definition at line 123 of file ext_port.h.

◆ rtmidi_dev

void* ExtPort::rtmidi_dev

Definition at line 138 of file ext_port.h.

◆ rtmidi_id

unsigned int ExtPort::rtmidi_id

RtMidi port index.

Definition at line 133 of file ext_port.h.

◆ schema_version

int ExtPort::schema_version

Definition at line 78 of file ext_port.h.

◆ short_name

char* ExtPort::short_name

Short port name.

Definition at line 91 of file ext_port.h.

◆ type

ExtPortType ExtPort::type

Definition at line 141 of file ext_port.h.


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