class KalturaStatsEvent in Kaltura 6.2

Hierarchy

• class \KalturaObjectBase
  • class \KalturaStatsEvent

File

kaltura_client/KalturaClient.php, line 2483

class KalturaStatsEvent extends KalturaObjectBase {

  /**
   *
   *
   * @var string
   */
  public $clientVer = null;

  /**
   *
   *
   * @var KalturaStatsEventType
   */
  public $eventType = null;

  /**
   * the client's timestamp of this event
   *
   * @var float
   */
  public $eventTimestamp = null;

  /**
   * a unique string generated by the client that will represent the client-side session: the primary component will pass it on to other components that sprout from it
   *
   * @var string
   */
  public $sessionId = null;

  /**
   *
   *
   * @var int
   */
  public $partnerId = null;

  /**
   *
   *
   * @var string
   */
  public $entryId = null;

  /**
   * the UV cookie - creates in the operational system and should be passed on ofr every event
   *
   * @var string
   */
  public $uniqueViewer = null;

  /**
   *
   *
   * @var string
   */
  public $widgetId = null;

  /**
   *
   *
   * @var int
   */
  public $uiconfId = null;

  /**
   * the partner's user id
   *
   * @var string
   */
  public $userId = null;

  /**
   * the timestamp along the video when the event happend
   *
   * @var int
   */
  public $currentPoint = null;

  /**
   * the duration of the video in milliseconds - will make it much faster than quering the db for each entry
   *
   * @var int
   */
  public $duration = null;

  /**
   * will be retrieved from the request of the user
   *
   * @var string
   * @readonly
   */
  public $userIp = null;

  /**
   * the time in milliseconds the event took
   *
   * @var int
   */
  public $processDuration = null;

  /**
   * the id of the GUI control - will be used in the future to better understand what the user clicked
   *
   * @var string
   */
  public $controlId = null;

  /**
   * true if the user ever used seek in this session
   *
   * @var bool
   */
  public $seek = null;

  /**
   * timestamp of the new point on the timeline of the video after the user seeks
   *
   * @var int
   */
  public $newPoint = null;

  /**
   * the referrer of the client
   *
   * @var string
   */
  public $referrer = null;

  /**
   * will indicate if the event is thrown for the first video in the session
   *
   * @var bool
   */
  public $isFirstInSession = null;

}

Members

Name	Modifiers	Type	Description	Overrides
KalturaObjectBase::addIfNotNull	protected	function
KalturaObjectBase::toParams	public	function
KalturaStatsEvent::$clientVer	public	property
KalturaStatsEvent::$controlId	public	property	the id of the GUI control - will be used in the future to better understand what the user clicked
KalturaStatsEvent::$currentPoint	public	property	the timestamp along the video when the event happend
KalturaStatsEvent::$duration	public	property	the duration of the video in milliseconds - will make it much faster than quering the db for each entry
KalturaStatsEvent::$entryId	public	property
KalturaStatsEvent::$eventTimestamp	public	property	the client's timestamp of this event
KalturaStatsEvent::$eventType	public	property
KalturaStatsEvent::$isFirstInSession	public	property	will indicate if the event is thrown for the first video in the session
KalturaStatsEvent::$newPoint	public	property	timestamp of the new point on the timeline of the video after the user seeks
KalturaStatsEvent::$partnerId	public	property
KalturaStatsEvent::$processDuration	public	property	the time in milliseconds the event took
KalturaStatsEvent::$referrer	public	property	the referrer of the client
KalturaStatsEvent::$seek	public	property	true if the user ever used seek in this session
KalturaStatsEvent::$sessionId	public	property	a unique string generated by the client that will represent the client-side session: the primary component will pass it on to other components that sprout from it
KalturaStatsEvent::$uiconfId	public	property
KalturaStatsEvent::$uniqueViewer	public	property	the UV cookie - creates in the operational system and should be passed on ofr every event
KalturaStatsEvent::$userId	public	property	the partner's user id
KalturaStatsEvent::$userIp	public	property	will be retrieved from the request of the user
KalturaStatsEvent::$widgetId	public	property