org.asteriskjava.manager.event

Class MusicOnHoldEvent

java.lang.Object

java.util.EventObject

org.asteriskjava.manager.event.ManagerEvent

org.asteriskjava.manager.event.MusicOnHoldEvent

All Implemented Interfaces:

Serializable

public class MusicOnHoldEvent
extends ManagerEvent

A MusicOnHoldEvent is triggered when music on hold starts or stops on a channel.

It is implemented in res/res_musiconhold.c.

Available since Asterisk 1.6

Since:

1.0.0

Author:

srt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	STATE_START
static String	STATE_STOP

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
MusicOnHoldEvent(Object source)

Method Summary

Modifier and Type	Method and Description
String	getChannel() Returns the name of the channel.
String	getClassName()
String	getState() Returns the state.
String	getUniqueId() Returns the unique id of the channel.
boolean	isStart() Returns whether this is a start event.
boolean	isStop() Returns whether this is a stop event.
void	setChannel(String channel) Sets the name of the channel.
void	setClassName(String className)
void	setState(String state)
void	setUniqueId(String uniqueId) Sets the unique id of the channel.

Methods inherited from class org.asteriskjava.manager.event.ManagerEvent

appendPropertyIfNotNull, getDateReceived, getFile, getFunc, getLine, getPrivilege, getSequenceNumber, getServer, getTimestamp, setDateReceived, setFile, setFunc, setLine, setPrivilege, setSequenceNumber, setServer, setTimestamp, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

STATE_START

public static final String STATE_START

See Also:

Constant Field Values

STATE_STOP

public static final String STATE_STOP

See Also:

Constant Field Values

Constructor Detail

MusicOnHoldEvent

public MusicOnHoldEvent(Object source)

Method Detail

getChannel

public String getChannel()

Returns the name of the channel.

Returns:

channel the name of the channel.

setChannel

public void setChannel(String channel)

Sets the name of the channel.

Parameters:

channel - the name of the channel.

getUniqueId

public String getUniqueId()

Returns the unique id of the channel.

Returns:

the unique id of the channel.

setUniqueId

public void setUniqueId(String uniqueId)

Sets the unique id of the channel.

Parameters:

uniqueId - the unique id of the channel.

getState

public String getState()

Returns the state. This is either "Start" or "Stop" depending on whether music on hold started or stopped on the channel.

Returns:

"Start" if music on hold started or "Stop" if music on hold stopped on the channel.

See Also:

STATE_START, STATE_STOP, isStart(), isStop()

setState

public void setState(String state)

isStart

public boolean isStart()

Returns whether this is a start event.

Returns:

true if this a start event, false otherwise.

isStop

public boolean isStop()

Returns whether this is a stop event.

Returns:

true if this an stop event, false otherwise.

getClassName

public String getClassName()

Returns:

The music on hold class name.

Since:

1.0.0

setClassName

public void setClassName(String className)