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



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
346
347
348
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 320

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' => payload['date_completed'],
      'date_deleted' => 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 



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

def 
  @properties['account_sid']
end

#audio_sources ⇒ String 



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

def audio_sources
  @properties['audio_sources']
end

#audio_sources_excluded ⇒ String 



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

def audio_sources_excluded
  @properties['audio_sources_excluded']
end

#bitrate ⇒ String 



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

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



354
355
356
357
358
359
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 354

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

#date_completed ⇒ String 



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

def date_completed
  @properties['date_completed']
end

#date_created ⇒ Time 



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

def date_created
  @properties['date_created']
end

#date_deleted ⇒ String 



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

def date_deleted
  @properties['date_deleted']
end

#delete ⇒ Boolean

Deletes the CompositionInstance



479
480
481
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 479

def delete
  context.delete
end

#duration ⇒ String 



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

def duration
  @properties['duration']
end

#fetch ⇒ CompositionInstance

Fetch a CompositionInstance



472
473
474
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 472

def fetch
  context.fetch
end

#format ⇒ composition.Format 



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

def format
  @properties['format']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



492
493
494
495
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 492

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

#links ⇒ String 



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

def links
  @properties['links']
end

#resolution ⇒ String 



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

def resolution
  @properties['resolution']
end

#room_sid ⇒ String 



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

def room_sid
  @properties['room_sid']
end

#sid ⇒ String 



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

def sid
  @properties['sid']
end

#size ⇒ String 



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

def size
  @properties['size']
end

#status ⇒ composition.Status 



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



485
486
487
488
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 485

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

#trim ⇒ Boolean 



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

def trim
  @properties['trim']
end

#url ⇒ String 



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

def url
  @properties['url']
end

#video_layout ⇒ Hash 



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

def video_layout
  @properties['video_layout']
end