snow/asternet
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
asternet/docs/html/T_AsterNET_FastAGI_Command_ControlStreamFileCommand.htm
Herman van den Berg 3bf0d5a3be add sandcastle generated documentation for github pages
2016-10-03 11:15:07 +02:00

53 lines
20 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ControlStreamFileCommand Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="ControlStreamFileCommand class" /><meta name="System.Keywords" content="AsterNET.FastAGI.Command.ControlStreamFileCommand class" /><meta name="System.Keywords" content="ControlStreamFileCommand class, about ControlStreamFileCommand class" /><meta name="Microsoft.Help.F1" content="AsterNET.FastAGI.Command.ControlStreamFileCommand" /><meta name="Microsoft.Help.Id" content="T:AsterNET.FastAGI.Command.ControlStreamFileCommand" /><meta name="Description" content="Plays the given file, allowing playback to be interrupted by the given digits, if any, and allows the listner to control the stream. If offset is provided then the audio will seek to sample offset before play starts." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="AsterNET.FastAGI.Command" /><meta name="file" content="T_AsterNET_FastAGI_Command_ControlStreamFileCommand" /><meta name="guid" content="T_AsterNET_FastAGI_Command_ControlStreamFileCommand" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">AsterNet Class Library (Sandcastle documentation)<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="79b6241e-05a3-441c-b6a1-51f2b5b7f265.htm" title="AsterNet Class Library (Sandcastle documentation)" tocid="roottoc">AsterNet Class Library (Sandcastle documentation)</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="N_AsterNET_FastAGI_Command.htm" title="AsterNET.FastAGI.Command" tocid="N_AsterNET_FastAGI_Command">AsterNET.FastAGI.Command</a></div><div class="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_FastAGI_Command_ControlStreamFileCommand.htm" title="ControlStreamFileCommand Class" tocid="T_AsterNET_FastAGI_Command_ControlStreamFileCommand">ControlStreamFileCommand Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Overload_AsterNET_FastAGI_Command_ControlStreamFileCommand__ctor.htm" title="ControlStreamFileCommand Constructor " tocid="Overload_AsterNET_FastAGI_Command_ControlStreamFileCommand__ctor">ControlStreamFileCommand Constructor </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Methods_T_AsterNET_FastAGI_Command_ControlStreamFileCommand.htm" title="ControlStreamFileCommand Methods" tocid="Methods_T_AsterNET_FastAGI_Command_ControlStreamFileCommand">ControlStreamFileCommand Methods</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Properties_T_AsterNET_FastAGI_Command_ControlStreamFileCommand.htm" title="ControlStreamFileCommand Properties" tocid="Properties_T_AsterNET_FastAGI_Command_ControlStreamFileCommand">ControlStreamFileCommand Properties</a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize"><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize"></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="logoColumn"><img src="../icons/Help.png" /></td><td class="titleColumn">ControlStreamFileCommand Class</td></tr></table><span class="introStyle"></span><div class="summary">
Plays the given file, allowing playback to be interrupted by the given
digits, if any, and allows the listner to control the stream.<br />
If offset is provided then the audio will seek to sample offset before play
starts.<br />
Returns 0 if playback completes without a digit being pressed, or the ASCII
numerical value of the digit if one was pressed, or -1 on error or if the
channel was disconnected. <br />
Remember, the file extension must not be included in the filename.<br />
Available since Asterisk 1.2
</div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID0RB')" onkeypress="SectionExpandCollapse_CheckKey('ID0RB', event)" tabindex="0"><img id="ID0RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Inheritance Hierarchy</span></div><div id="ID0RBSection" class="collapsibleSection"><a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">System<span id="LSTCF1DC41B_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTCF1DC41B_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br />  <a href="T_AsterNET_FastAGI_Command_AGICommand.htm">AsterNET.FastAGI.Command<span id="LSTCF1DC41B_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTCF1DC41B_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>AGICommand</a><br />    <span class="selflink">AsterNET.FastAGI.Command<span id="LSTCF1DC41B_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTCF1DC41B_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ControlStreamFileCommand</span><br /></div><p> </p><strong>Namespace:</strong> <a href="N_AsterNET_FastAGI_Command.htm">AsterNET.FastAGI.Command</a><br /><strong>Assembly:</strong> AsterNET (in AsterNET.dll) Version: 1.0.0.0 (1.0.0.0)<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID2RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID1EDCA_tab1" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','cs','1','4');return false;">C#</a></div><div id="ID1EDCA_tab2" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','vb','2','4');return false;">VB</a></div><div id="ID1EDCA_tab3" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','cpp','3','4');return false;">C++</a></div><div id="ID1EDCA_tab4" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','fs','4','4');return false;">F#</a></div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID1EDCA_copyCode" href="#" onclick="javascript:CopyToClipboard('ID1EDCA');return false;" title="Copy">Copy</a></div></div><div id="ID1EDCA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">ControlStreamFileCommand</span> : <span class="identifier">AGICommand</span></pre></div><div id="ID1EDCA_code_Div2" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">Public</span> <span class="keyword">Class</span> <span class="identifier">ControlStreamFileCommand</span>
<span class="keyword">Inherits</span> <span class="identifier">AGICommand</span></pre></div><div id="ID1EDCA_code_Div3" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">ref class</span> <span class="identifier">ControlStreamFileCommand</span> : <span class="keyword">public</span> <span class="identifier">AGICommand</span></pre></div><div id="ID1EDCA_code_Div4" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">type</span> <span class="identifier">ControlStreamFileCommand</span> =
<span class="keyword">class</span>
<span class="keyword">inherit</span> <span class="identifier">AGICommand</span>
<span class="keyword">end</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID1EDCA");</script></div><p>The <span class="selflink">ControlStreamFileCommand</span> type exposes the following members.</p><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID3RB')" onkeypress="SectionExpandCollapse_CheckKey('ID3RB', event)" tabindex="0"><img id="ID3RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Constructors</span></div><div id="ID3RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_FastAGI_Command_ControlStreamFileCommand__ctor.htm">ControlStreamFileCommand(String)</a></td><td><div class="summary">
Creates a new ControlStreamFileCommand, streaming from the beginning. It
uses the default digit "#" for forward and "*" for rewind and does not
support pausing.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_FastAGI_Command_ControlStreamFileCommand__ctor_1.htm">ControlStreamFileCommand(String, String)</a></td><td><div class="summary">
Creates a new ControlStreamFileCommand, streaming from the beginning. It
uses the default digit "#" for forward and "*" for rewind and does not
support pausing.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_FastAGI_Command_ControlStreamFileCommand__ctor_2.htm">ControlStreamFileCommand(String, String, Int32)</a></td><td><div class="summary">
Creates a new ControlStreamFileCommand, streaming from the given offset.
It uses the default digit "#" for forward and "*" for rewind and does not
support pausing.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_FastAGI_Command_ControlStreamFileCommand__ctor_3.htm">ControlStreamFileCommand(String, String, Int32, String, String, String)</a></td><td><div class="summary">
Creates a new ControlStreamFileCommand, streaming from the given offset.
It uses the default digit "#" for forward and "*" for rewind and does not
support pausing.
</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID4RB')" onkeypress="SectionExpandCollapse_CheckKey('ID4RB', event)" tabindex="0"><img id="ID4RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Methods</span></div><div id="ID4RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_FastAGI_Command_ControlStreamFileCommand_BuildCommand.htm">BuildCommand</a></td><td> (Overrides <a href="M_AsterNET_FastAGI_Command_AGICommand_BuildCommand.htm">AGICommand<span id="LSTCF1DC41B_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTCF1DC41B_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>BuildCommand<span id="LSTCF1DC41B_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTCF1DC41B_4?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_FastAGI_Command_ControlStreamFileCommand_ControlDigits.htm">ControlDigits(String, String)</a></td><td><div class="summary">
Sets the control digits for fast forward and rewind.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_FastAGI_Command_ControlStreamFileCommand_ControlDigits_1.htm">ControlDigits(String, String, String)</a></td><td><div class="summary">
Sets the control digits for fast forward, rewind and pause.
</div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/bsc2ak47" target="_blank">Equals</a></td><td><div class="summary">Determines whether the specified <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a> is equal to the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_AsterNET_FastAGI_Command_AGICommand_EscapeAndQuote.htm">EscapeAndQuote</a></td><td> (Inherited from <a href="T_AsterNET_FastAGI_Command_AGICommand.htm">AGICommand</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/4k87zsw7" target="_blank">Finalize</a></td><td><div class="summary">Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/zdee4b3y" target="_blank">GetHashCode</a></td><td><div class="summary">Serves as a hash function for a particular type. </div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/dfwy45w9" target="_blank">GetType</a></td><td><div class="summary">Gets the <a href="http://msdn2.microsoft.com/en-us/library/42892f65" target="_blank">Type</a> of the current instance.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/57ctke0a" target="_blank">MemberwiseClone</a></td><td><div class="summary">Creates a shallow copy of the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_AsterNET_FastAGI_Command_AGICommand_ToString.htm">ToString</a></td><td> (Inherited from <a href="T_AsterNET_FastAGI_Command_AGICommand.htm">AGICommand</a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID5RB')" onkeypress="SectionExpandCollapse_CheckKey('ID5RB', event)" tabindex="0"><img id="ID5RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Properties</span></div><div id="ID5RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_FastAGI_Command_ControlStreamFileCommand_EscapeDigits.htm">EscapeDigits</a></td><td><div class="summary">
Get/Set the digits that allow the user to interrupt this command or null for none.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_FastAGI_Command_ControlStreamFileCommand_File.htm">File</a></td><td><div class="summary">
Get/Set the name of the file to stream.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_FastAGI_Command_ControlStreamFileCommand_ForwardDigit.htm">ForwardDigit</a></td><td><div class="summary">
Get the digit for fast forward.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_FastAGI_Command_ControlStreamFileCommand_Offset.htm">Offset</a></td><td><div class="summary">
Get/Set the offset samples to skip before streaming.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_FastAGI_Command_ControlStreamFileCommand_PauseDigit.htm">PauseDigit</a></td><td><div class="summary">
Get the digit for pause and unpause.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_FastAGI_Command_ControlStreamFileCommand_RewindDigit.htm">RewindDigit</a></td><td><div class="summary">
Get the digit for rewind.
</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID6RB')" onkeypress="SectionExpandCollapse_CheckKey('ID6RB', event)" tabindex="0"><img id="ID6RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID6RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="N_AsterNET_FastAGI_Command.htm">AsterNET.FastAGI.Command Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>
Reference in a new issue View git blame Copy permalink