Class: Twilio::REST::Video::V1::CompositionHookInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/video/v1/composition_hook.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) ⇒ CompositionHookInstance

Initialize the CompositionHookInstance

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 CompositionHook resource to fetch.



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 418

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'enabled' => payload['enabled'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'sid' => payload['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'],
      'status_callback' => payload['status_callback'],
      'status_callback_method' => payload['status_callback_method'],
      'url' => payload['url'],
  }

  # 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



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

def 
  @properties['account_sid']
end

#audio_sources ⇒ String

Returns The array of track names to include in the compositions created by the composition hook.

Returns:

  • (String) —

    The array of track names to include in the compositions created by the composition hook



494
495
496
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 494

def audio_sources
  @properties['audio_sources']
end

#audio_sources_excluded ⇒ String

Returns The array of track names to exclude from the compositions created by the composition hook.

Returns:

  • (String) —

    The array of track names to exclude from the compositions created by the composition hook



500
501
502
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 500

def audio_sources_excluded
  @properties['audio_sources_excluded']
end

#context ⇒ CompositionHookContext

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

Returns:



449
450
451
452
453
454
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 449

def context
  unless @instance_context
    @instance_context = CompositionHookContext.new(@version, @params['sid'], )
  end
  @instance_context
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



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:

  • (Time) —

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CompositionHookInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



556
557
558
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 556

def delete
  context.delete
end

#enabled ⇒ Boolean

Returns Whether the CompositionHook is active.

Returns:

  • (Boolean) —

    Whether the CompositionHook is active



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

def enabled
  @properties['enabled']
end

#fetch ⇒ CompositionHookInstance

Fetch the CompositionHookInstance

Returns:



549
550
551
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 549

def fetch
  context.fetch
end

#format ⇒ composition_hook.Format

Returns The container format of the media files used by the compositions created by the composition hook.

Returns:

  • (composition_hook.Format) —

    The container format of the media files used by the compositions created by the composition hook



524
525
526
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 524

def format
  @properties['format']
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



648
649
650
651
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 648

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Video.V1.CompositionHookInstance #{values}>"
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)



512
513
514
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 512

def resolution
  @properties['resolution']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#status_callback ⇒ String

Returns The URL to send status information to your application.

Returns:

  • (String) —

    The URL to send status information to your application



530
531
532
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 530

def status_callback
  @properties['status_callback']
end

#status_callback_method ⇒ String

Returns The HTTP method we should use to call status_callback.

Returns:

  • (String) —

    The HTTP method we should use to call status_callback



536
537
538
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 536

def status_callback_method
  @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



641
642
643
644
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 641

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

#trim ⇒ Boolean

Returns Whether intervals with no media are clipped.

Returns:

  • (Boolean) —

    Whether intervals with no media are clipped



518
519
520
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 518

def trim
  @properties['trim']
end

#update(friendly_name: nil, enabled: :unset, video_layout: :unset, audio_sources: :unset, audio_sources_excluded: :unset, trim: :unset, format: :unset, resolution: :unset, status_callback: :unset, status_callback_method: :unset) ⇒ CompositionHookInstance

Update the CompositionHookInstance

Parameters:

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

    A descriptive string that you create to describe the resource. It can be up to 100 characters long and it must be unique within the account.

  • enabled (Boolean) (defaults to: :unset) —

    Whether the composition hook is active. When ‘true`, the composition hook will be triggered for every completed Group Room in the account. When `false`, the composition hook never triggers.

  • video_layout (Hash) (defaults to: :unset) —

    A JSON object that describes the video layout of the composition hook in terms of regions. See [Specifying Video Layouts](www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.

  • audio_sources (String) (defaults to: :unset) —

    An array of track names from the same group room to merge into the compositions created by the composition hook. Can include zero or more track names. A composition triggered by the composition hook includes all audio sources specified in ‘audio_sources` except those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`.

  • audio_sources_excluded (String) (defaults to: :unset) —

    An array of track names to exclude. A composition triggered by the composition hook includes all audio sources specified in ‘audio_sources` except for those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty.

  • trim (Boolean) (defaults to: :unset) —

    Whether to clip the intervals where there is no active media in the compositions triggered by the composition hook. The default is ‘true`. Compositions with `trim` enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See [Specifying Video Layouts](www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.

  • format (composition_hook.Format) (defaults to: :unset) —

    The container format of the media files used by the compositions created by the composition hook. Can be: ‘mp4` or `webm` and the default is `webm`. If `mp4` or `webm`, `audio_sources` must have one or more tracks and/or a `video_layout` element must contain a valid `video_sources` list, otherwise an error occurs.

  • resolution (String) (defaults to: :unset) —

    A string that describes the columns (width) and rows (height) of the generated composed video in pixels. Defaults to ‘640x480`. The string’s format is ‘widthxheight` where:

    • 16 <= ‘width` <= 1280

    • 16 <= ‘height` <= 1280

    • ‘width` * `height` <= 921,600

    Typical values are:

    • HD = ‘1280x720`

    • PAL = ‘1024x576`

    • VGA = ‘640x480`

    • CIF = ‘320x240`

    Note that the ‘resolution` imposes an aspect ratio to the resulting composition. When the original video tracks are constrained by the aspect ratio, they are scaled to fit. See [Specifying Video Layouts](www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.

  • status_callback (String) (defaults to: :unset) —

    The URL we should call using the ‘status_callback_method` to send status information to your application on every composition event. If not provided, status callback events will not be dispatched.

  • status_callback_method (String) (defaults to: :unset) —

    The HTTP method we should use to call ‘status_callback`. Can be: `POST` or `GET` and the default is `POST`.

Returns:



624
625
626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 624

def update(friendly_name: nil, enabled: :unset, video_layout: :unset, audio_sources: :unset, audio_sources_excluded: :unset, trim: :unset, format: :unset, resolution: :unset, status_callback: :unset, status_callback_method: :unset)
  context.update(
      friendly_name: friendly_name,
      enabled: enabled,
      video_layout: video_layout,
      audio_sources: audio_sources,
      audio_sources_excluded: audio_sources_excluded,
      trim: trim,
      format: format,
      resolution: resolution,
      status_callback: status_callback,
      status_callback_method: status_callback_method,
  )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource



542
543
544
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 542

def url
  @properties['url']
end

#video_layout ⇒ Hash

Returns A JSON object that describes the video layout of the Composition.

Returns:

  • (Hash) —

    A JSON object that describes the video layout of the Composition



506
507
508
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 506

def video_layout
  @properties['video_layout']
end