Class: Twilio::REST::Video::V1::CompositionHookInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the CompositionHookInstance



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 359

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'friendly_name' => payload['friendly_name'],
        'enabled' => payload['enabled'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'sid' => payload['sid'],
        'audio_sources' => payload['audio_sources'],
        'audio_sources_excluded' => payload['audio_sources_excluded'],
        'video_layout' => payload['video_layout'],
        'resolution' => payload['resolution'],
        'trim' => payload['trim'],
        'format' => payload['format'],
        '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 



399
400
401
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 399

def 
    @properties['account_sid']
end

#audio_sources ⇒ Array<String> 



435
436
437
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 435

def audio_sources
    @properties['audio_sources']
end

#audio_sources_excluded ⇒ Array<String> 



441
442
443
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 441

def audio_sources_excluded
    @properties['audio_sources_excluded']
end

#context ⇒ CompositionHookContext

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



390
391
392
393
394
395
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 390

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

#date_created ⇒ Time 



417
418
419
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 417

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



423
424
425
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 423

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CompositionHookInstance



490
491
492
493
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 490

def delete

    context.delete
end

#enabled ⇒ Boolean 



411
412
413
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 411

def enabled
    @properties['enabled']
end

#fetch ⇒ CompositionHookInstance

Fetch the CompositionHookInstance



498
499
500
501
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 498

def fetch

    context.fetch
end

#format ⇒ Format 



465
466
467
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 465

def format
    @properties['format']
end

#friendly_name ⇒ String 



405
406
407
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 405

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



552
553
554
555
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 552

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

#resolution ⇒ String 



453
454
455
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 453

def resolution
    @properties['resolution']
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#status_callback ⇒ String 



471
472
473
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 471

def status_callback
    @properties['status_callback']
end

#status_callback_method ⇒ String 



477
478
479
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 477

def status_callback_method
    @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



545
546
547
548
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 545

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

#trim ⇒ Boolean 



459
460
461
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 459

def trim
    @properties['trim']
end

#update(friendly_name: nil, enabled: :unset, video_layout: :unset, audio_sources: :unset, audio_sources_excluded: :unset, trim: :unset, format: :unset, resolution: :unset, status_callback: :unset, status_callback_method: :unset) ⇒ CompositionHookInstance

Update the CompositionHookInstance



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 516

def update(
    friendly_name: nil, 
    enabled: :unset, 
    video_layout: :unset, 
    audio_sources: :unset, 
    audio_sources_excluded: :unset, 
    trim: :unset, 
    format: :unset, 
    resolution: :unset, 
    status_callback: :unset, 
    status_callback_method: :unset
)

    context.update(
        friendly_name: friendly_name, 
        enabled: enabled, 
        video_layout: video_layout, 
        audio_sources: audio_sources, 
        audio_sources_excluded: audio_sources_excluded, 
        trim: trim, 
        format: format, 
        resolution: resolution, 
        status_callback: status_callback, 
        status_callback_method: status_callback_method, 
    )
end

#url ⇒ String 



483
484
485
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 483

def url
    @properties['url']
end

#video_layout ⇒ Hash 



447
448
449
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 447

def video_layout
    @properties['video_layout']
end