Class: Twilio::REST::Video::V1::CompositionInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the CompositionInstance

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

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

    The SID of the Call resource to fetch.



543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 543

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']),
        'date_completed' => Twilio.deserialize_iso8601_datetime(payload['date_completed']),
        'date_deleted' => Twilio.deserialize_iso8601_datetime(payload['date_deleted']),
        'sid' => payload['sid'],
        'room_sid' => payload['room_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'],
        'bitrate' => payload['bitrate'] == nil ? payload['bitrate'] : payload['bitrate'].to_i,
        'size' => payload['size'],
        'duration' => payload['duration'] == nil ? payload['duration'] : payload['duration'].to_i,
        'media_external_location' => payload['media_external_location'],
        'status_callback' => payload['status_callback'],
        'status_callback_method' => payload['status_callback_method'],
        'url' => payload['url'],
        'links' => payload['links'],
    }

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

Returns:



590
591
592
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 590

def 
    @properties['account_sid']
end

#audio_sources ⇒ Array<String>

Returns The array of track names to include in the composition. The composition includes all audio sources specified in audio_sources except those specified in audio_sources_excluded. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, student* includes tracks named student as well as studentTeam.

Returns:

  • (Array<String>) —

    The array of track names to include in the composition. The composition includes all audio sources specified in audio_sources except those specified in audio_sources_excluded. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, student* includes tracks named student as well as studentTeam.



632
633
634
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 632

def audio_sources
    @properties['audio_sources']
end

#audio_sources_excluded ⇒ Array<String>

Returns The array of track names to exclude from the composition. The composition includes all audio sources specified in audio_sources except for those specified in audio_sources_excluded. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, student* excludes student as well as studentTeam. This parameter can also be empty.

Returns:

  • (Array<String>) —

    The array of track names to exclude from the composition. The composition includes all audio sources specified in audio_sources except for those specified in audio_sources_excluded. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, student* excludes student as well as studentTeam. This parameter can also be empty.



638
639
640
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 638

def audio_sources_excluded
    @properties['audio_sources_excluded']
end

#bitrate ⇒ String

Returns The average bit rate of the composition’s media.

Returns:

  • (String) —

    The average bit rate of the composition’s media.



668
669
670
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 668

def bitrate
    @properties['bitrate']
end

#context ⇒ CompositionContext

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

Returns:



581
582
583
584
585
586
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 581

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

#date_completed ⇒ Time

Returns The date and time in GMT when the composition’s media processing task finished, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:

  • (Time) —

    The date and time in GMT when the composition’s media processing task finished, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.



608
609
610
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 608

def date_completed
    @properties['date_completed']
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:



602
603
604
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 602

def date_created
    @properties['date_created']
end

#date_deleted ⇒ Time

Returns The date and time in GMT when the composition generated media was deleted, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:

  • (Time) —

    The date and time in GMT when the composition generated media was deleted, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.



614
615
616
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 614

def date_deleted
    @properties['date_deleted']
end

#delete ⇒ Boolean

Delete the CompositionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



717
718
719
720
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 717

def delete

    context.delete
end

#duration ⇒ String

Returns The duration of the composition’s media file in seconds.

Returns:

  • (String) —

    The duration of the composition’s media file in seconds.



680
681
682
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 680

def duration
    @properties['duration']
end

#fetch ⇒ CompositionInstance

Fetch the CompositionInstance

Returns:



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

def fetch

    context.fetch
end

#format ⇒ Format

Returns:

  • (Format) 


662
663
664
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 662

def format
    @properties['format']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



739
740
741
742
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 739

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

#links ⇒ Hash

Returns The URL of the media file associated with the composition.

Returns:

  • (Hash) —

    The URL of the media file associated with the composition.



710
711
712
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 710

def links
    @properties['links']
end

#media_external_location ⇒ String

Returns The URL of the media file associated with the composition when stored externally. See [External S3 Compositions](/docs/video/api/external-s3-compositions) for more details.

Returns:

  • (String) —

    The URL of the media file associated with the composition when stored externally. See [External S3 Compositions](/docs/video/api/external-s3-compositions) for more details.



686
687
688
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 686

def media_external_location
    @properties['media_external_location']
end

#resolution ⇒ String

Returns The dimensions of the video image in pixels expressed as columns (width) and rows (height). The string’s format is ‘widthxheight`, such as 640x480.

Returns:

  • (String) —

    The dimensions of the video image in pixels expressed as columns (width) and rows (height). The string’s format is ‘widthxheight`, such as 640x480.



650
651
652
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 650

def resolution
    @properties['resolution']
end

#room_sid ⇒ String

Returns The SID of the Group Room that generated the audio and video tracks used in the composition. All media sources included in a composition must belong to the same Group Room.

Returns:

  • (String) —

    The SID of the Group Room that generated the audio and video tracks used in the composition. All media sources included in a composition must belong to the same Group Room.



626
627
628
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 626

def room_sid
    @properties['room_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Composition resource.

Returns:

  • (String) —

    The unique string that we created to identify the Composition resource.



620
621
622
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 620

def sid
    @properties['sid']
end

#size ⇒ String

Returns The size of the composed media file in bytes.

Returns:

  • (String) —

    The size of the composed media file in bytes.



674
675
676
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 674

def size
    @properties['size']
end

#status ⇒ Status

Returns:

  • (Status) 


596
597
598
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 596

def status
    @properties['status']
end

#status_callback ⇒ String

Returns The URL called using the status_callback_method to send status information on every composition event.

Returns:

  • (String) —

    The URL called using the status_callback_method to send status information on every composition event.



692
693
694
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 692

def status_callback
    @properties['status_callback']
end

#status_callback_method ⇒ String

Returns The HTTP method used to call status_callback. Can be: POST or GET, defaults to POST.

Returns:

  • (String) —

    The HTTP method used to call status_callback. Can be: POST or GET, defaults to POST.



698
699
700
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 698

def status_callback_method
    @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#trim ⇒ Boolean

Returns Whether to remove intervals with no media, as specified in the POST request that created the composition. Compositions with trim enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See [Specifying Video Layouts](www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.

Returns:

  • (Boolean) —

    Whether to remove intervals with no media, as specified in the POST request that created the composition. Compositions with trim enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See [Specifying Video Layouts](www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.



656
657
658
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 656

def trim
    @properties['trim']
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



704
705
706
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 704

def url
    @properties['url']
end

#video_layout ⇒ Hash

Returns An object that describes the video layout of the composition in terms of regions. See [Specifying Video Layouts](www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.

Returns:



644
645
646
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 644

def video_layout
    @properties['video_layout']
end