FORGE. Media

new Media(viewer, config)

Media class.
Parameters:
Name Type Description
viewer FORGE.Viewer FORGE.Viewer reference.
config SceneMediaConfig input media configuration from json
Source:

Extends

Members

(readonly) alive :boolean

Get the alive flag value of the object.
Type:
  • boolean
Inherited From:
Source:

(readonly) className :string

Get the class name of the object.
Type:
  • string
Inherited From:
Source:

(readonly) config :SceneMediaConfig

Get the media config.
Type:
  • SceneMediaConfig
Source:

data :*

Get and set any custom data you want to associate to this object.
Type:
  • *
Inherited From:
Source:

debug :boolean

Get and set the debug flag.
Type:
  • boolean
Inherited From:
Source:

(readonly) displayObject :FORGE.DisplayObject

Get the displayObject.
Type:
Source:

(readonly) loaded :boolean

Get the loaded flag
Type:
  • boolean
Source:

(readonly) onDestroy :FORGE.EventDispatcher

Get the onDestroy FORGE.EventDispatcher, this event is emitted at the end of the destroy sequence.
Type:
Inherited From:
Source:

(readonly) onLoadComplete :FORGE.EventDispatcher

Get the onLoadComplete FORGE.EventDispatcher.
Type:
Source:

(readonly) tags :Array

Get the tags associated to this object.
Type:
  • Array
Inherited From:
Source:

(readonly) type :string

Get the media type.
Type:
  • string
Source:

(readonly) uid :string

Get the uid of the object.
Type:
  • string
Inherited From:
Source:

warning :boolean

Get and set the warning flag.
Type:
  • boolean
Inherited From:
Source:

Methods

_onLoadedMetaDataHandler()

Method to dispatch the load complete event and set the media ready.
Source:

destroy()

Media destroy sequence
Overrides:
Source:

log(value)

Basic log method, log a string in the console if debug is enabled.
Parameters:
Name Type Description
value * The value you want to log in the console.
Inherited From:
Source:

warn(valuenullable)

Basic warn method, log a warn string in the console if warning is enabled.
Parameters:
Name Type Attributes Description
value string | Object <nullable>
The value you want to warn in the console.
Inherited From:
Source:

FORGE. Media

Members
Methods