class Twilio::REST::Video::V1::CompositionInstance
Public Class Methods
Initialize the CompositionInstance
@param [Version] version Version
that contains the resource @param [Hash] payload payload that contains response from Twilio
@param [String] sid The SID of the Composition resource to fetch. @return [CompositionInstance] CompositionInstance
Twilio::REST::InstanceResource::new
# File lib/twilio-ruby/rest/video/v1/composition.rb 316 def initialize(version, payload, sid: nil) 317 super(version) 318 319 # Marshaled Properties 320 @properties = { 321 'account_sid' => payload['account_sid'], 322 'status' => payload['status'], 323 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 324 'date_completed' => Twilio.deserialize_iso8601_datetime(payload['date_completed']), 325 'date_deleted' => Twilio.deserialize_iso8601_datetime(payload['date_deleted']), 326 'sid' => payload['sid'], 327 'room_sid' => payload['room_sid'], 328 'audio_sources' => payload['audio_sources'], 329 'audio_sources_excluded' => payload['audio_sources_excluded'], 330 'video_layout' => payload['video_layout'], 331 'resolution' => payload['resolution'], 332 'trim' => payload['trim'], 333 'format' => payload['format'], 334 'bitrate' => payload['bitrate'].to_i, 335 'size' => payload['size'].to_i, 336 'duration' => payload['duration'].to_i, 337 'url' => payload['url'], 338 'links' => payload['links'], 339 } 340 341 # Context 342 @instance_context = nil 343 @params = {'sid' => sid || @properties['sid'], } 344 end
Public Instance Methods
@return [String] The SID of the Account that created the resource
# File lib/twilio-ruby/rest/video/v1/composition.rb 359 def account_sid 360 @properties['account_sid'] 361 end
@return [Array] The array of track names to include in the composition
# File lib/twilio-ruby/rest/video/v1/composition.rb 401 def audio_sources 402 @properties['audio_sources'] 403 end
@return [Array] The array of track names to exclude from the composition
# File lib/twilio-ruby/rest/video/v1/composition.rb 407 def audio_sources_excluded 408 @properties['audio_sources_excluded'] 409 end
@return [String] The average bit rate of the composition's media
# File lib/twilio-ruby/rest/video/v1/composition.rb 437 def bitrate 438 @properties['bitrate'] 439 end
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context @return [CompositionContext] CompositionContext
for this CompositionInstance
# File lib/twilio-ruby/rest/video/v1/composition.rb 350 def context 351 unless @instance_context 352 @instance_context = CompositionContext.new(@version, @params['sid'], ) 353 end 354 @instance_context 355 end
@return [Time] Date when the media processing task finished
# File lib/twilio-ruby/rest/video/v1/composition.rb 377 def date_completed 378 @properties['date_completed'] 379 end
@return [Time] The ISO 8601 date and time in GMT when the resource was created
# File lib/twilio-ruby/rest/video/v1/composition.rb 371 def date_created 372 @properties['date_created'] 373 end
@return [Time] The ISO 8601 date and time in GMT when the composition generated media was deleted
# File lib/twilio-ruby/rest/video/v1/composition.rb 383 def date_deleted 384 @properties['date_deleted'] 385 end
Delete the CompositionInstance
@return [Boolean] true if delete succeeds, false otherwise
# File lib/twilio-ruby/rest/video/v1/composition.rb 475 def delete 476 context.delete 477 end
@return [String] The duration of the composition's media file in seconds
# File lib/twilio-ruby/rest/video/v1/composition.rb 449 def duration 450 @properties['duration'] 451 end
Fetch the CompositionInstance
@return [CompositionInstance] Fetched CompositionInstance
# File lib/twilio-ruby/rest/video/v1/composition.rb 468 def fetch 469 context.fetch 470 end
@return [composition.Format] The container format of the composition's media files as specified in the POST request that created the Composition resource
# File lib/twilio-ruby/rest/video/v1/composition.rb 431 def format 432 @properties['format'] 433 end
Provide a detailed, user friendly representation
# File lib/twilio-ruby/rest/video/v1/composition.rb 488 def inspect 489 values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") 490 "<Twilio.Video.V1.CompositionInstance #{values}>" 491 end
@return [String] The URL of the media file associated with the composition
# File lib/twilio-ruby/rest/video/v1/composition.rb 461 def links 462 @properties['links'] 463 end
@return [String] The dimensions of the video image in pixels expressed as columns (width) and rows (height)
# File lib/twilio-ruby/rest/video/v1/composition.rb 419 def resolution 420 @properties['resolution'] 421 end
@return [String] The SID of the Group Room that generated the audio and video tracks used in the composition
# File lib/twilio-ruby/rest/video/v1/composition.rb 395 def room_sid 396 @properties['room_sid'] 397 end
@return [String] The unique string that identifies the resource
# File lib/twilio-ruby/rest/video/v1/composition.rb 389 def sid 390 @properties['sid'] 391 end
@return [String] The size of the composed media file in bytes
# File lib/twilio-ruby/rest/video/v1/composition.rb 443 def size 444 @properties['size'] 445 end
@return [composition.Status] The status of the composition
# File lib/twilio-ruby/rest/video/v1/composition.rb 365 def status 366 @properties['status'] 367 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/video/v1/composition.rb 481 def to_s 482 values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") 483 "<Twilio.Video.V1.CompositionInstance #{values}>" 484 end
@return [Boolean] Whether to remove intervals with no media
# File lib/twilio-ruby/rest/video/v1/composition.rb 425 def trim 426 @properties['trim'] 427 end
@return [String] The absolute URL of the resource
# File lib/twilio-ruby/rest/video/v1/composition.rb 455 def url 456 @properties['url'] 457 end
@return [Hash] An object that describes the video layout of the composition
# File lib/twilio-ruby/rest/video/v1/composition.rb 413 def video_layout 414 @properties['video_layout'] 415 end