📄 recordfilecommand.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!--NewPage--><HTML><HEAD><!-- Generated by javadoc (build 1.6.0_02) on Wed Sep 05 17:57:26 CEST 2007 --><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><TITLE>RecordFileCommand (Asterisk-Java 0.3.1 API)</TITLE><META NAME="date" CONTENT="2007-09-05"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ if (location.href.indexOf('is-external=true') == -1) { parent.document.title="RecordFileCommand (Asterisk-Java 0.3.1 API)"; }}</SCRIPT><NOSCRIPT></NOSCRIPT></HEAD><BODY BGCOLOR="white" onload="windowTitle();"><HR><!-- ========= START OF TOP NAVBAR ======= --><A NAME="navbar_top"><!-- --></A><A HREF="#skip-navbar_top" title="Skip navigation links"></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""><TR><TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><A NAME="navbar_top_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/RecordFileCommand.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR></TABLE></TD><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>Asterisk-Java</EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../org/asteriskjava/fastagi/command/ReceiveTextCommand.html" title="class in org.asteriskjava.fastagi.command"><B>PREV CLASS</B></A> <A HREF="../../../../org/asteriskjava/fastagi/command/SayAlphaCommand.html" title="class in org.asteriskjava.fastagi.command"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?org/asteriskjava/fastagi/command/RecordFileCommand.html" target="_top"><B>FRAMES</B></A> <A HREF="RecordFileCommand.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--></SCRIPT><NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A></NOSCRIPT></FONT></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><A NAME="skip-navbar_top"></A><!-- ========= END OF TOP NAVBAR ========= --><HR><!-- ======== START OF CLASS DATA ======== --><H2><FONT SIZE="-1">org.asteriskjava.fastagi.command</FONT><BR>Class RecordFileCommand</H2><PRE>java.lang.Object <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/asteriskjava/fastagi/command/AbstractAgiCommand.html" title="class in org.asteriskjava.fastagi.command">org.asteriskjava.fastagi.command.AbstractAgiCommand</A> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.asteriskjava.fastagi.command.RecordFileCommand</B></PRE><DL><DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, <A HREF="../../../../org/asteriskjava/fastagi/command/AgiCommand.html" title="interface in org.asteriskjava.fastagi.command">AgiCommand</A></DD></DL><HR><DL><DT><PRE>public class <B>RecordFileCommand</B><DT>extends <A HREF="../../../../org/asteriskjava/fastagi/command/AbstractAgiCommand.html" title="class in org.asteriskjava.fastagi.command">AbstractAgiCommand</A></DL></PRE><P>Record to a file until a given dtmf digit in the sequence is received. <p> Returns -1 on hangup or error. <p> The format will specify what kind of file will be recorded. The timeout is the maximum record time in milliseconds, or -1 for no timeout. Offset samples is optional, and if provided will seek to the offset without exceeding the end of the file. "maxSilence" is the number of seconds of maxSilence allowed before the function returns despite the lack of dtmf digits or reaching timeout.<P><P><DL><DT><B>Version:</B></DT> <DD>$Id: RecordFileCommand.java 729 2007-05-26 05:16:57Z sprior $</DD><DT><B>Author:</B></DT> <DD>srt</DD><DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.asteriskjava.fastagi.command.RecordFileCommand">Serialized Form</A></DL><HR><P><!-- ======== CONSTRUCTOR SUMMARY ======== --><A NAME="constructor_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Constructor Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/RecordFileCommand.html#RecordFileCommand(java.lang.String, java.lang.String, java.lang.String, int)">RecordFileCommand</A></B>(java.lang.String file, java.lang.String format, java.lang.String escapeDigits, int timeout)</CODE><BR> Creates a new RecordFileCommand.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/RecordFileCommand.html#RecordFileCommand(java.lang.String, java.lang.String, java.lang.String, int, int, boolean, int)">RecordFileCommand</A></B>(java.lang.String file, java.lang.String format, java.lang.String escapeDigits, int timeout, int offset, boolean beep, int maxSilence)</CODE><BR> Creates a new RecordFileCommand.</TD></TR></TABLE> <!-- ========== METHOD SUMMARY =========== --><A NAME="method_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Method Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/RecordFileCommand.html#buildCommand()">buildCommand</A></B>()</CODE><BR> Returns a string suitable to be sent to asterisk.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/RecordFileCommand.html#getBeep()">getBeep</A></B>()</CODE><BR> Returns <code>true</code> if a beep should be played before recording.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/RecordFileCommand.html#getEscapeDigits()">getEscapeDigits</A></B>()</CODE><BR> Returns the digits that allow the user to end recording.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/RecordFileCommand.html#getFile()">getFile</A></B>()</CODE><BR> Returns the name of the file to stream.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/RecordFileCommand.html#getFormat()">getFormat</A></B>()</CODE><BR> Returns the format of the file to be recorded, for example "wav".</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/RecordFileCommand.html#getOffset()">getOffset</A></B>()</CODE><BR> Returns the offset samples to skip.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/RecordFileCommand.html#getTimeout()">getTimeout</A></B>()</CODE><BR> Returns the maximum record time in milliseconds.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/RecordFileCommand.html#setBeep(boolean)">setBeep</A></B>(boolean beep)</CODE><BR> Set to <code>true</code> to play a beep before recording.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/RecordFileCommand.html#setEscapeDigits(java.lang.String)">setEscapeDigits</A></B>(java.lang.String escapeDigits)</CODE><BR> Sets the digits that allow the user to end recording.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/RecordFileCommand.html#setFile(java.lang.String)">setFile</A></B>(java.lang.String file)</CODE><BR> Sets the name of the file to stream.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/RecordFileCommand.html#setFormat(java.lang.String)">setFormat</A></B>(java.lang.String format)</CODE><BR> Sets the format of the file to be recorded, for example "wav".</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/RecordFileCommand.html#setOffset(int)">setOffset</A></B>(int offset)</CODE><BR> Sets the offset samples to skip.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/asteriskjava/fastagi/command/RecordFileCommand.html#setTimeout(int)">setTimeout</A></B>(int timeout)</CODE><BR> Sets the maximum record time in milliseconds.</TD></TR></TABLE> <A NAME="methods_inherited_from_class_org.asteriskjava.fastagi.command.AbstractAgiCommand"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"><TH ALIGN="left"><B>Methods inherited from class org.asteriskjava.fastagi.command.<A HREF="../../../../org/asteriskjava/fastagi/command/AbstractAgiCommand.html" title="class in org.asteriskjava.fastagi.command">AbstractAgiCommand</A></B></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><A HREF="../../../../org/asteriskjava/fastagi/command/AbstractAgiCommand.html#escapeAndQuote(java.lang.String)">escapeAndQuote</A>, <A HREF="../../../../org/asteriskjava/fastagi/command/AbstractAgiCommand.html#toString()">toString</A></CODE></TD></TR></TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"><TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD></TR></TABLE> <P><!-- ========= CONSTRUCTOR DETAIL ======== --><A NAME="constructor_detail"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -