All Implemented Interfaces:
```
public class IceMediaStream

                    
```
The class represents a media stream from the ICE perspective, i.e. a collection of components.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`public final static String`	`PROPERTY_PAIR_CONSENT_FRESHNESS_CHANGED`
`public final static String`	`PROPERTY_PAIR_NOMINATED`
`public final static String`	`PROPERTY_PAIR_STATE_CHANGED`
`public final static String`	`PROPERTY_PAIR_VALIDATED`
`private final String`	`name`
`private final CheckList`	`checkList`
`private final Agent`	`parentAgent`
`private String`	`remoteUfrag`
`private String`	`remotePassword`
`private Logger`	`logger`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`getName()`	Returns the name of this IceMediaStream.
`CheckList`	`getCheckList()`	Returns the list of CandidatePairs to be used in checks for this stream.
`Agent`	`getParentAgent()`	Returns a reference to the Agent that this stream belongs to.
`String`	`getRemoteUfrag()`	Returns the user name that we received from the remote peer or null if we haven't received a user name from them yet.
`void`	`setRemoteUfrag(String remoteUfrag)`	Specifies the user name that we received from the remote peer.
`String`	`getRemotePassword()`	Returns the password that we received from the remote peer or null if we haven't received a password from them yet.
`void`	`setRemotePassword(String remotePassword)`	Specifies the password that we received from the remote peer.
`Logger`	`getLogger()`
`static IceMediaStream`	`build(Agent parentAgent, String name)`	Use builder pattern to provide an immutable IceMediaStream instance.
`String`	`toString()`	Returns a String representation of this media stream.
`Component`	`getComponent(int id)`	Returns the Component with the specified id or null if no such component exists in this stream.
`int`	`getComponentCount()`	Returns the number of Components currently registered with this stream.
`List<Integer>`	`getComponentIDs()`	Returns the IDs of all Components currently registered with this stream.
`void`	`removeComponent(Component component)`	Removes component and all its Candidates from the this stream and releases all associated resources that they had allocated (like sockets for example)
`LocalCandidate`	`findLocalCandidate(TransportAddress address, LocalCandidate base)`	Returns the local LocalCandidate with the specified address if it belongs to any of this stream's components or null otherwise.
`RemoteCandidate`	`findRemoteCandidate(TransportAddress remoteAddress)`	Returns the local Candidate with the specified remoteAddress if it belongs to any of this stream's s or null if it doesn't.
`CandidatePair`	`findCandidatePair(TransportAddress localAddress, TransportAddress remoteAddress)`	Returns the CandidatePair with the specified remote and local addresses or null if neither of the CheckLists in this stream contain such a pair.
`CandidatePair`	`findCandidatePair(String localUFrag, String remoteUFrag)`	Returns the CandidatePair with the specified remote and local addresses or null if neither of the CheckLists in this stream contain such a pair.
`void`	`addPairChangeListener(PropertyChangeListener l)`	Adds l to the list of listeners registered for property changes if CandidatePairs.
`void`	`removePairStateChangeListener(PropertyChangeListener l)`	Removes l from the list of listeners registered for property changes.

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

- Constructor Detail
- Method Detail
  - getName
```
 String getName()
```
    Returns the name of this IceMediaStream.
  - getCheckList
```
 CheckList getCheckList()
```
    Returns the list of CandidatePairs to be used in checks for this stream.
  - getParentAgent
```
 Agent getParentAgent()
```
    Returns a reference to the Agent that this stream belongs to.
  - getRemoteUfrag
```
 String getRemoteUfrag()
```
    Returns the user name that we received from the remote peer or null if we haven't received a user name from them yet.
  - setRemoteUfrag
```
 void setRemoteUfrag(String remoteUfrag)
```
    Specifies the user name that we received from the remote peer.
    
    Parameters:
    
    remoteUfrag - the user name that we received from the remote peer.
  - getRemotePassword
```
 String getRemotePassword()
```
    Returns the password that we received from the remote peer or null if we haven't received a password from them yet.
  - setRemotePassword
```
 void setRemotePassword(String remotePassword)
```
    Specifies the password that we received from the remote peer.
    
    Parameters:
    
    remotePassword - the user name that we received from the remote peer.
  - getLogger
```
 Logger getLogger()
```
  - build
```
 static IceMediaStream build(Agent parentAgent, String name)
```
    Use builder pattern to provide an immutable IceMediaStream instance.
    
    Parameters:
    
    parentAgent - the agent that is handling the session that this media stream is a part of
    
    name - the name of the media stream
  - toString
```
 String toString()
```
    Returns a String representation of this media stream.
  - getComponent
```
 Component getComponent(int id)
```
    Returns the Component with the specified id or null if no such component exists in this stream.
    
    Parameters:
    
    id - the identifier of the component we are looking for.
  - getComponentCount
```
 int getComponentCount()
```
    Returns the number of Components currently registered with this stream.
  - getComponentIDs
```
 List<Integer> getComponentIDs()
```
    Returns the IDs of all Components currently registered with this stream.
  - removeComponent
```
 void removeComponent(Component component)
```
    Removes component and all its Candidates from the this stream and releases all associated resources that they had allocated (like sockets for example)
    
    Parameters:
    
    component - the Component we'd like to remove and free.
  - findLocalCandidate
```
 LocalCandidate findLocalCandidate(TransportAddress address, LocalCandidate base)
```
    Returns the local LocalCandidate with the specified address if it belongs to any of this stream's components or null otherwise. If base is also specified, tries to find a candidate whose base matches base.
    
    Parameters:
    
    address - the TransportAddress we are looking for.
    
    base - an optional base to match.
  - findRemoteCandidate
```
 RemoteCandidate findRemoteCandidate(TransportAddress remoteAddress)
```
    Returns the local Candidate with the specified remoteAddress if it belongs to any of this stream's s or null if it doesn't.
    
    Parameters:
    
    remoteAddress - the TransportAddress we are looking for.
  - findCandidatePair
```
 CandidatePair findCandidatePair(TransportAddress localAddress, TransportAddress remoteAddress)
```
    Returns the CandidatePair with the specified remote and local addresses or null if neither of the CheckLists in this stream contain such a pair.
    
    Parameters:
    
    localAddress - the local TransportAddress of the pair we are looking for.
    
    remoteAddress - the remote TransportAddress of the pair we are looking for.
  - findCandidatePair
```
 CandidatePair findCandidatePair(String localUFrag, String remoteUFrag)
```
    Returns the CandidatePair with the specified remote and local addresses or null if neither of the CheckLists in this stream contain such a pair.
    
    Parameters:
    
    localUFrag - local user fragment
    
    remoteUFrag - remote user fragment
  - addPairChangeListener
```
 void addPairChangeListener(PropertyChangeListener l)
```
    Adds l to the list of listeners registered for property changes if CandidatePairs. We add such listeners in the stream, rather than having them in the candidate pair itself, because we don't want all pairs to keep lists of references to the same listeners.
    
    Parameters:
    
    l - the listener to register.
  - removePairStateChangeListener
```
 void removePairStateChangeListener(PropertyChangeListener l)
```
    Removes l from the list of listeners registered for property changes.
    
    Parameters:
    
    l - the listener to remove.

Class IceMediaStream

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

getName

getCheckList

getParentAgent

getRemoteUfrag

setRemoteUfrag

getRemotePassword

setRemotePassword

getLogger

build

toString

getComponent

getComponentCount

getComponentIDs

removeComponent

findLocalCandidate

findRemoteCandidate

findCandidatePair

findCandidatePair

addPairChangeListener

removePairStateChangeListener