net.sf.jack4j
Class JackPort

java.lang.Object
  net.sf.jack4j.JackPort

Direct Known Subclasses:

JackLocalPort

public class JackPort
extends java.lang.Object

Jack port.

Author:

repa

Method Summary

void	ensureMonitor(boolean on) If the port can be monitored, this method, turns on input monitoring if it was off, and turns it off if only one request has been made to turn it on; otherwise, it does nothing.
int	getLatency() Returns port latency.
int	getPortFlags() Returns current port flags, packed as int.
java.util.EnumSet<JackPortFlag>	getPortFlagSet() Returns current port flags, as reported by Jack API.
long	getPortHandle() Returns the pointer to C jack_port_t structure, represented as long.
java.lang.String	getPortName() Returns the full name (including 'client_name:' prefix) of this port.
java.lang.String	getPortShortName() Returns the short name (not including 'client_name:' prefix) of this port.
java.lang.String	getPortType() Returns port type.
boolean	isInput() Returns true if this is an input port.
boolean	isMonitorable() Returns true if this port can be monitored.
boolean	isOutput() Returns true if this is an output port.
boolean	isPhysical() Returns true if this port is physical.
boolean	isTerminal() Returns true if this port is terminal.
boolean	monitoringInput() Returns true if input monitoring was requested for this port.
void	requestMonitor(boolean on) If the port can be monitored, sets monitoring on or off.
void	setLatency(int latency) Sets port latency.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getPortShortName

public java.lang.String getPortShortName()
                                  throws JackException

Returns the short name (not including 'client_name:' prefix) of this port.

Throws:

JackException

getPortName

public java.lang.String getPortName()
                             throws JackException

Returns the full name (including 'client_name:' prefix) of this port.

Throws:

JackException

getPortType

public java.lang.String getPortType()
                             throws JackException

Returns port type.

Throws:

JackException

isInput

public boolean isInput()
                throws JackException

Returns true if this is an input port.

Throws:

JackException

isOutput

public boolean isOutput()
                 throws JackException

Returns true if this is an output port.

Throws:

JackException

isPhysical

public boolean isPhysical()
                   throws JackException

Returns true if this port is physical.

Throws:

JackException

isMonitorable

public boolean isMonitorable()
                      throws JackException

Returns true if this port can be monitored.

Throws:

JackException

isTerminal

public boolean isTerminal()
                   throws JackException

Returns true if this port is terminal.

Throws:

JackException

getPortHandle

public long getPortHandle()

Returns the pointer to C jack_port_t structure, represented as long.

getPortFlagSet

public java.util.EnumSet<JackPortFlag> getPortFlagSet()
                                               throws JackException

Returns current port flags, as reported by Jack API.

Throws:

JackException

getPortFlags

public int getPortFlags()
                 throws JackException

Returns current port flags, packed as int.

Throws:

JackException

getLatency

public int getLatency()
               throws JackException

Returns port latency.

Throws:

JackException

setLatency

public void setLatency(int latency)
                throws JackException

Sets port latency.

Throws:

JackException

requestMonitor

public void requestMonitor(boolean on)
                    throws JackException

If the port can be monitored, sets monitoring on or off.

Throws:

JackException

ensureMonitor

public void ensureMonitor(boolean on)
                   throws JackException

If the port can be monitored, this method, turns on input monitoring if it was off, and turns it off if only one request has been made to turn it on; otherwise, it does nothing.

Throws:

JackException

monitoringInput

public boolean monitoringInput()
                        throws JackException

Returns true if input monitoring was requested for this port.

Throws:

JackException