Class: GetStream::Generated::Models::IngressStartedEvent

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

Overview

This event is sent when a user begins streaming into 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 = {}) ⇒ IngressStartedEvent

Initialize with attributes



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

def initialize(attributes = {})
  super(attributes)
  @call_cid = attributes[:call_cid] || attributes['call_cid']
  @created_at = attributes[:created_at] || attributes['created_at']
  @ingress_stream_id = attributes[:ingress_stream_id] || attributes['ingress_stream_id']
  @publisher_type = attributes[:publisher_type] || attributes['publisher_type']
  @user_id = attributes[:user_id] || attributes['user_id']
  @type = attributes[:type] || attributes['type'] || "ingress.started"
  @client_ip = attributes[:client_ip] || attributes['client_ip'] || nil
  @client_name = attributes[:client_name] || attributes['client_name'] || nil
  @version = attributes[:version] || attributes['version'] || nil
end

Instance Attribute Details

#call_cid ⇒ String

Returns:

  • (String) 


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

def call_cid
  @call_cid
end

#client_ip ⇒ String

Returns Client IP address.

Returns:

  • (String) —

    Client IP address



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

def client_ip
  @client_ip
end

#client_name ⇒ String

Returns Streaming client software name (e.g., ‘OBS Studio’).

Returns:

  • (String) —

    Streaming client software name (e.g., ‘OBS Studio’)



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

def client_name
  @client_name
end

#created_at ⇒ DateTime

Returns:

  • (DateTime) 


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

def created_at
  @created_at
end

#ingress_stream_id ⇒ String

Returns Unique identifier for this stream.

Returns:

  • (String) —

    Unique identifier for this stream



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

def ingress_stream_id
  @ingress_stream_id
end

#publisher_type ⇒ String

Returns Streaming protocol (e.g., ‘rtmps’, ‘srt’, ‘rtmp’, ‘rtsp’).

Returns:

  • (String) —

    Streaming protocol (e.g., ‘rtmps’, ‘srt’, ‘rtmp’, ‘rtsp’)



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

def publisher_type
  @publisher_type
end

#type ⇒ String

Returns The type of event: “ingress.started” in this case.

Returns:

  • (String) —

    The type of event: “ingress.started” in this case



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

def type
  @type
end

#user_id ⇒ String

Returns User who started the stream.

Returns:

  • (String) —

    User who started the stream



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

def user_id
  @user_id
end

#version ⇒ String

Returns Client software version.

Returns:

  • (String) —

    Client software version



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

def version
  @version
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/ingress_started_event.rb', line 55

def self.json_field_mappings
  {
    call_cid: 'call_cid',
    created_at: 'created_at',
    ingress_stream_id: 'ingress_stream_id',
    publisher_type: 'publisher_type',
    user_id: 'user_id',
    type: 'type',
    client_ip: 'client_ip',
    client_name: 'client_name',
    version: 'version'
  }
end