AudioPort Interface Reference

Classes
enum	AudioPortType

Public Member Functions
String	getClient ()
String	getName ()
AudioPortType	getType ()
String	getFullName ()
AudioConnection	connect (AudioPort destinationPort, String connectionId) throws AudioNotAvailableException, AudioLowLevelException
	Creates a connection between two ports, origin port is current port and destination port has to be specified. More...
AudioConnection	connect (AudioPort destinationPort, String connectionId, int priority) throws AudioNotAvailableException, AudioLowLevelException
	Creates a connection between two ports, origin port is current port and destination port has to be specified. More...
AudioConnection	connect (AudioPort destinationPort, String connectionId, int priority, int volume, int gain) throws AudioNotAvailableException, AudioLowLevelException
	Creates a connection between two ports, origin port is current port and destination port has to be specified. More...
void	disconnect (String connectionId) throws AudioNotAvailableException, AudioLowLevelException
	Disconnects two ports, origin port must be the current port and destination port has to be specified. More...
AudioTask	play (String path) throws AudioNotAvailableException, AudioLowLevelException
	Plays a file using this audio port @apiNote Port to be used for playing must be an output port (origin port in a established connection) More...
AudioTask	play (String path, List< AudioConfiguration > configurations) throws AudioNotAvailableException, AudioLowLevelException
	Plays a file using this audio port @apiNote Port to be used for playing must be an output port (origin port in a established connection) More...
AudioTask	record (String path) throws AudioNotAvailableException, AudioLowLevelException
	Record a file using this audio port @apiNote Port to be used for playing must be an output port (origin port in a established connection) More...
AudioTask	record (String path, List< AudioConfiguration > configurations) throws AudioNotAvailableException, AudioLowLevelException
	Record a file using this audio port @apiNote Port to be used for playing must be an output port (origin port in a established connection) More...

Member Function Documentation

connect() [1/3]

AudioConnection connect	(	AudioPort	destinationPort,
		String	connectionId
	)		throws AudioNotAvailableException, AudioLowLevelException

Parameters

destinationPort	destination port to make the connection
connectionId	connection identifier

Returns

Audio connection

Exceptions

AudioNotAvailableException
AudioLowLevelException

connect() [2/3]

AudioConnection connect	(	AudioPort	destinationPort,
		String	connectionId,
		int	priority
	)		throws AudioNotAvailableException, AudioLowLevelException

Parameters

destinationPort	destination port to make the connection
connectionId	connection identifier
priority	connection priority

Returns

Audio connection

Exceptions

AudioNotAvailableException
AudioLowLevelException

connect() [3/3]

AudioConnection connect	(	AudioPort	destinationPort,
		String	connectionId,
		int	priority,
		int	volume,
		int	gain
	)		throws AudioNotAvailableException, AudioLowLevelException

Parameters

destinationPort	destination port to make the connection
connectionId	connection identifier
priority	connection priority
volume	connection volume
gain	connection gain

Returns

Audio connection

Exceptions

AudioNotAvailableException
AudioLowLevelException

disconnect()

void disconnect

(

String

connectionId

)

throws AudioNotAvailableException, AudioLowLevelException

Parameters

connectionId

connection identifier

Returns

Audio connection

Exceptions

AudioNotAvailableException
AudioLowLevelException

play() [1/2]

AudioTask play

(

String

path

)

throws AudioNotAvailableException, AudioLowLevelException

Returns

AudioTask audio task played

Exceptions

AudioNotAvailableException
AudioLowLevelException

play() [2/2]

AudioTask play	(	String	path,
		List< AudioConfiguration >	configurations
	)		throws AudioNotAvailableException, AudioLowLevelException

Returns

AudioTask audio task played

Exceptions

AudioNotAvailableException
AudioLowLevelException

record() [1/2]

AudioTask record

(

String

path

)

throws AudioNotAvailableException, AudioLowLevelException

Returns

AudioTask audio task recorded

Exceptions

AudioNotAvailableException
AudioLowLevelException

record() [2/2]

AudioTask record	(	String	path,
		List< AudioConfiguration >	configurations
	)		throws AudioNotAvailableException, AudioLowLevelException

Returns

AudioTask audio task recorded

Exceptions

AudioNotAvailableException
AudioLowLevelException