org.rocstreaming.roctoolkit

Enum Interface

java.lang.Object

java.lang.Enum<Interface>

org.rocstreaming.roctoolkit.Interface

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Interface>

public enum Interface
extends java.lang.Enum<Interface>

Network interface.

Interface is a way to access the peer (sender or receiver) via network.

Each peer slot has multiple interfaces, one of each type. The user interconnects peers by binding one of the first peer's interfaces to an URI and then connecting the corresponding second peer's interface to that URI.

A URI is represented by Endpoint object.

The interface defines the type of the communication with the remote peer and the set of protocols (URI schemes) that can be used with this particular interface.

CONSOLIDATED is an interface for high-level protocols which automatically manage all necessary communication: transport streams, control messages, parameter negotiation, etc. When a consolidated connection is established, peers may automatically setup lower-level interfaces like AUDIO_SOURCE, AUDIO_REPAIR, and AUDIO_CONTROL.

CONSOLIDATED is mutually exclusive with lower-level interfaces. In most cases, the user needs only CONSOLIDATED. However, the lower-level interfaces may be useful if an external signaling mechanism is used or for compatibility with third-party software.

AUDIO_SOURCE and AUDIO_REPAIR are lower-level unidirectional transport-only interfaces. The first is used to transmit audio stream, and the second is used to transmit redundant repair stream, if FEC is enabled.

AUDIO_CONTROL is a lower-level interface for control streams. If you use AUDIO_SOURCE and AUDIO_REPAIR, you usually also need to use AUDIO_CONTROL to enable carrying additional non-transport information.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUDIO_CONTROL Interface for audio control messages.
AUDIO_REPAIR Interface for audio stream repair data.
AUDIO_SOURCE Interface for audio stream source data.
CONSOLIDATED Interface that consolidates all types of streams (source, repair, control).

Method Summary

Modifier and Type	Method and Description
static Interface	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Interface[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONSOLIDATED

public static final Interface CONSOLIDATED

Interface that consolidates all types of streams (source, repair, control).

Allowed operations: - bind (sender, receiver) - connect (sender, receiver)

Allowed protocols: - RTSP

AUDIO_SOURCE

public static final Interface AUDIO_SOURCE

Interface for audio stream source data.

Allowed operations: - bind (receiver) - connect (sender)

Allowed protocols: - RTP - RTP_RS8M_SOURCE - RTP_LDPC_SOURCE

AUDIO_REPAIR

public static final Interface AUDIO_REPAIR

Interface for audio stream repair data.

Allowed operations: - bind (receiver) - connect (sender)

Allowed protocols: - RS8M_REPAIR - LDPC_REPAIR

AUDIO_CONTROL

public static final Interface AUDIO_CONTROL

Interface for audio control messages.

Allowed operations: - bind (sender, receiver) - connect (sender, receiver)

Allowed protocols: - RTCP

Method Detail

values

public static Interface[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Interface c : Interface.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Interface valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null