org.asteriskjava.manager.action

Class MonitorAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.MonitorAction

All Implemented Interfaces:

Serializable, ManagerAction

public class MonitorAction
extends AbstractManagerAction

The MonitorAction starts monitoring (recording) a channel.

It is implemented in res/res_monitor.c

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MonitorAction() Creates a new empty MonitorAction.
MonitorAction(String channel, String file) Creates a new MonitorAction that starts monitoring the given channel and writes voice data to the given files.
MonitorAction(String channel, String file, String format) Creates a new MonitorAction that starts monitoring the given channel and writes voice data to the given files.
MonitorAction(String channel, String file, String format, Boolean mix) Creates a new MonitorAction that starts monitoring the given channel and writes voice data to the given file(s).

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of this action, i.e.
String	getChannel() Returns the name of the channel to monitor.
String	getFile() Returns the name of the file to which the voice data is written.
String	getFormat() Returns the format to use for encoding the voice files.
Boolean	getMix() Returns true if the two voice files should be joined at the end of the call.
void	setChannel(String channel) Sets the name of the channel to monitor.
void	setFile(String file) Sets the (base) name of the file(s) to which the voice data is written.
void	setFormat(String format) Sets the format to use for encoding the voice files.
void	setMix(Boolean mix) Set to true if the two voice files should be joined at the end of the call.

Methods inherited from class org.asteriskjava.manager.action.AbstractManagerAction

getActionId, setActionId, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MonitorAction

public MonitorAction()

Creates a new empty MonitorAction.

MonitorAction

public MonitorAction(String channel,
                     String file)

Creates a new MonitorAction that starts monitoring the given channel and writes voice data to the given files.

The format of the files is "wav", they are not mixed.

Parameters:

channel - the name of the channel to monitor

file - the (base) name of the files to which the voice data is written

Since:

0.2

MonitorAction

public MonitorAction(String channel,
                     String file,
                     String format)

Creates a new MonitorAction that starts monitoring the given channel and writes voice data to the given files.

The files are not mixed.

Parameters:

channel - the name of the channel to monitor

file - the (base) name of the files to which the voice data is written

format - the format to use for encoding the voice files

Since:

0.2

MonitorAction

public MonitorAction(String channel,
                     String file,
                     String format,
                     Boolean mix)

Creates a new MonitorAction that starts monitoring the given channel and writes voice data to the given file(s).

Parameters:

channel - the name of the channel to monitor

file - the (base) name of the file(s) to which the voice data is written

format - the format to use for encoding the voice files

mix - true if the two voice files should be joined at the end of the call

Since:

0.2

Method Detail

getAction

public String getAction()

Returns the name of this action, i.e. "Monitor".

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getChannel

public String getChannel()

Returns the name of the channel to monitor.

setChannel

public void setChannel(String channel)

Sets the name of the channel to monitor.

This property is mandatory.

getFile

public String getFile()

Returns the name of the file to which the voice data is written.

setFile

public void setFile(String file)

Sets the (base) name of the file(s) to which the voice data is written.

If this property is not set it defaults to to the channel name as per CLI with the '/' replaced by '-'.

getFormat

public String getFormat()

Returns the format to use for encoding the voice files.

setFormat

public void setFormat(String format)

Sets the format to use for encoding the voice files.

If this property is not set it defaults to "wav".

getMix

public Boolean getMix()

Returns true if the two voice files should be joined at the end of the call.

setMix

public void setMix(Boolean mix)

Set to true if the two voice files should be joined at the end of the call.