Package org.jivesoftware.smackx.jingleold.mediaimpl.sshare

Class ScreenShareSession

java.lang.Object

org.jivesoftware.smackx.jingleold.media.JingleMediaSession

org.jivesoftware.smackx.jingleold.mediaimpl.sshare.ScreenShareSession

public class ScreenShareSession
extends JingleMediaSession

This Class implements a complete JingleMediaSession. It should be used to transmit and receive captured images from the Display. This Class should be automatically controlled by JingleSession. For better NAT Traversal support this implementation don't support only receive or only transmit. To receive you MUST transmit. So the only implemented and functionally methods are startTransmit() and stopTransmit()

Constructor Summary

Constructors

Constructor	Description
ScreenShareSession(PayloadType payloadType, TransportCandidate remote, TransportCandidate local, java.lang.String locator, JingleSession jingleSession)	Creates a org.jivesoftware.jingleaudio.jmf.AudioMediaSession with defined payload type, remote and local candidates.

Method Summary

Modifier and Type	Method	Description
protected int	getFreePort()	Obtain a free port we can use.
void	initialize()	Initialize the screen share channels.
void	setDecoder(ImageDecoder decoder)
void	setEncoder(ImageEncoder encoder)
void	setTransmit(boolean active)	Set transmit activity.
void	setTrasmit(boolean active)	Deprecated. use setTransmit(boolean) instead.
void	startReceive()	For NAT Reasons this method does nothing.
void	startTransmit()	Starts transmission and for NAT Traversal reasons start receiving also.
void	startTrasmit()	Deprecated. use startTransmit() instead.
void	stopReceive()	For NAT Reasons this method does nothing.
void	stopTransmit()	Stops transmission and for NAT Traversal reasons stop receiving also.
void	stopTrasmit()	Deprecated. use stopTransmit() instead.

Methods inherited from class org.jivesoftware.smackx.jingleold.media.JingleMediaSession

addMediaReceivedListener, getJingleSession, getLocal, getMediaLocator, getPayloadType, getRemote, mediaReceived, removeAllMediaReceivedListener, removeMediaReceivedListener, setMediaLocator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScreenShareSession

public ScreenShareSession(PayloadType payloadType,
                          TransportCandidate remote,
                          TransportCandidate local,
                          java.lang.String locator,
                          JingleSession jingleSession)

Creates a org.jivesoftware.jingleaudio.jmf.AudioMediaSession with defined payload type, remote and local candidates.

Parameters:

payloadType - Payload of the jmf

remote - the remote information. The candidate that the jmf will be sent to.

local - the local information. The candidate that will receive the jmf

locator - media locator

jingleSession - the jingle session.

Method Detail

initialize

public void initialize()

Initialize the screen share channels.

Specified by:

initialize in class JingleMediaSession

startTrasmit

@Deprecated
public void startTrasmit()

Deprecated.

use startTransmit() instead.

Starts transmission and for NAT Traversal reasons start receiving also.

startTransmit

public void startTransmit()

Starts transmission and for NAT Traversal reasons start receiving also.

Specified by:

startTransmit in class JingleMediaSession

setTrasmit

@Deprecated
public void setTrasmit(boolean active)

Deprecated.

use setTransmit(boolean) instead.

Set transmit activity. If the active is true, the instance should transmit. If it is set to false, the instance should pause transmit.

Parameters:

active - active state

setTransmit

public void setTransmit(boolean active)

Set transmit activity. If the active is true, the instance should transmit. If it is set to false, the instance should pause transmit.

Specified by:

setTransmit in class JingleMediaSession

Parameters:

active - active state

startReceive

public void startReceive()

For NAT Reasons this method does nothing. Use startTransmit() to start transmit and receive jmf

Specified by:

startReceive in class JingleMediaSession

stopTrasmit

@Deprecated
public void stopTrasmit()

Deprecated.

use stopTransmit() instead.

Stops transmission and for NAT Traversal reasons stop receiving also.

stopTransmit

public void stopTransmit()

Stops transmission and for NAT Traversal reasons stop receiving also.

Specified by:

stopTransmit in class JingleMediaSession

stopReceive

public void stopReceive()

For NAT Reasons this method does nothing. Use startTransmit() to start transmit and receive jmf

Specified by:

stopReceive in class JingleMediaSession

getFreePort

protected int getFreePort()

Obtain a free port we can use.

Returns:

A free port number.

setEncoder

public void setEncoder(ImageEncoder encoder)

setDecoder

public void setDecoder(ImageDecoder decoder)