Class: Kaltura::KalturaStatsEvent

Inherits:
KalturaObjectBase show all
Defined in:
lib/kaltura_client.rb

Overview

Will hold data from the Kaltura UI components to be passed on to the reports and analytics system

Instance Attribute Summary collapse

Attributes inherited from KalturaObjectBase

#object_type

Method Summary

Methods inherited from KalturaObjectBase

#camelcase, #to_b, #to_params

Instance Attribute Details

#application_idObject

kaltura application name



5432
5433
5434
# File 'lib/kaltura_client.rb', line 5432

def application_id
  @application_id
end

#client_verObject

Returns the value of attribute client_ver.



5385
5386
5387
# File 'lib/kaltura_client.rb', line 5385

def client_ver
  @client_ver
end

#context_idObject

Returns the value of attribute context_id.



5433
5434
5435
# File 'lib/kaltura_client.rb', line 5433

def context_id
  @context_id
end

#control_idObject

the id of the GUI control - will be used in the future to better understand what the user clicked



5417
5418
5419
# File 'lib/kaltura_client.rb', line 5417

def control_id
  @control_id
end

#current_pointObject

the timestamp along the video when the event happend



5405
5406
5407
# File 'lib/kaltura_client.rb', line 5405

def current_point
  @current_point
end

#durationObject

the duration of the video in milliseconds - will make it much faster than quering the db for each entry



5408
5409
5410
# File 'lib/kaltura_client.rb', line 5408

def duration
  @duration
end

#entry_idObject

Returns the value of attribute entry_id.



5394
5395
5396
# File 'lib/kaltura_client.rb', line 5394

def entry_id
  @entry_id
end

#event_timestampObject

the client’s timestamp of this event



5389
5390
5391
# File 'lib/kaltura_client.rb', line 5389

def event_timestamp
  @event_timestamp
end

#event_typeObject

Returns the value of attribute event_type.



5386
5387
5388
# File 'lib/kaltura_client.rb', line 5386

def event_type
  @event_type
end

#feature_typeObject

Returns the value of attribute feature_type.



5434
5435
5436
# File 'lib/kaltura_client.rb', line 5434

def feature_type
  @feature_type
end

#is_first_in_sessionObject

will indicate if the event is thrown for the first video in the session



5429
5430
5431
# File 'lib/kaltura_client.rb', line 5429

def is_first_in_session
  @is_first_in_session
end

#new_pointObject

timestamp of the new point on the timeline of the video after the user seeks



5423
5424
5425
# File 'lib/kaltura_client.rb', line 5423

def new_point
  @new_point
end

#partner_idObject

Returns the value of attribute partner_id.



5393
5394
5395
# File 'lib/kaltura_client.rb', line 5393

def partner_id
  @partner_id
end

#process_durationObject

the time in milliseconds the event took



5414
5415
5416
# File 'lib/kaltura_client.rb', line 5414

def process_duration
  @process_duration
end

#referrerObject

the referrer of the client



5426
5427
5428
# File 'lib/kaltura_client.rb', line 5426

def referrer
  @referrer
end

#seekObject

true if the user ever used seek in this session



5420
5421
5422
# File 'lib/kaltura_client.rb', line 5420

def seek
  @seek
end

#session_idObject

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



5392
5393
5394
# File 'lib/kaltura_client.rb', line 5392

def session_id
  @session_id
end

#uiconf_idObject

Returns the value of attribute uiconf_id.



5399
5400
5401
# File 'lib/kaltura_client.rb', line 5399

def uiconf_id
  @uiconf_id
end

#unique_viewerObject

the UV cookie - creates in the operational system and should be passed on ofr every event



5397
5398
5399
# File 'lib/kaltura_client.rb', line 5397

def unique_viewer
  @unique_viewer
end

#user_idObject

the partner’s user id



5402
5403
5404
# File 'lib/kaltura_client.rb', line 5402

def user_id
  @user_id
end

#user_ipObject

will be retrieved from the request of the user



5411
5412
5413
# File 'lib/kaltura_client.rb', line 5411

def user_ip
  @user_ip
end

#widget_idObject

Returns the value of attribute widget_id.



5398
5399
5400
# File 'lib/kaltura_client.rb', line 5398

def widget_id
  @widget_id
end