Port.Info (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.sound.sampled
class Port.Info

java.lang.Object
  javax.sound.sampled.Line.Info
      javax.sound.sampled.Port.Info

Enclosing class:: Port

public static class Port.Info
extends Line.Info

The Port.Info class extends {@link Line.Info} with additional information specific to ports, including the port's name and whether it is a source or a target for its mixer. By definition, a port acts as either a source or a target to its mixer, but not both. (Audio input ports are sources; audio output ports are targets.)

To learn what ports are available, you can retrieve port info objects through the {@link Mixer#getSourceLineInfo getSourceLineInfo} and {@link Mixer#getTargetLineInfo getTargetLineInfo} methods of the Mixer interface. Instances of the Port.Info class may also be constructed and used to obtain lines matching the parameters specified in the Port.Info object.

Field Summary
`static Port.Info`	`COMPACT_DISC` A type of port that gets audio from a CD-ROM drive.
`static Port.Info`	`HEADPHONE` A type of port that sends audio to a headphone jack.
`static Port.Info`	`LINE_IN` A type of port that gets audio from a line-level audio input jack.
`static Port.Info`	`LINE_OUT` A type of port that sends audio to a line-level audio output jack.
`static Port.Info`	`MICROPHONE` A type of port that gets audio from a built-in microphone or a microphone jack.
`static Port.Info`	`SPEAKER` A type of port that sends audio to a built-in speaker or a speaker jack.

Constructor Summary
`Port.Info(Class lineClass, String name, boolean isSource)` Constructs a port's info object from the information given.

Method Summary
`boolean`	`equals(Object obj)` Finalizes the equals method
`String`	`getName()` Obtains the name of the port.
`int`	`hashCode()` Finalizes the hashCode method
`boolean`	`isSource()` Indicates whether the port is a source or a target for its mixer.
`boolean`	`matches(Line.Info info)` Indicates whether this info object specified matches this one.
`String`	`toString()` Provides a `String` representation of the port.

Methods inherited from class javax.sound.sampled.Line.Info
`getLineClass, matches, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

COMPACT_DISC

public static final Port.Info COMPACT_DISC

A type of port that gets audio from a CD-ROM drive.

HEADPHONE

public static final Port.Info HEADPHONE

A type of port that sends audio to a headphone jack.

LINE_IN

public static final Port.Info LINE_IN

A type of port that gets audio from a line-level audio input jack.

LINE_OUT

public static final Port.Info LINE_OUT

A type of port that sends audio to a line-level audio output jack.

MICROPHONE

public static final Port.Info MICROPHONE

A type of port that gets audio from a built-in microphone or a microphone jack.

SPEAKER

public static final Port.Info SPEAKER

A type of port that sends audio to a built-in speaker or a speaker jack.

Constructor Detail

Port.Info

public Port.Info(Class lineClass,
                 String name,
                 boolean isSource)

Constructs a port's info object from the information given. This constructor is typically used by an implementation of Java Sound to describe a supported line.

Parameters:: lineClass - the class of the port described by the info object.; name - the string that names the port; isSource - true if the port is a source port (such as a microphone), false if the port is a target port (such as a speaker).

Method Detail

equals

public final boolean equals(Object obj)

Finalizes the equals method

Overrides:: equals in class Object
Parameters:: obj

getName

public String getName()

Obtains the name of the port.

Returns:: the string that names the port

hashCode

public final int hashCode()

Finalizes the hashCode method

Overrides:: hashCode in class Object

isSource

public boolean isSource()

Indicates whether the port is a source or a target for its mixer.

Returns:: true if the port is a source port (such as a microphone), false if the port is a target port (such as a speaker).

matches

public boolean matches(Line.Info info)

Indicates whether this info object specified matches this one. To match, the match requirements of the superclass must be met and the types must be equal.

Overrides:: matches in class Line.Info
Parameters:: info - the info object for which the match is queried

toString

public final String toString()

Provides a String representation of the port.

Overrides:: toString in class Line.Info
Returns:: a string that describes the port