Class: Twilio::REST::Video::V1::CompositionHookList

Inherits:
ListResource
  • Object
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) ⇒ CompositionHookList

Initialize the CompositionHookList

Parameters:

  • version (Version) —

    Version that contains the resource



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 20

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/CompositionHooks"
end

Instance Method Details

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

Retrieve a single page of CompositionHookInstance records from the API. Request is executed immediately.

Parameters:

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

    Friendly name of the Composition Hook to be shown in the console, must be unique per account and up to 100 characters.

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

    Boolean flag indicating if the Composition Hook is active. Possible values are ‘true` or `false`. When `true`, the Composition Hook will be triggered for every completed Group Room on this account. When `false`, the Composition Hook never triggers.

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

    A JSON object defining the video layout of the Composition Hook in terms of regions. See the section [Specifying Video Layouts](www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for further information.

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

    An array of audio sources to merge. All the specified sources must belong to the same Group Room. It can include zero or more Track names. These can be specified using wildcards (e.g. ‘student*`). The use of `[*]` has semantics “all if any” meaning zero or more (i.e. all) depending on whether the Group Room had audio tracks.

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

    An array of audio sources to exclude from the Composition Hook. Any new Composition triggered by the Composition Hook shall include all audio sources specified in ‘AudioSources` except for the ones specified in `AudioSourcesExcluded`. This parameter may include zero or more Track names. These can be specified using wildcards (e.g. `student*`).

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

    A string representing the number of pixels for rows (width) and columns (height) of the generated composed video. This string must have the format ‘widthxheight`. This parameter must comply with the following constraints:

    • ‘width >= 16 && width <= 1280`

    • ‘height >= 16 && height <= 1280`

    • ‘width * height <= 921,600`

    Typical values are:

    • HD = ‘1280x720`

    • PAL = ‘1024x576`

    • VGA = ‘640x480`

    • CIF = ‘320x240`

    Note that the ‘Resolution` implicitly imposes an aspect ratio to the resulting composition. When the original video tracks get constrained by this aspect ratio they are scaled-down to fit. You can find detailed information in the [Specifying Video Layouts](www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) section. Defaults to `640x480`.

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

    Container format of the Composition media files created by the Composition Hook. Can be any of the following: ‘mp4`, `webm`. The use of `mp4` or `webm` makes mandatory the specification of `AudioSources` and/or one `VideoLayout` element containing a valid `video_sources` list, otherwise an error is fired. Defaults to `webm`.

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

    A URL that Twilio sends asynchronous webhook requests to on every composition event. If not provided, status callback events will not be dispatched.

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

    HTTP method Twilio should use when requesting the above URL. Defaults to ‘POST`.

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

    When activated, clips all the intervals where there is no active media in the Compositions triggered by the Composition Hook. This results in shorter compositions in cases when the Room was created but no Participant joined for some time, or if all the Participants left the room and joined at a later stage, as those gaps will be removed. You can find further information in the [Specifying Video Layouts](www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) section. Defaults to ‘true`.

Returns:



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 224

def create(friendly_name: nil, enabled: :unset, video_layout: :unset, audio_sources: :unset, audio_sources_excluded: :unset, resolution: :unset, format: :unset, status_callback: :unset, status_callback_method: :unset, trim: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'Enabled' => enabled,
      'VideoLayout' => Twilio.serialize_object(video_layout),
      'AudioSources' => Twilio.serialize_list(audio_sources) { |e| e },
      'AudioSourcesExcluded' => Twilio.serialize_list(audio_sources_excluded) { |e| e },
      'Resolution' => resolution,
      'Format' => format,
      'StatusCallback' => status_callback,
      'StatusCallbackMethod' => status_callback_method,
      'Trim' => trim,
  })

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  CompositionHookInstance.new(@version, payload, )
end

#each ⇒ Object

When passed a block, yields CompositionHookInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



103
104
105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 103

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of CompositionHookInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of CompositionHookInstance



155
156
157
158
159
160
161
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 155

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  CompositionHookPage.new(@version, response, @solution)
end

#list(enabled: :unset, date_created_after: :unset, date_created_before: :unset, friendly_name: :unset, limit: nil, page_size: nil) ⇒ Array

Lists CompositionHookInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

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

    Only show Composition Hooks that are enabled or disabled.

  • date_created_after (Time) (defaults to: :unset) —

    Only show Composition Hooks created on or after this ISO8601 date-time with timezone, given as ‘YYYY-MM-DDThh:mm:ss+|-hh:mm` or `YYYY-MM-DDThh:mm:ssZ`.

  • date_created_before (Time) (defaults to: :unset) —

    Only show Composition Hooks created before this ISO8601 date-time with timezone, given as ‘YYYY-MM-DDThh:mm:ss+|-hh:mm` or `YYYY-MM-DDThh:mm:ssZ`.

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

    Only show Composition Hooks with friendly name that match this case-insensitive string, of up to 100 characters in length. Filtering by partial friendly names is allowed, using wildcards (e.g. ‘*my*hook*`).

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 51

