org.restcomm.media.component

Class AbstractSink

java.lang.Object

org.restcomm.media.component.BaseComponent

org.restcomm.media.component.AbstractSink

All Implemented Interfaces:

Serializable, Component, MediaSink

Direct Known Subclasses:

AudioInput, OOBInput, SoundCard, SpectraAnalyzer

public abstract class AbstractSink
extends BaseComponent
implements MediaSink

The base implementation of the media sink. AbstractSource and AbstractSink are implement general wiring construct. All media components have to extend one of these classes.

Author:

Oifa Yulian

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractSink(String name) Creates new instance of sink with specified name.

Method Summary

Modifier and Type	Method and Description
abstract void	activate()
abstract void	deactivate()
protected void	failed(Exception e) Sends failure notification.
long	getBytesReceived()
long	getPacketsReceived()
boolean	isStarted()
abstract void	onMediaTransfer(Frame frame) This methos is called when new portion of media arrives.
void	perform(Frame frame)
String	report()
void	reset()
protected void	start() (Non Java-doc).
protected void	started() Sends notification that media processing has been started.
protected void	stop() (Non Java-doc).
protected void	stopped() Sends notification that detection is terminated.

Methods inherited from class org.restcomm.media.component.BaseComponent

getId, getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.restcomm.media.Component

getId, getName

Constructor Detail

AbstractSink

public AbstractSink(String name)

Creates new instance of sink with specified name.

Parameters:

name - the name of the sink to be created.

Method Detail

isStarted

public boolean isStarted()

Specified by:

isStarted in interface MediaSink

onMediaTransfer

public abstract void onMediaTransfer(Frame frame)
                              throws IOException

This methos is called when new portion of media arrives.

Parameters:

buffer - the new portion of media data.

Throws:

IOException

start

protected void start()

(Non Java-doc).

See Also:

org.mobicents.media.MediaSink#start().

stop

protected void stop()

(Non Java-doc).

See Also:

org.mobicents.media.MediaSink#stop().

activate

public abstract void activate()

Specified by:

activate in interface Component

deactivate

public abstract void deactivate()

Specified by:

deactivate in interface Component

failed

protected void failed(Exception e)

Sends failure notification.

Parameters:

eventID - failure event identifier.

e - the exception caused failure.

getPacketsReceived

public long getPacketsReceived()

Specified by:

getPacketsReceived in interface MediaSink

getBytesReceived

public long getBytesReceived()

Specified by:

getBytesReceived in interface MediaSink

reset

public void reset()

Specified by:

reset in interface Component

started

protected void started()

Sends notification that media processing has been started.

stopped

protected void stopped()

Sends notification that detection is terminated.

report

public String report()

perform

public void perform(Frame frame)

Specified by:

perform in interface MediaSink