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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 267

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

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



310
311
312
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 310

def 
  @properties['account_sid']
end

#audio_sources ⇒ String

Returns The audio_sources.

Returns:

  • (String) —

    The audio_sources



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

def audio_sources
  @properties['audio_sources']
end

#audio_sources_excluded ⇒ String

Returns The audio_sources_excluded.

Returns:

  • (String) —

    The audio_sources_excluded



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

def audio_sources_excluded
  @properties['audio_sources_excluded']
end

#bitrate ⇒ String

Returns The bitrate.

Returns:

  • (String) —

    The bitrate



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

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:



301
302
303
304
305
306
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 301

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

#date_completed ⇒ String

Returns The date_completed.

Returns:

  • (String) —

    The date_completed



328
329
330
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 328

def date_completed
  @properties['date_completed']
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



322
323
324
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 322

def date_created
  @properties['date_created']
end

#date_deleted ⇒ String

Returns The date_deleted.

Returns:

  • (String) —

    The date_deleted



334
335
336
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 334

def date_deleted
  @properties['date_deleted']
end

#delete ⇒ Boolean

Deletes the CompositionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#duration ⇒ String

Returns The duration.

Returns:

  • (String) —

    The duration



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

def duration
  @properties['duration']
end

#fetch ⇒ CompositionInstance

Fetch a CompositionInstance

Returns:



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

def fetch
  context.fetch
end

#format ⇒ composition.Format

Returns The format.

Returns:

  • (composition.Format) —

    The format



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

def format
  @properties['format']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#resolution ⇒ String

Returns The resolution.

Returns:

  • (String) —

    The resolution



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

def resolution
  @properties['resolution']
end

#room_sid ⇒ String

Returns The room_sid.

Returns:

  • (String) —

    The room_sid



346
347
348
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 346

def room_sid
  @properties['room_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



340
341
342
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 340

def sid
  @properties['sid']
end

#size ⇒ String

Returns The size.

Returns:

  • (String) —

    The size



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

def size
  @properties['size']
end

#status ⇒ composition.Status

Returns The status.

Returns:

  • (composition.Status) —

    The status



316
317
318
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 316

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#trim ⇒ Boolean

Returns The trim.

Returns:

  • (Boolean) —

    The trim



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

def trim
  @properties['trim']
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end

#video_layout ⇒ Hash

Returns The video_layout.

Returns:

  • (Hash) —

    The video_layout



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

def video_layout
  @properties['video_layout']
end