Class ASF_Object_ScriptCommand

Description

The Script Command Object provides a list of type/parameter pairs of

strings that are synchronized to the ASF file's timeline. Types can include URL or FILENAME values. Other type values may also be freely defined and used. The semantics and treatment of this set of types are defined by the local implementations. The parameter value is specific to the type field. You can use this type/parameter pairing for many purposes, including sending URLs to be launched by a client into an HTML frame (in other words, the URL type) or launching another ASF file for the chained continuous play of audio or video presentations (in other words, the FILENAME type). This object is also used as a method to stream text, as well as to provide script commands that you can use to control elements within the client environment.

Located in /ASF/Object/ScriptCommand.php (line 62)

ASF_Object
   |
   --ASF_Object_ScriptCommand
Method Summary
ASF_Object_ScriptCommand __construct (Reader $reader, [ &$options = array()], Array $options)
Array getCommands ()
Array getCommandTypes ()
Variables

Inherited Variables

Inherited from ASF_Object

ASF_Object::$_options
ASF_Object::$_reader
Methods
Constructor __construct (line 77)

Constructs the class with given parameters and reads object related data from the ASF file.

  • access: public
ASF_Object_ScriptCommand __construct (Reader $reader, [ &$options = array()], Array $options)
  • Reader $reader: The reader object.
  • Array $options: The options array.
  • &$options

Redefinition of:
ASF_Object::__construct()
Constructs the class with given parameters and options.
getCommands (line 123)

Returns an array of index entries. Each entry consists of the following keys.

  • presentationTime -- Specifies the presentation time of the command, in milliseconds.
  • typeIndex -- Specifies the type of this command, as a zero-based index into the array of Command Types of this object.
  • name -- Specifies the name of this command.

  • access: public
Array getCommands ()
getCommandTypes (line 107)

Returns an array of command type names.

  • access: public
Array getCommandTypes ()

Inherited Methods

Inherited From ASF_Object

ASF_Object::__construct()
ASF_Object::getIdentifier()
ASF_Object::getOffset()
ASF_Object::getOption()
ASF_Object::getOptions()
ASF_Object::getParent()
ASF_Object::getSize()
ASF_Object::setIdentifier()
ASF_Object::setOffset()
ASF_Object::setOption()
ASF_Object::setOptions()
ASF_Object::setParent()
ASF_Object::setSize()
ASF_Object::__get()
ASF_Object::__set()

Documentation generated on Fri, 05 Sep 2008 20:19:21 +0300 by phpDocumentor 1.4.1