Port Struct Reference
Struct defining a port. More...
#include <audioTypes.h>
Public Member Functions | |
| Port (std::string c="user", std::string n="", PortType t=dpyAudio::NA_TYPE) | |
| Port constructor with parameters. More... | |
| std::string | getPortFullName () const |
| Used to obtain port full name , which will be used for different operations. More... | |
| bool | operator< (const Port &rhs) const |
| Overload < operator to use a Port object as a key in a std::map. More... | |
Public Attributes | |
| std::string | client = "user" |
| Client name, "user" will be the default one for user-created ports. | |
| std::string | name = "" |
| Port identifier. | |
| PortType | type = dpyAudio::NA_TYPE |
| Port type. | |
Friends | |
| bool | operator== (const Port &lhs, const Port &rhs) |
| Overload of == operator used for Port struct. More... | |
Detailed Description
- Remarks
- Pay special attention to the name or port identifier. Generally, capture or monitor ports can be used as input ports (origin) and playback ports are ouputs (destination)
Constructor & Destructor Documentation
| Port | ( | std::string | c = "user", |
| std::string | n = "", |
||
| PortType | t = dpyAudio::NA_TYPE |
||
| ) |
- Parameters
-
c Client name, "user" is the default client n Port identifier t Port type
Member Function Documentation
| std::string getPortFullName | ( | ) | const |
- Returns
- port full name string
| bool operator< | ( | const Port & | rhs | ) | const |
- Parameters
-
rhs right hand side operator
- Returns
- true if the current object appears before the specified object
