Click or drag to resize
ControlStreamFileCommand Class
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.
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.
Remember, the file extension must not be included in the filename.
Available since Asterisk 1.2
Inheritance Hierarchy
SystemObject
  AsterNET.FastAGI.CommandAGICommand
    AsterNET.FastAGI.CommandControlStreamFileCommand

Namespace: AsterNET.FastAGI.Command
Assembly: AsterNET (in AsterNET.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public class ControlStreamFileCommand : AGICommand

The ControlStreamFileCommand type exposes the following members.

Constructors
  NameDescription
Public methodControlStreamFileCommand(String)
Creates a new ControlStreamFileCommand, streaming from the beginning. It uses the default digit "#" for forward and "*" for rewind and does not support pausing.
Public methodControlStreamFileCommand(String, String)
Creates a new ControlStreamFileCommand, streaming from the beginning. It uses the default digit "#" for forward and "*" for rewind and does not support pausing.
Public methodControlStreamFileCommand(String, String, Int32)
Creates a new ControlStreamFileCommand, streaming from the given offset. It uses the default digit "#" for forward and "*" for rewind and does not support pausing.
Public methodControlStreamFileCommand(String, String, Int32, String, String, String)
Creates a new ControlStreamFileCommand, streaming from the given offset. It uses the default digit "#" for forward and "*" for rewind and does not support pausing.
Top
Methods
  NameDescription
Public methodBuildCommand (Overrides AGICommandBuildCommand.)
Public methodControlDigits(String, String)
Sets the control digits for fast forward and rewind.
Public methodControlDigits(String, String, String)
Sets the control digits for fast forward, rewind and pause.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodEscapeAndQuote (Inherited from AGICommand.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString (Inherited from AGICommand.)
Top
Properties
  NameDescription
Public propertyEscapeDigits
Get/Set the digits that allow the user to interrupt this command or null for none.
Public propertyFile
Get/Set the name of the file to stream.
Public propertyForwardDigit
Get the digit for fast forward.
Public propertyOffset
Get/Set the offset samples to skip before streaming.
Public propertyPauseDigit
Get the digit for pause and unpause.
Public propertyRewindDigit
Get the digit for rewind.
Top
See Also