def list(enabled: :unset, date_created_after: :unset, date_created_before: :unset, friendly_name: :unset, limit: nil, page_size: nil)
  self.stream(
      enabled: enabled,
      date_created_after: date_created_after,
      date_created_before: date_created_before,
      friendly_name: friendly_name,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(enabled: :unset, date_created_after: :unset, date_created_before: :unset, friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of CompositionHookInstance records from the API. Request is executed immediately.

Parameters:

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

    Only show Composition Hooks that are enabled or disabled.

  • date_created_after (Time) (defaults to: :unset) —

    Only show Composition Hooks created on or after this ISO8601 date-time with timezone, given as ‘YYYY-MM-DDThh:mm:ss+|-hh:mm` or `YYYY-MM-DDThh:mm:ssZ`.

  • date_created_before (Time) (defaults to: :unset) —

    Only show Composition Hooks created before this ISO8601 date-time with timezone, given as ‘YYYY-MM-DDThh:mm:ss+|-hh:mm` or `YYYY-MM-DDThh:mm:ssZ`.

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

    Only show Composition Hooks with friendly name that match this case-insensitive string, of up to 100 characters in length. Filtering by partial friendly names is allowed, using wildcards (e.g. ‘*my*hook*`).

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

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of CompositionHookInstance



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 132

def page(enabled: :unset, date_created_after: :unset, date_created_before: :unset, friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Enabled' => enabled,
      'DateCreatedAfter' => Twilio.serialize_iso8601_datetime(date_created_after),
      'DateCreatedBefore' => Twilio.serialize_iso8601_datetime(date_created_before),
      'FriendlyName' => friendly_name,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  CompositionHookPage.new(@version, response, @solution)
end

#stream(enabled: :unset, date_created_after: :unset, date_created_before: :unset, friendly_name: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams CompositionHookInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

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

    Only show Composition Hooks that are enabled or disabled.

  • date_created_after (Time) (defaults to: :unset) —

    Only show Composition Hooks created on or after this ISO8601 date-time with timezone, given as ‘YYYY-MM-DDThh:mm:ss+|-hh:mm` or `YYYY-MM-DDThh:mm:ssZ`.

  • date_created_before (Time) (defaults to: :unset) —

    Only show Composition Hooks created before this ISO8601 date-time with timezone, given as ‘YYYY-MM-DDThh:mm:ss+|-hh:mm` or `YYYY-MM-DDThh:mm:ssZ`.

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

    Only show Composition Hooks with friendly name that match this case-insensitive string, of up to 100 characters in length. Filtering by partial friendly names is allowed, using wildcards (e.g. ‘*my*hook*`).

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 85

def stream(enabled: :unset, date_created_after: :unset, date_created_before: :unset, friendly_name: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      enabled: enabled,
      date_created_after: date_created_after,
      date_created_before: date_created_before,
      friendly_name: friendly_name,
      page_size: limits[:page_size],
  )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



249
250
251
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 249

def to_s
  '#<Twilio.Video.V1.CompositionHookList>'
end