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.


256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 256

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,
      'media_external_location' => payload['media_external_location'],
      'status_callback' => payload['status_callback'],
      'status_callback_method' => payload['status_callback_method'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


299
300
301
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 299

def 
  @properties['account_sid']
end

#codecrecording.Codec

Returns The codec used to encode the track.

Returns:

  • (recording.Codec)

    The codec used to encode the track


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

def codec
  @properties['codec']
end

#container_formatrecording.Format

Returns The file format for the recording.

Returns:

  • (recording.Format)

    The file format for the recording


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

def container_format
  @properties['container_format']
end

#contextRecordingContext

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

Returns:


290
291
292
293
294
295
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 290

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

#date_createdTime

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


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

def date_created
  @properties['date_created']
end

#deleteBoolean

Delete the RecordingInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#durationString

Returns The duration of the recording in seconds.

Returns:

  • (String)

    The duration of the recording in seconds


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

def duration
  @properties['duration']
end

#fetchRecordingInstance

Fetch the RecordingInstance

Returns:


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

def fetch
  context.fetch
end

#grouping_sidsHash

Returns A list of SIDs related to the recording.

Returns:

  • (Hash)

    A list of SIDs related to the recording


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

def grouping_sids
  @properties['grouping_sids']
end

#inspectObject

Provide a detailed, user friendly representation


428
429
430
431
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 428

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

Returns The URLs of related resources.

Returns:

  • (String)

    The URLs of related resources


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

def links
  @properties['links']
end

#media_external_locationString

Returns The URL of the media file associated with the recording when stored externally.

Returns:

  • (String)

    The URL of the media file associated with the recording when stored externally


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

def media_external_location
  @properties['media_external_location']
end

#offsetString

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


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

def offset
  @properties['offset']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#sizeString

Returns The size of the recorded track, in bytes.

Returns:

  • (String)

    The size of the recorded track, in bytes


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

def size
  @properties['size']
end

#source_sidString

Returns The SID of the recording source.

Returns:

  • (String)

    The SID of the recording source


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

def source_sid
  @properties['source_sid']
end

#statusrecording.Status

Returns The status of the recording.

Returns:

  • (recording.Status)

    The status of the recording


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

def status
  @properties['status']
end

#status_callbackString

Returns The URL called to send status information on every recording event.

Returns:

  • (String)

    The URL called to send status information on every recording event.


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

def status_callback
  @properties['status_callback']
end

#status_callback_methodString

Returns The HTTP method used to call `status_callback`.

Returns:

  • (String)

    The HTTP method used to call `status_callback`


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

def status_callback_method
  @properties['status_callback_method']
end

#to_sObject

Provide a user friendly representation


421
422
423
424
# File 'lib/twilio-ruby/rest/video/v1/recording.rb', line 421

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

#track_nameString

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


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

def track_name
  @properties['track_name']
end

#typerecording.Type

Returns The recording's media type.

Returns:

  • (recording.Type)

    The recording's media type


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

def type
  @properties['type']
end

#urlString

Returns The absolute URL of the resource.

Returns:

  • (String)

    The absolute URL of the resource


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

def url
  @properties['url']
end