org.asteriskjava.manager.action

Class MixMonitorAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.MixMonitorAction

All Implemented Interfaces:

Serializable, ManagerAction

public class MixMonitorAction
extends AbstractManagerAction

Start a MixMonitor on the specified channel. Available since Asterisk 11

See Also:

MixMonitorResponse, StopMixMonitorAction, PauseMixMonitorAction, MixMonitorMuteAction, Serialized Form

Constructor Summary

Constructors

Constructor and Description
MixMonitorAction() Creates a new empty MixMonitorAction
MixMonitorAction(String channel) Creates a new MixMonitorAction that starts monitoring the given channel using a default filename.
MixMonitorAction(String channel, String filename) Creates a new MixMonitorAction that starts monitoring the given channel with the specified filename.
MixMonitorAction(String channel, String filename, String options) Creates a new MixMonitorAction with options that starts monitoring the given channel with the specified filename.
MixMonitorAction(String channel, String filename, String options, String command) Creates a new MixMonitorAction with options that starts monitoring the given channel with the specified filename.

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 Asterisk channel to monitor.
String	getCommand() Get the command to be executed when the MixMonitor recording has ended.
String	getFile() Returns the filename that Asterisk will use when saving the recording.
String	getOptions() Gets the options that are passed to MixMonitor.
void	setChannel(String channel) Sets the name of the Asterisk channel to the given value.
void	setCommand(String command) Sets the command to be executed when the MixMonitor recording has ended.
void	setFile(String filename) Sets the filename that Asterisk will use when saving the recording.
void	setOptions(String options) Sets the options that are passed to MixMonitor.

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

MixMonitorAction

public MixMonitorAction()

Creates a new empty MixMonitorAction

MixMonitorAction

public MixMonitorAction(String channel)

Creates a new MixMonitorAction that starts monitoring the given channel using a default filename.

Parameters:

channel - the name of the channel to monitor

MixMonitorAction

public MixMonitorAction(String channel,
                        String filename)

Creates a new MixMonitorAction that starts monitoring the given channel with the specified filename.

Parameters:

channel - the name of the channel to monitor

filename - the filename to use for the recording

MixMonitorAction

public MixMonitorAction(String channel,
                        String filename,
                        String options)

Creates a new MixMonitorAction with options that starts monitoring the given channel with the specified filename.

Parameters:

channel - the name of the channel to monitor

filename - the filename to use for the recording

options - the MixMonitor options to use when starting the recording

MixMonitorAction

public MixMonitorAction(String channel,
                        String filename,
                        String options,
                        String command)

Creates a new MixMonitorAction with options that starts monitoring the given channel with the specified filename. Also takes a command to execute when the recording has ended. The command option has been available since Asterisk 12

Parameters:

channel - the name of the channel to monitor

filename - the filename to use for the recording

options - the MixMonitor options to use when starting the recording

command - the command to execute when the recording is complete

Method Detail

getAction

public String getAction()

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

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

Returns:

the name of the AMI action that this class implements

getChannel

public String getChannel()

Returns the name of the Asterisk channel to monitor.

Returns:

the Asterisk channel name

setChannel

public void setChannel(String channel)

Sets the name of the Asterisk channel to the given value.

Parameters:

channel - the Asterisk channel name

getFile

public String getFile()

Returns the filename that Asterisk will use when saving the recording.

Returns:

the recording filename

setFile

public void setFile(String filename)

Sets the filename that Asterisk will use when saving the recording.

Parameters:

filename - the recording filename

getOptions

public String getOptions()

Gets the options that are passed to MixMonitor.

Returns:

the MixMonitor options

setOptions

public void setOptions(String options)

Sets the options that are passed to MixMonitor. These should be specified in the same format you would use if you were invoking the MixMonitor dialplan application.

Parameters:

options - the MixMonitor options

getCommand

public String getCommand()

Get the command to be executed when the MixMonitor recording has ended. Available since Asterisk 12

Returns:

the command to execute

setCommand

public void setCommand(String command)

Sets the command to be executed when the MixMonitor recording has ended. Available since Asterisk 12

Parameters:

command - the command to execute