org.ow2.isac.plugin.rtpinjector

Class SessionObject

java.lang.Object

org.ow2.isac.plugin.rtpinjector.SessionObject

All Implemented Interfaces:

ControlAction, DataProvider, SampleAction, SessionObjectAction, TestAction

public class SessionObject
extends Object
implements SessionObjectAction, DataProvider, TestAction, ControlAction, SampleAction

Implementation of a session object for plugin ~RtpInjector~

Author:

Rémi Druilhe

Field Summary

Fields

Modifier and Type	Field and Description
RTPListener	rtpListener
RTPStats	rtpStats

Constructor Summary

Constructors

Constructor and Description
SessionObject(Hashtable<String,String> params) Constructor for specimen object.

Method Summary

Modifier and Type	Method and Description
void	addApp(Map params) Add a APP packet to the RTCP template.
void	addBye(Map params) Add a BYE packet to the RTCP template.
void	addReport(Map params) Add a report packet to the RTCP template.
void	addSdes(Map params) Add a SDES packet to the RTCP template.
void	close()
Object	createNewSessionObject()
byte[]	createRtpDtmf(String key, int volume, int duration, int end) Create DTMF packet over RTP using RFC 4733/2833.
void	doControl(int number, Map params)
String	doGet(String var)
ActionEvent	doSample(int number, Map params, ActionEvent report)
boolean	doTest(int number, Map params)
void	dtmf(Map params) Send a DTMF packet over RTP.
void	enableRtcp(Map params) Enable RTCP packets in the RTP stream.
void	forwardStream(Map params) Forward a stream.
void	initRtp(Map params) Initialize the RTP Stream.
boolean	isNotRtcpBye(RTPInstance myInstance)
boolean	isRtcpBye(RTPInstance myInstance)
void	reset()
void	resetRtcp(Map params) Reset RTCP template and disable RTCP.
void	sendBye(Map params) Send a RTCP BYE packet.
void	sendFile(Map params) Send a file.
void	sendReceiverReport(Map params) Send a receiver report packet.

Methods inherited from class java.lang.Object

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

Field Detail

rtpListener

public RTPListener rtpListener

rtpStats

public RTPStats rtpStats

Constructor Detail

SessionObject

public SessionObject(Hashtable<String,String> params)

Constructor for specimen object.

Parameters:

params - key-value pairs for plugin parameters

Method Detail

createNewSessionObject

public Object createNewSessionObject()

Specified by:

createNewSessionObject in interface SessionObjectAction

See Also:

SessionObjectAction.createNewSessionObject()

close

public void close()

Specified by:

close in interface SessionObjectAction

See Also:

SessionObjectAction.close()

reset

public void reset()

Specified by:

reset in interface SessionObjectAction

See Also:

SessionObjectAction.reset()

doGet

public String doGet(String var)

Specified by:

doGet in interface DataProvider

See Also:

org.ow2.clif.scenario.isac.plugin.DataProvider#doGet()

doTest

public boolean doTest(int number,
                      Map params)

Specified by:

doTest in interface TestAction

See Also:

org.ow2.clif.scenario.isac.plugin.TestAction#doTest()

isRtcpBye

public boolean isRtcpBye(RTPInstance myInstance)

isNotRtcpBye

public boolean isNotRtcpBye(RTPInstance myInstance)

doControl

public void doControl(int number,
                      Map params)

Specified by:

doControl in interface ControlAction

See Also:

org.ow2.clif.scenario.isac.plugin.ControlAction#doControl()

initRtp

public void initRtp(Map params)

Initialize the RTP Stream.

Parameters:

params - : A map of the parameters of the control action.

sendFile

public void sendFile(Map params)

Send a file.

Parameters:

params - : A map of the parameters of the control action.

forwardStream

public void forwardStream(Map params)

Forward a stream.

Parameters:

params - : A map of the parameters of the control action.

dtmf

public void dtmf(Map params)

Send a DTMF packet over RTP.

Parameters:

params - : A map of the parameters of the control action.

createRtpDtmf

public byte[] createRtpDtmf(String key,
                            int volume,
                            int duration,
                            int end)

Create DTMF packet over RTP using RFC 4733/2833.

Parameters:

key - : the digit to generate DTMF.

volume - : the volume of the DTMF.

duration - : the duration of the packet.

end - : if it is the end of the DTMF (Marker = 1 in the RTP packet).

Returns:

DTMF data for RTP packet.

enableRtcp

public void enableRtcp(Map params)

Enable RTCP packets in the RTP stream.

Parameters:

params - : A map of the parameters of the control action.

addReport

public void addReport(Map params)

Add a report packet to the RTCP template.

Parameters:

params -

params - : A map of the parameters of the control action.

addSdes

public void addSdes(Map params)

Add a SDES packet to the RTCP template.

Parameters:

params - : A map of the parameters of the control action.

addBye

public void addBye(Map params)

Add a BYE packet to the RTCP template.

Parameters:

params - : A map of the parameters of the control action.

addApp

public void addApp(Map params)

Add a APP packet to the RTCP template.

Parameters:

params - : A map of the parameters of the control action.

resetRtcp

public void resetRtcp(Map params)

Reset RTCP template and disable RTCP.

Parameters:

params -

params - : A map of the parameters of the control action.

sendBye

public void sendBye(Map params)

Send a RTCP BYE packet.

Parameters:

params - : A map of the parameters of the control action.

sendReceiverReport

public void sendReceiverReport(Map params)

Send a receiver report packet.

Parameters:

params -

params - : A map of the parameters of the control action.

doSample

public ActionEvent doSample(int number,
                            Map params,
                            ActionEvent report)

Specified by:

doSample in interface SampleAction

See Also:

org.ow2.clif.scenario.isac.plugin.SampleAction#doSample()