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
# 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,
      'url' => payload['url'],
      'links' => payload['links'],
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#audio_sourcesArray[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


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

def audio_sources
  @properties['audio_sources']
end

#audio_sources_excludedArray[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


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

def audio_sources_excluded
  @properties['audio_sources_excluded']
end

#bitrateString

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

Returns:

  • (String)

    The average bit rate of the composition's media


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

def bitrate
  @properties['bitrate']
end

#contextCompositionContext

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

Returns:


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

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

#date_completedTime

Returns Date when the media processing task finished.

Returns:

  • (Time)

    Date when the media processing task finished


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

def date_completed
  @properties['date_completed']
end

#date_createdTime

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


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

def date_created
  @properties['date_created']
end

#date_deletedTime

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


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

def date_deleted
  @properties['date_deleted']
end

#deleteBoolean

Delete the CompositionInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#durationString

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

Returns:

  • (String)

    The duration of the composition's media file in seconds


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

def duration
  @properties['duration']
end

#fetchCompositionInstance

Fetch the CompositionInstance

Returns:


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

def fetch
  context.fetch
end

#formatcomposition.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


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

def format
  @properties['format']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

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

Returns:

  • (String)

    The URL of the media file associated with the composition


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

def links
  @properties['links']
end

#resolutionString

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)


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

def resolution
  @properties['resolution']
end

#room_sidString

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


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

def room_sid
  @properties['room_sid']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#sizeString

Returns The size of the composed media file in bytes.

Returns:

  • (String)

    The size of the composed media file in bytes


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

def size
  @properties['size']
end

#statuscomposition.Status

Returns The status of the composition.

Returns:

  • (composition.Status)

    The status of the composition


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

def status
  @properties['status']
end

#to_sObject

Provide a user friendly representation


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

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

#trimBoolean

Returns Whether to remove intervals with no media.

Returns:

  • (Boolean)

    Whether to remove intervals with no media


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

def trim
  @properties['trim']
end

#urlString

Returns The absolute URL of the resource.

Returns:

  • (String)

    The absolute URL of the resource


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

def url
  @properties['url']
end

#video_layoutHash

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

Returns:

  • (Hash)

    An object that describes the video layout of the composition


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

def video_layout
  @properties['video_layout']
end