Class: PureCloud::AnalyticsMediaEndpointStat

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsMediaEndpointStat

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 107

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  
  if attributes.has_key?(:'codecs')
    
    if (value = attributes[:'codecs']).is_a?(Array)
      self.codecs = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'minMos')
    
    
    self.min_mos = attributes[:'minMos']
    
  
  end

  
  if attributes.has_key?(:'minRFactor')
    
    
    self.min_r_factor = attributes[:'minRFactor']
    
  
  end

  
  if attributes.has_key?(:'maxLatencyMs')
    
    
    self.max_latency_ms = attributes[:'maxLatencyMs']
    
  
  end

  
  if attributes.has_key?(:'receivedPackets')
    
    
    self.received_packets = attributes[:'receivedPackets']
    
  
  end

  
  if attributes.has_key?(:'invalidPackets')
    
    
    self.invalid_packets = attributes[:'invalidPackets']
    
  
  end

  
  if attributes.has_key?(:'discardedPackets')
    
    
    self.discarded_packets = attributes[:'discardedPackets']
    
  
  end

  
  if attributes.has_key?(:'duplicatePackets')
    
    
    self.duplicate_packets = attributes[:'duplicatePackets']
    
  
  end

  
  if attributes.has_key?(:'overrunPackets')
    
    
    self.overrun_packets = attributes[:'overrunPackets']
    
  
  end

  
  if attributes.has_key?(:'underrunPackets')
    
    
    self.underrun_packets = attributes[:'underrunPackets']
    
  
  end

  
end

Instance Attribute Details

#codecs ⇒ Object

The MIME types of the audio encodings used by the audio streams belonging to this endpoint



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 22

def codecs
  @codecs
end

#discarded_packets ⇒ Object

The total number of packets received too late or too early, jitter queue overrun or underrun, for all audio streams belonging to this endpoint



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 40

def discarded_packets
  @discarded_packets
end

#duplicate_packets ⇒ Object

The total number of packets received with the same sequence number as another one recently received (window of 64 packets), for all audio streams belonging to this endpoint



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 43

def duplicate_packets
  @duplicate_packets
end

#invalid_packets ⇒ Object

The total number of malformed or not RTP packets, unknown payload type, or discarded probation packets for all audio streams belonging to this endpoint



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 37

def invalid_packets
  @invalid_packets
end

#max_latency_ms ⇒ Object

The maximum latency experienced by any audio stream belonging to this endpoint, in milliseconds



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 31

def max_latency_ms
  @max_latency_ms
end

#min_mos ⇒ Object

The lowest estimated average MOS among all the audio streams belonging to this endpoint



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 25

def min_mos
  @min_mos
end

#min_r_factor ⇒ Object

The lowest R-factor value among all of the audio streams belonging to this endpoint



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 28

def min_r_factor
  @min_r_factor
end

#overrun_packets ⇒ Object

The total number of packets for which there was no room in the jitter queue when it was received, for all audio streams belonging to this endpoint (also counted in discarded)



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 46

def overrun_packets
  @overrun_packets
end

#received_packets ⇒ Object

The total number of packets received for all audio streams belonging to this endpoint (includes invalid, duplicate, and discarded packets)



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 34

def received_packets
  @received_packets
end

#underrun_packets ⇒ Object

The total number of packets received after their timestamp/seqnum has been played out, for all audio streams belonging to this endpoint (also counted in discarded)



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 49

def underrun_packets
  @underrun_packets
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 52

def self.attribute_map
  {
    
    :'codecs' => :'codecs',
    
    :'min_mos' => :'minMos',
    
    :'min_r_factor' => :'minRFactor',
    
    :'max_latency_ms' => :'maxLatencyMs',
    
    :'received_packets' => :'receivedPackets',
    
    :'invalid_packets' => :'invalidPackets',
    
    :'discarded_packets' => :'discardedPackets',
    
    :'duplicate_packets' => :'duplicatePackets',
    
    :'overrun_packets' => :'overrunPackets',
    
    :'underrun_packets' => :'underrunPackets'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 79

def self.swagger_types
  {
    
    :'codecs' => :'Array<String>',
    
    :'min_mos' => :'Float',
    
    :'min_r_factor' => :'Float',
    
    :'max_latency_ms' => :'Integer',
    
    :'received_packets' => :'Integer',
    
    :'invalid_packets' => :'Integer',
    
    :'discarded_packets' => :'Integer',
    
    :'duplicate_packets' => :'Integer',
    
    :'overrun_packets' => :'Integer',
    
    :'underrun_packets' => :'Integer'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 316

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      codecs == o.codecs &&
      min_mos == o.min_mos &&
      min_r_factor == o.min_r_factor &&
      max_latency_ms == o.max_latency_ms &&
      received_packets == o.received_packets &&
      invalid_packets == o.invalid_packets &&
      discarded_packets == o.discarded_packets &&
      duplicate_packets == o.duplicate_packets &&
      overrun_packets == o.overrun_packets &&
      underrun_packets == o.underrun_packets
end

#_deserialize(type, value) ⇒ Object 



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 363

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 423

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

build the object from hash



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 344

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


333
334
335
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 333

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



339
340
341
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 339

def hash
  [codecs, min_mos, min_r_factor, max_latency_ms, received_packets, invalid_packets, discarded_packets, duplicate_packets, overrun_packets, underrun_packets].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



210
211
212
213
214
215
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 210

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



406
407
408
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 406

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



411
412
413
414
415
416
417
418
419
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 411

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ Object 



401
402
403
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 401

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/purecloudplatformclientv2/models/analytics_media_endpoint_stat.rb', line 219

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end