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



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 661

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 



702
703
704
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 702

def 
    @properties['account_sid']
end

#audio_sources ⇒ Array<String> 



738
739
740
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 738

def audio_sources
    @properties['audio_sources']
end

#audio_sources_excluded ⇒ Array<String> 



744
745
746
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 744

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



693
694
695
696
697
698
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 693

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

#date_created ⇒ Time 



720
721
722
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 720

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



726
727
728
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 726

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CompositionHookInstance



793
794
795
796
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 793

def delete

    context.delete
end

#enabled ⇒ Boolean 



714
715
716
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 714

def enabled
    @properties['enabled']
end

#fetch ⇒ CompositionHookInstance

Fetch the CompositionHookInstance



801
802
803
804
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 801

def fetch

    context.fetch
end

#format ⇒ Format 



768
769
770
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 768

def format
    @properties['format']
end

#friendly_name ⇒ String 



708
709
710
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 708

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



855
856
857
858
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 855

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

#resolution ⇒ String 



756
757
758
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 756

def resolution
    @properties['resolution']
end

#sid ⇒ String 



732
733
734
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 732

def sid
    @properties['sid']
end

#status_callback ⇒ String 



774
775
776
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 774

def status_callback
    @properties['status_callback']
end

#status_callback_method ⇒ String 



780
781
782
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 780

def status_callback_method
    @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



848
849
850
851
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 848

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

#trim ⇒ Boolean 



762
763
764
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 762

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



819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 819

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 



786
787
788
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 786

def url
    @properties['url']
end

#video_layout ⇒ Hash 



750
751
752
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 750

def video_layout
    @properties['video_layout']
end