Class MediaObject

Description

Generic Multimedia Object

Located in /html-defs.php (line 3809)

RenderableObject
   |
   --StylableObject
      |
      --HTMLObject
         |
         --EmbeddedObject
            |
            --MediaObject
Variable Summary
 mixed $autostart
 mixed $hidden
 mixed $loop
 mixed $media
Method Summary
 MediaObject MediaObject (string $media, [integer $width = ""], [integer $height = ""], [boolean $autostart = false], [boolean $loop = false], [mixed $showcontrols = true], [boolean $hidden = false], [string $standby = "Loading.."])
 void AsIcon ([string $tooltip = ""], [object $iconimage = false])
 string html ()
Variables
mixed $autostart = false (line 3813)

If true the media start immediately it is loaded

mixed $hidden = false (line 3817)

If true the media object is hidden

mixed $loop = false (line 3815)

If true the media replays endlessly

mixed $media = "" (line 3811)
mixed $showcontrols = true (line 3819)

If true the mediaplayer controls are shown

Inherited Variables

Inherited from EmbeddedObject

EmbeddedObject::$aslink
EmbeddedObject::$aslink_target
EmbeddedObject::$category
EmbeddedObject::$classid
EmbeddedObject::$codebase
EmbeddedObject::$codetype
EmbeddedObject::$data
EmbeddedObject::$embed_obj
EmbeddedObject::$extn_mimetype
EmbeddedObject::$icon
EmbeddedObject::$internal_name
EmbeddedObject::$mimetype
EmbeddedObject::$params
EmbeddedObject::$pluginspage
EmbeddedObject::$standby

Inherited from HTMLObject

HTMLObject::$accesskey
HTMLObject::$align
HTMLObject::$alt
HTMLObject::$bgcolor
HTMLObject::$bgurl
HTMLObject::$border
HTMLObject::$color
HTMLObject::$height
HTMLObject::$hspace
HTMLObject::$lang
HTMLObject::$langdir
HTMLObject::$linkover_text
HTMLObject::$name
HTMLObject::$onblur
HTMLObject::$onchange
HTMLObject::$onclick
HTMLObject::$ondblclick
HTMLObject::$onfocus
HTMLObject::$onkeydown
HTMLObject::$onkeypress
HTMLObject::$onkeyup
HTMLObject::$onload
HTMLObject::$onmousedown
HTMLObject::$onmousemove
HTMLObject::$onmouseout
HTMLObject::$onmouseover
HTMLObject::$onmouseup
HTMLObject::$onselect
HTMLObject::$size
HTMLObject::$src
HTMLObject::$tabindex
HTMLObject::$target
HTMLObject::$title
HTMLObject::$user_attributes
HTMLObject::$valign
HTMLObject::$vspace
HTMLObject::$width

Inherited from StylableObject

StylableObject::$class
StylableObject::$id
StylableObject::$style
Methods
Constructor MediaObject (line 3830)

Constructor

MediaObject MediaObject (string $media, [integer $width = ""], [integer $height = ""], [boolean $autostart = false], [boolean $loop = false], [mixed $showcontrols = true], [boolean $hidden = false], [string $standby = "Loading.."])
  • string $media: URL of the media file
  • integer $width: Width in pixels of the media object
  • integer $height: Height in pixels of the media object
  • boolean $autostart: True if you want the media to auto-start on load
  • boolean $loop: True if you want the media to repeat endlessly
  • boolean $hidden: True if you want the media to be hidden from view
  • string $standby: Standby message whilst loading
AsIcon (line 3858)

Render the media object as an image 'icon' which can be clicked to play the media. If image is specified, it must be a valid 'image' object, otherwise a generic library symbol will be used.

void AsIcon ([string $tooltip = ""], [object $iconimage = false])
  • string $tooltip: Optional browser mouseover tooltip text
  • object $iconimage: A custom image object
html (line 3892)

Render the HTML

  • return: HTML for this object
string html ()

Redefinition of:
EmbeddedObject::html()
Render the HTML

Inherited Methods

Inherited From EmbeddedObject

 EmbeddedObject::EmbeddedObject()
 EmbeddedObject::add_embed()
 EmbeddedObject::AsLink()
 EmbeddedObject::html()
 EmbeddedObject::setparam()

Inherited From HTMLObject

 HTMLObject::HTMLObject()
 HTMLObject::inherit_attributes()
 HTMLObject::setaccesskey()
 HTMLObject::setalign()
 HTMLObject::setalt()
 HTMLObject::setbackground()
 HTMLObject::setbgcolor()
 HTMLObject::setborder()
 HTMLObject::setcolor()
 HTMLObject::setheight()
 HTMLObject::sethspace()
 HTMLObject::setlang()
 HTMLObject::setlangdir()
 HTMLObject::setname()
 HTMLObject::setsize()
 HTMLObject::setsrc()
 HTMLObject::settabindex()
 HTMLObject::settarget()
 HTMLObject::settitle()
 HTMLObject::setvalign()
 HTMLObject::setvspace()
 HTMLObject::setwidth()
 HTMLObject::set_attribute()
 HTMLObject::set_linkover_text()
 HTMLObject::set_onblur()
 HTMLObject::set_onchange()
 HTMLObject::set_onclick()
 HTMLObject::set_ondblclick()
 HTMLObject::set_onfocus()
 HTMLObject::set_onkeydown()
 HTMLObject::set_onkeypress()
 HTMLObject::set_onkeyup()
 HTMLObject::set_onload()
 HTMLObject::set_onmousedown()
 HTMLObject::set_onmousemove()
 HTMLObject::set_onmouseout()
 HTMLObject::set_onmouseover()
 HTMLObject::set_onmouseup()
 HTMLObject::set_onselect()
 HTMLObject::set_tabindex()
 HTMLObject::taghtml()

Inherited From StylableObject

 StylableObject::StylableObject()
 StylableObject::clearstyle()
 StylableObject::setclass()
 StylableObject::setcss()
 StylableObject::setid()
 StylableObject::setstyle()

Inherited From RenderableObject

 RenderableObject::RenderableObject()
 RenderableObject::html()
 RenderableObject::render()
 RenderableObject::wml()
 RenderableObject::wmlup()
 RenderableObject::xml()

Documentation generated by phpDocumentor 1.3.0RC3