Asterisk-Java

org.asteriskjava.fastagi.command
Class SetMusicOnCommand

java.lang.Object
  extended by org.asteriskjava.fastagi.command.AbstractAgiCommand
      extended by org.asteriskjava.fastagi.command.SetMusicOnCommand
All Implemented Interfaces:
java.io.Serializable, AgiCommand

public class SetMusicOnCommand
extends AbstractAgiCommand

Turns on music on hold on the current channel.

Always returns 0.

Version:
$Id: SetMusicOnCommand.java 938 2007-12-31 03:23:38Z srt $
Author:
srt
See Also:
Serialized Form

Constructor Summary
SetMusicOnCommand()
          Creates a new SetMusicOnCommand playing music from the default music on hold class.
SetMusicOnCommand(java.lang.String musicOnHoldClass)
          Creates a new SetMusicOnCommand playing music from the default music on hold class.
 
Method Summary
 java.lang.String buildCommand()
          Returns a string suitable to be sent to asterisk.
 java.lang.String getMusicOnHoldClass()
          Returns the music on hold class to play music from.
 void setMusicOnHoldClass(java.lang.String musicOnHoldClass)
          Sets the music on hold class to play music from.
 
Methods inherited from class org.asteriskjava.fastagi.command.AbstractAgiCommand
escapeAndQuote, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SetMusicOnCommand

public SetMusicOnCommand()
Creates a new SetMusicOnCommand playing music from the default music on hold class.


SetMusicOnCommand

public SetMusicOnCommand(java.lang.String musicOnHoldClass)
Creates a new SetMusicOnCommand playing music from the default music on hold class.

Parameters:
musicOnHoldClass - the music on hold class to play music from.
Method Detail

getMusicOnHoldClass

public java.lang.String getMusicOnHoldClass()
Returns the music on hold class to play music from.

Returns:
the music on hold class to play music from or null for the default class.

setMusicOnHoldClass

public void setMusicOnHoldClass(java.lang.String musicOnHoldClass)
Sets the music on hold class to play music from.

Parameters:
musicOnHoldClass - the music on hold class to play music from or null for the default class.

buildCommand

public java.lang.String buildCommand()
Description copied from interface: AgiCommand
Returns a string suitable to be sent to asterisk.

Specified by:
buildCommand in interface AgiCommand
Specified by:
buildCommand in class AbstractAgiCommand
Returns:
a string suitable to be sent to asterisk.

Asterisk-Java

Copyright © 2004-2009 Stefan Reuter. All Rights Reserved.