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

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

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.



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 324

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,
      '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



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

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



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

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



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

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



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

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:



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

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



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

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



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

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



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

def date_deleted
  @properties['date_deleted']
end

#delete ⇒ Boolean

Delete the CompositionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

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



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

def duration
  @properties['duration']
end

#fetch ⇒ CompositionInstance

Fetch the CompositionInstance

Returns:



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

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



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

def format
  @properties['format']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

def links
  @properties['links']
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)



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

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



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

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



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

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



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

def size
  @properties['size']
end

#status ⇒ composition.Status

Returns The status of the composition.

Returns:

  • (composition.Status) —

    The status of the composition



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

def trim
  @properties['trim']
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource



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

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



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

def video_layout
  @properties['video_layout']
end