Asterisk-Java

org.asteriskjava.fastagi.command
Class SendImageCommand

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

public class SendImageCommand
extends AbstractAgiCommand

Sends the given image on a channel.

Most channels do not support the transmission of images.

Returns 0 if image is sent, or if the channel does not support image transmission. Returns -1 only on error/hangup.

Image names should not include extensions.

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

Constructor Summary
SendImageCommand(java.lang.String image)
          Creates a new SendImageCommand.
 
Method Summary
 java.lang.String buildCommand()
          Returns a string suitable to be sent to asterisk.
 java.lang.String getImage()
          Returns the image to send.
 void setImage(java.lang.String image)
          Sets the image to send.
 
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

SendImageCommand

public SendImageCommand(java.lang.String image)
Creates a new SendImageCommand.

Parameters:
image - the image to send, should not include extension.
Method Detail

getImage

public java.lang.String getImage()
Returns the image to send.

Returns:
the image to send.

setImage

public void setImage(java.lang.String image)
Sets the image to send.

Parameters:
image - the image to send, should not include extension.

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.