Class: Twilio::REST::Video::V1::RecordingInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/video/v1/recording.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ RecordingInstance

Initialize the RecordingInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • sid (String) (defaults to: nil) —

    The SID of the Recording resource to fetch.



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 264

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'status' => payload['status'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'sid' => payload['sid'],
      'source_sid' => payload['source_sid'],
      'size' => payload['size'].to_i,
      'url' => payload['url'],
      'type' => payload['type'],
      'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
      'container_format' => payload['container_format'],
      'codec' => payload['codec'],
      'grouping_sids' => payload['grouping_sids'],
      'track_name' => payload['track_name'],
      'offset' => payload['offset'].to_i,
      'links' => payload['links'],
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



304
305
306
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 304

def 
  @properties['account_sid']
end

#codec ⇒ recording.Codec

Returns The codec used to encode the track.

Returns:

  • (recording.Codec) —

    The codec used to encode the track



364
365
366
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 364

def codec
  @properties['codec']
end

#container_format ⇒ recording.Format

Returns The file format for the recording.

Returns:

  • (recording.Format) —

    The file format for the recording



358
359
360
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 358

def container_format
  @properties['container_format']
end

#context ⇒ RecordingContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



295
296
297
298
299
300
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 295

def context
  unless @instance_context
    @instance_context = RecordingContext.new(@version, @params['sid'], )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



316
317
318
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 316

def date_created
  @properties['date_created']
end

#delete ⇒ Boolean

Deletes the RecordingInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



402
403
404
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 402

def delete
  context.delete
end

#duration ⇒ String

Returns The duration of the recording in seconds.

Returns:

  • (String) —

    The duration of the recording in seconds



352
353
354
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 352

def duration
  @properties['duration']
end

#fetch ⇒ RecordingInstance

Fetch a RecordingInstance

Returns:



395
396
397
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 395

def fetch
  context.fetch
end

#grouping_sids ⇒ Hash

Returns A list of SIDs related to the recording.

Returns:

  • (Hash) —

    A list of SIDs related to the recording



370
371
372
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 370

def grouping_sids
  @properties['grouping_sids']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



415
416
417
418
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 415

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Video.V1.RecordingInstance #{values}>"
end

#links ⇒ String

Returns The URLs of related resources.

Returns:

  • (String) —

    The URLs of related resources



388
389
390
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 388

def links
  @properties['links']
end

#offset ⇒ String

Returns The number of milliseconds between a point in time that is common to all rooms in a group and when the source room of the recording started.

Returns:

  • (String) —

    The number of milliseconds between a point in time that is common to all rooms in a group and when the source room of the recording started



382
383
384
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 382

def offset
  @properties['offset']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



322
323
324
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 322

def sid
  @properties['sid']
end

#size ⇒ String

Returns The size of the recorded track, in bytes.

Returns:

  • (String) —

    The size of the recorded track, in bytes



334
335
336
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 334

def size
  @properties['size']
end

#source_sid ⇒ String

Returns The SID of the recording source.

Returns:

  • (String) —

    The SID of the recording source



328
329
330
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 328

def source_sid
  @properties['source_sid']
end

#status ⇒ recording.Status

Returns The status of the recording.

Returns:

  • (recording.Status) —

    The status of the recording



310
311
312
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 310

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



408
409
410
411
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 408

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Video.V1.RecordingInstance #{values}>"
end

#track_name ⇒ String

Returns The name that was given to the source track of the recording.

Returns:

  • (String) —

    The name that was given to the source track of the recording



376
377
378
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 376

def track_name
  @properties['track_name']
end

#type ⇒ recording.Type

Returns The recording’s media type.

Returns:

  • (recording.Type) —

    The recording’s media type



346
347
348
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 346

def type
  @properties['type']
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource



340
341
342
 
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 340

def url
  @properties['url']
end