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

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

    The SID of the Composition resource to fetch.



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 316

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'].to_i,
      'size' => payload['size'].to_i,
      'duration' => payload['duration'].to_i,
      'media_external_location' => payload['media_external_location'],
      '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 that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



360
361
362
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 360

def 
  @properties['account_sid']
end

#audio_sources ⇒ Array[String]

Returns The array of track names to include in the composition.

Returns:

  • (Array[String]) —

    The array of track names to include in the composition



402
403
404
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 402

def audio_sources
  @properties['audio_sources']
end

#audio_sources_excluded ⇒ Array[String]

Returns The array of track names to exclude from the composition.

Returns:

  • (Array[String]) —

    The array of track names to exclude from the composition



408
409
410
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 408

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



438
439
440
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 438

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:



351
352
353
354
355
356
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 351

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

#date_completed ⇒ Time

Returns Date when the media processing task finished.

Returns:

  • (Time) —

    Date when the media processing task finished



378
379
380
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 378

def date_completed
  @properties['date_completed']
end

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



372
373
374
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 372

def date_created
  @properties['date_created']
end

#date_deleted ⇒ Time

Returns The ISO 8601 date and time in GMT when the composition generated media was deleted.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the composition generated media was deleted



384
385
386
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 384

def date_deleted
  @properties['date_deleted']
end

#delete ⇒ Boolean

Delete the CompositionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

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



450
451
452
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 450

def duration
  @properties['duration']
end

#fetch ⇒ CompositionInstance

Fetch the CompositionInstance

Returns:



475
476
477
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 475

def fetch
  context.fetch
end

#format ⇒ composition.Format

Returns The container format of the composition’s media files as specified in the POST request that created the Composition resource.

Returns:

  • (composition.Format) —

    The container format of the composition’s media files as specified in the POST request that created the Composition resource



432
433
434
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 432

def format
  @properties['format']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



495
496
497
498
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 495

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

#links ⇒ String

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

Returns:

  • (String) —

    The URL of the media file associated with the composition



468
469
470
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 468

def links
  @properties['links']
end

#media_external_location ⇒ String

Returns The URL of the media file associated with the composition when stored externally.

Returns:

  • (String) —

    The URL of the media file associated with the composition when stored externally



456
457
458
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 456

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

Returns:

  • (String) —

    The dimensions of the video image in pixels expressed as columns (width) and rows (height)



420
421
422
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 420

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.

Returns:

  • (String) —

    The SID of the Group Room that generated the audio and video tracks used in the composition



396
397
398
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 396

def room_sid
  @properties['room_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



390
391
392
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 390

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



444
445
446
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 444

def size
  @properties['size']
end

#status ⇒ composition.Status

Returns The status of the composition.

Returns:

  • (composition.Status) —

    The status of the composition



366
367
368
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 366

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



488
489
490
491
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 488

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.

Returns:

  • (Boolean) —

    Whether to remove intervals with no media



426
427
428
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 426

def trim
  @properties['trim']
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource



462
463
464
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 462

def url
  @properties['url']
end

#video_layout ⇒ Hash

Returns An object that describes the video layout of the composition.

Returns:

  • (Hash) —

    An object that describes the video layout of the composition



414
415
416
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 414

def video_layout
  @properties['video_layout']
end