net.java.sip.communicator.service.neomedia
Interface VideoMediaStream

All Superinterfaces:

MediaStream

All Known Implementing Classes:

VideoMediaStreamImpl

public interface VideoMediaStream
extends MediaStream

Extends the MediaStream interface and adds methods specific to video streaming.

Author:

Emil Ivov, Lyubomir Marinov

Field Summary

Fields inherited from interface net.java.sip.communicator.service.neomedia.MediaStream

PNAME_LOCAL_SSRC, PNAME_REMOTE_SSRC

Method Summary

void	addVideoListener(VideoListener listener) Adds a specific VideoListener to this VideoMediaStream in order to receive notifications when visual/video Components are being added and removed.
Component	createLocalVisualComponent() Gets local visual Component of the local peer.
void	disposeLocalVisualComponent(Component component) Disposes of a specific local visual Component of the local peer.
KeyFrameControl	getKeyFrameControl() Gets the KeyFrameControl of this VideoMediaStream.
QualityControl	getQualityControl() Gets the QualityControl of this VideoMediaStream.
Component	getVisualComponent() Deprecated.
List<Component>	getVisualComponents() Gets a list of the visual Components where video from the remote peer is being rendered.
void	movePartialDesktopStreaming(int x, int y) Move origin of a partial desktop streaming MediaDevice.
void	removeVideoListener(VideoListener listener) Removes a specific VideoListener from this VideoMediaStream in order to have to no longer receive notifications when visual/video Components are being added and removed.
void	updateQualityControl(Map<String,String> advancedParams) Updates the QualityControl of this VideoMediaStream.

Methods inherited from interface net.java.sip.communicator.service.neomedia.MediaStream

addDynamicRTPPayloadType, addPropertyChangeListener, addRTPExtension, close, getActiveRTPExtensions, getDevice, getDirection, getDynamicRTPPayloadTypes, getFormat, getLocalSourceID, getMediaStreamStats, getName, getRemoteControlAddress, getRemoteDataAddress, getRemoteSourceID, getSrtpControl, getTarget, getTransportProtocol, isMute, isStarted, removePropertyChangeListener, setConnector, setDevice, setDirection, setFormat, setMute, setName, setRTPTranslator, setTarget, start, stop

Method Detail

createLocalVisualComponent

Component createLocalVisualComponent()

Gets local visual Component of the local peer.

Returns:

visual Component

disposeLocalVisualComponent

void disposeLocalVisualComponent(Component component)

Disposes of a specific local visual Component of the local peer.

Parameters:

component - the local visual Component of the local peer to dispose of

getVisualComponent

@Deprecated
Component getVisualComponent()

Deprecated.

Gets the visual Component where video from the remote peer is being rendered or null if no video is currently being rendered.

Returns:

the visual Component where video from the remote peer is being rendered or null if no video is currently being rendered

getVisualComponents

List<Component> getVisualComponents()

Gets a list of the visual Components where video from the remote peer is being rendered.

Returns:

a list of the visual Components where video from the remote peer is being rendered

addVideoListener

void addVideoListener(VideoListener listener)

Adds a specific VideoListener to this VideoMediaStream in order to receive notifications when visual/video Components are being added and removed.

Adding a listener which has already been added does nothing i.e. it is not added more than once and thus does not receive one and the same VideoEvent multiple times

Parameters:

listener - the VideoListener to be notified when visual/video Components are being added or removed in this VideoMediaStream

removeVideoListener

void removeVideoListener(VideoListener listener)

Removes a specific VideoListener from this VideoMediaStream in order to have to no longer receive notifications when visual/video Components are being added and removed.

Parameters:

listener - the VideoListener to no longer be notified when visual/video Components are being added or removed in this VideoMediaStream

getKeyFrameControl

KeyFrameControl getKeyFrameControl()

Gets the KeyFrameControl of this VideoMediaStream.

Returns:

the KeyFrameControl of this VideoMediaStream

getQualityControl

QualityControl getQualityControl()

Gets the QualityControl of this VideoMediaStream.

Returns:

the QualityControl of this VideoMediaStream

updateQualityControl

void updateQualityControl(Map<String,String> advancedParams)

Updates the QualityControl of this VideoMediaStream.

Parameters:

advancedParams - parameters of advanced attributes that may affect quality control

movePartialDesktopStreaming

void movePartialDesktopStreaming(int x,
                                 int y)

Move origin of a partial desktop streaming MediaDevice.

Parameters:

x - new x coordinate origin

y - new y coordinate origin