org.asteriskjava.manager.action

Class MuteAudioAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.MuteAudioAction

All Implemented Interfaces:

Serializable, ManagerAction

public class MuteAudioAction
extends AbstractManagerAction

Action: MuteAudio Synopsis: Mute an audio stream Privilege: system,all Description: Mute an incoming or outbound audio stream in a channel. Variables: Channel: The channel you want to mute. Direction: in | out |all The stream you want to mute. State: on | off Whether to turn mute on or off. ActionID: Optional action ID for this AMI transaction. It is defined in res/res_mutestream.c.

Available since Asterisk 1.8

Since:

1.0.0

Version:

$Id: MuteAction.java 938 2007-12-31 03:23:38Z srt $

Author:

sbs

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MuteAudioAction.Direction The audio direct (relative to the pbx) which is to be muted.
static class	MuteAudioAction.State Controls whether to mute (on) or unmute (off) the call

Constructor Summary

Constructors

Constructor and Description
MuteAudioAction() Creates a new empty MuteAction.
MuteAudioAction(String channel, MuteAudioAction.Direction direction, MuteAudioAction.State state) Creates a new MuteAction that Mutes or Unmutes the two given channel.

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.
MuteAudioAction.Direction	getDirection() Returns the audio direction which is to be muted/unmuted.
MuteAudioAction.State	getState() Returns the state controls whether we are muting or unmuting the channel.
void	setChannel(String channel) Sets the name of the channel to monitor.
void	setDirection(MuteAudioAction.Direction direction) Sets the audio direction which is to be muted/unmuted.
void	setState(MuteAudioAction.State state) Sets the state controls whether we are muting or unmuting the channel.

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

MuteAudioAction

public MuteAudioAction()

Creates a new empty MuteAction.

MuteAudioAction

public MuteAudioAction(String channel,
                       MuteAudioAction.Direction direction,
                       MuteAudioAction.State state)

Creates a new MuteAction that Mutes or Unmutes the two given channel.

Parameters:

channel - the name of the channel to Mute.

direction - the audio direction which is to be muted/unmuted

state - controls whether we are muting or unmuting the channel.

Method Detail

getAction

public String getAction()

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

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getChannel

public String getChannel()

Returns the name of the channel to monitor.

getDirection

public MuteAudioAction.Direction getDirection()

Returns the audio direction which is to be muted/unmuted.

getState

public MuteAudioAction.State getState()

Returns the state controls whether we are muting or unmuting the channel.

setChannel

public void setChannel(String channel)

Sets the name of the channel to monitor.

This property is mandatory.

setDirection

public void setDirection(MuteAudioAction.Direction direction)

Sets the audio direction which is to be muted/unmuted.

This property is mandatory.

setState

public void setState(MuteAudioAction.State state)

Sets the state controls whether we are muting or unmuting the channel.

This property is mandatory.