Class: Twilio::REST::Media::V1::MediaProcessorInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the MediaProcessorInstance

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 MediaProcessor resource.

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

    The SID of the Call resource to fetch.



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 274

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'sid' => payload['sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'extension' => payload['extension'],
        'extension_context' => payload['extension_context'],
        'status' => payload['status'],
        'url' => payload['url'],
        'ended_reason' => payload['ended_reason'],
        'status_callback' => payload['status_callback'],
        'status_callback_method' => payload['status_callback_method'],
        'max_duration' => payload['max_duration'] == nil ? payload['max_duration'] : payload['max_duration'].to_i,
    }

    # 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 MediaProcessor resource.

Returns:



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

def 
    @properties['account_sid']
end

#context ⇒ MediaProcessorContext

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

Returns:



302
303
304
305
306
307
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 302

def context
    unless @instance_context
        @instance_context = MediaProcessorContext.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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#ended_reason ⇒ String

Returns The reason why a MediaProcessor ended. When a MediaProcessor is in progress, will be ‘null`. When a MediaProcessor is completed, can be `ended-via-api`, `max-duration-exceeded`, `error-loading-extension`, `error-streaming-media` or `internal-service-error`. See [ended reasons](/docs/live/api/mediaprocessors#mediaprocessor-ended-reason-values) for more details.

Returns:

  • (String) —

    The reason why a MediaProcessor ended. When a MediaProcessor is in progress, will be ‘null`. When a MediaProcessor is completed, can be `ended-via-api`, `max-duration-exceeded`, `error-loading-extension`, `error-streaming-media` or `internal-service-error`. See [ended reasons](/docs/live/api/mediaprocessors#mediaprocessor-ended-reason-values) for more details.



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

def ended_reason
    @properties['ended_reason']
end

#extension ⇒ String

Returns The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: ‘video-composer-v2`.

Returns:

  • (String) —

    The [Media Extension](/docs/live/media-extensions-overview) name or URL. Ex: ‘video-composer-v2`



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

def extension
    @properties['extension']
end

#extension_context ⇒ String

Returns The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about the context to send.

Returns:

  • (String) —

    The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/media-extensions-overview) you are using for more information about the context to send.



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

def extension_context
    @properties['extension_context']
end

#fetch ⇒ MediaProcessorInstance

Fetch the MediaProcessorInstance

Returns:



384
385
386
387
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 384

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



411
412
413
414
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 411

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

#max_duration ⇒ String

Returns The maximum time, in seconds, that the MediaProcessor can run before automatically ends. The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the MediaProcessor, regardless of whether media is still streaming.

Returns:

  • (String) —

    The maximum time, in seconds, that the MediaProcessor can run before automatically ends. The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the MediaProcessor, regardless of whether media is still streaming.



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

def max_duration
    @properties['max_duration']
end

#sid ⇒ String

Returns The unique string generated to identify the MediaProcessor resource.

Returns:

  • (String) —

    The unique string generated to identify the MediaProcessor resource.



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

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#status_callback ⇒ String

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

Returns:

  • (String) —

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



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

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`.



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

def status_callback_method
    @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



404
405
406
407
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 404

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

#update(status: nil) ⇒ MediaProcessorInstance

Update the MediaProcessorInstance

Parameters:

  • status (UpdateStatus) (defaults to: nil)

Returns:



393
394
395
396
397
398
399
400
 
# File 'lib/twilio-ruby/rest/media/v1/media_processor.rb', line 393

def update(
    status: nil
)

    context.update(
        status: status, 
    )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



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

def url
    @properties['url']
end