uk.co.caprica.vlcj.player

Class AudioOutput

java.lang.Object

uk.co.caprica.vlcj.player.AudioOutput

All Implemented Interfaces:

Iterable<AudioDevice>

public class AudioOutput
extends Object
implements Iterable<AudioDevice>

Description of an audio output.

An audio output has zero or more associated audio devices. Each device has a unique identifier than can be used to select the required output device for a media player.

Constructor Summary

Constructors

Constructor and Description
AudioOutput(String name, String description, List<AudioDevice> devices) Create an audio output.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Get the description.
List<AudioDevice>	getDevices() Get the collection of audio devices for this output.
String	getName() Get the name.
Iterator<AudioDevice>	iterator()
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AudioOutput

public AudioOutput(String name,
                   String description,
                   List<AudioDevice> devices)

Create an audio output.

Parameters:

name - name

description - description

devices - collection of audio devices for this output

Method Detail

getName

public String getName()

Get the name.

Returns:

name

getDescription

public String getDescription()

Get the description.

Returns:

description

getDevices

public List<AudioDevice> getDevices()

Get the collection of audio devices for this output.

Returns:

audio devices

toString

public String toString()

Overrides:

toString in class Object

iterator

public Iterator<AudioDevice> iterator()

Specified by:

iterator in interface Iterable<AudioDevice>