Class: GetStream::Generated::Models::CallFrameRecordingFrameReadyEvent

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/getstream_ruby/generated/models/call_frame_recording_frame_ready_event.rb

Overview

This event is sent when a frame is captured from a call

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#==, #inspect, omit_empty_fields, #to_h, #to_json

Constructor Details

#initialize(attributes = {}) ⇒ CallFrameRecordingFrameReadyEvent

Initialize with attributes



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/getstream_ruby/generated/models/call_frame_recording_frame_ready_event.rb', line 41

def initialize(attributes = {})
  super(attributes)
  @call_cid = attributes[:call_cid] || attributes['call_cid']
  @captured_at = attributes[:captured_at] || attributes['captured_at']
  @created_at = attributes[:created_at] || attributes['created_at']
  @egress_id = attributes[:egress_id] || attributes['egress_id']
  @session_id = attributes[:session_id] || attributes['session_id']
  @track_type = attributes[:track_type] || attributes['track_type']
  @url = attributes[:url] || attributes['url']
  @users = attributes[:users] || attributes['users']
  @type = attributes[:type] || attributes['type'] || "call.frame_recording_ready"
end

Instance Attribute Details

#call_cid ⇒ String

Returns:

  • (String) 


14
15
16
 
# File 'lib/getstream_ruby/generated/models/call_frame_recording_frame_ready_event.rb', line 14

def call_cid
  @call_cid
end

#captured_at ⇒ DateTime

Returns The time the frame was captured.

Returns:

  • (DateTime) —

    The time the frame was captured



17
18
19
 
# File 'lib/getstream_ruby/generated/models/call_frame_recording_frame_ready_event.rb', line 17

def captured_at
  @captured_at
end

#created_at ⇒ DateTime

Returns:

  • (DateTime) 


20
21
22
 
# File 'lib/getstream_ruby/generated/models/call_frame_recording_frame_ready_event.rb', line 20

def created_at
  @created_at
end

#egress_id ⇒ String

Returns:

  • (String) 


23
24
25
 
# File 'lib/getstream_ruby/generated/models/call_frame_recording_frame_ready_event.rb', line 23

def egress_id
  @egress_id
end

#session_id ⇒ String

Returns Call session ID.

Returns:

  • (String) —

    Call session ID



26
27
28
 
# File 'lib/getstream_ruby/generated/models/call_frame_recording_frame_ready_event.rb', line 26

def session_id
  @session_id
end

#track_type ⇒ String

Returns The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE).

Returns:

  • (String) —

    The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)



29
30
31
 
# File 'lib/getstream_ruby/generated/models/call_frame_recording_frame_ready_event.rb', line 29

def track_type
  @track_type
end

#type ⇒ String

Returns The type of event: “call.frame_recording_ready” in this case.

Returns:

  • (String) —

    The type of event: “call.frame_recording_ready” in this case



38
39
40
 
# File 'lib/getstream_ruby/generated/models/call_frame_recording_frame_ready_event.rb', line 38

def type
  @type
end

#url ⇒ String

Returns The URL of the frame.

Returns:

  • (String) —

    The URL of the frame



32
33
34
 
# File 'lib/getstream_ruby/generated/models/call_frame_recording_frame_ready_event.rb', line 32

def url
  @url
end

#users ⇒ Hash<String, UserResponse>

Returns The users in the frame.

Returns:



35
36
37
 
# File 'lib/getstream_ruby/generated/models/call_frame_recording_frame_ready_event.rb', line 35

def users
  @users
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/getstream_ruby/generated/models/call_frame_recording_frame_ready_event.rb', line 55

def self.json_field_mappings
  {
    call_cid: 'call_cid',
    captured_at: 'captured_at',
    created_at: 'created_at',
    egress_id: 'egress_id',
    session_id: 'session_id',
    track_type: 'track_type',
    url: 'url',
    users: 'users',
    type: 'type'
  }
end