Method | Defined By | ||
---|---|---|---|
click($name:String, $offset:Number):void
Notifies the media module that the media item has been clicked. | Media | ||
close($name:String):void
Closes a media item. | Media | ||
open($mediaSettings:MediaSettings):void
Opens a media item for tracking based on the provided MediaSettings instance. | Media | ||
play($name:String, $offset:Number):void
Begins tracking a media item. | Media | ||
stop($name:String, $offset:Number):void
Notifies the media module that the media item has been paused or stopped. | Media | ||
track($name:String, $contextData:ContextData = null):void
Sends a track event with the current media state
| Media |
click | () | method |
public function click($name:String, $offset:Number):void
Notifies the media module that the media item has been clicked.
Parameters
$name:String — name of media item.
| |
$offset:Number — point that the media item was clicked (in seconds)
|
close | () | method |
public function close($name:String):void
Closes a media item.
Parameters
$name:String |
open | () | method |
public function open($mediaSettings:MediaSettings):void
Opens a media item for tracking based on the provided MediaSettings instance.
Parameters
$mediaSettings:MediaSettings |
play | () | method |
public function play($name:String, $offset:Number):void
Begins tracking a media item.
Parameters
$name:String — name of media item.
| |
$offset:Number — point that the media items is being played from (in seconds)
|
stop | () | method |
public function stop($name:String, $offset:Number):void
Notifies the media module that the media item has been paused or stopped.
Parameters
$name:String — name of media item.
| |
$offset:Number — point that the media item was stopped (in seconds)
|
track | () | method |
public function track($name:String, $contextData:ContextData = null):void
Sends a track event with the current media state
Parameters
$name:String — name of media item.
| |
$contextData:ContextData (default = null ) — optional ContextData containing context data to track with this media action.
|