Class: Twilio::REST::Media::V1::MediaRecordingInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the MediaRecordingInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this MediaRecording resource.

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

    The SID of the Call resource to fetch.



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 247

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
        'format' => payload['format'],
        'links' => payload['links'],
        'processor_sid' => payload['processor_sid'],
        'resolution' => payload['resolution'],
        'source_sid' => payload['source_sid'],
        'sid' => payload['sid'],
        'media_size' => payload['media_size'],
        'status' => payload['status'],
        'status_callback' => payload['status_callback'],
        'status_callback_method' => payload['status_callback_method'],
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the MediaRecording resource.

Returns:



287
288
289
 
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 287

def 
    @properties['account_sid']
end

#context ⇒ MediaRecordingContext

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

Returns:



278
279
280
281
282
283
 
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 278

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



293
294
295
 
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 293

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the MediaRecordingInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



378
379
380
381
 
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 378

def delete

    context.delete
end

#duration ⇒ String

Returns The duration of the MediaRecording in seconds.

Returns:

  • (String) —

    The duration of the MediaRecording in seconds.



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

def duration
    @properties['duration']
end

#fetch ⇒ MediaRecordingInstance

Fetch the MediaRecordingInstance

Returns:



386
387
388
389
 
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 386

def fetch

    context.fetch
end

#format ⇒ Format

Returns:

  • (Format) 


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

def format
    @properties['format']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



400
401
402
403
 
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 400

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



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

def links
    @properties['links']
end

#media_size ⇒ String

Returns The size of the recording media in bytes.

Returns:

  • (String) —

    The size of the recording media in bytes.



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

def media_size
    @properties['media_size']
end

#processor_sid ⇒ String

Returns The SID of the MediaProcessor resource which produced the MediaRecording.

Returns:

  • (String) —

    The SID of the MediaProcessor resource which produced the MediaRecording.



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

def processor_sid
    @properties['processor_sid']
end

#resolution ⇒ String

Returns The dimensions of the video image in pixels expressed as columns (width) and rows (height).

Returns:

  • (String) —

    The dimensions of the video image in pixels expressed as columns (width) and rows (height).



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

def resolution
    @properties['resolution']
end

#sid ⇒ String

Returns The unique string generated to identify the MediaRecording resource.

Returns:

  • (String) —

    The unique string generated to identify the MediaRecording resource.



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

def sid
    @properties['sid']
end

#source_sid ⇒ String

Returns The SID of the resource that generated the original media track(s) of the MediaRecording.

Returns:

  • (String) —

    The SID of the resource that generated the original media track(s) of the MediaRecording.



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

def source_sid
    @properties['source_sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#status_callback ⇒ String

Returns The URL to which Twilio will send asynchronous webhook requests for every MediaRecording event. See [Status Callbacks](/docs/live/status-callbacks) for more details.

Returns:

  • (String) —

    The URL to which Twilio will send asynchronous webhook requests for every MediaRecording event. See [Status Callbacks](/docs/live/status-callbacks) for more details.



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

def status_callback
    @properties['status_callback']
end

#status_callback_method ⇒ String

Returns The HTTP method Twilio should use to call the ‘status_callback` URL. Can be `POST` or `GET` and the default is `POST`.

Returns:

  • (String) —

    The HTTP method Twilio should use to call the ‘status_callback` URL. Can be `POST` or `GET` and the default is `POST`.



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

def status_callback_method
    @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



393
394
395
396
 
# File 'lib/twilio-ruby/rest/media/v1/media_recording.rb', line 393

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



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

def url
    @properties['url']
end