Class: Twilio::REST::Video::V1::CompositionList

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

Initialize the CompositionList

Parameters:

  • version (Version) —

    Version that contains the resource



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

def initialize(version)
  super(version)

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

Instance Method Details

#create(room_sid: :unset, video_layout: :unset, audio_sources: :unset, audio_sources_excluded: :unset, resolution: :unset, format: :unset, status_callback: :unset, status_callback_method: :unset, trim: :unset) ⇒ CompositionInstance

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

Parameters:

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

    Group Room SID owning the media tracks to be used as Composition sources.

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

    A JSON object defining the video layout of the Composition in terms of regions. See the section [Managing Video Layouts](#managing-video-layouts) below 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 ‘RecordingTrackSid`

    • Zero or more ‘MediaTrackSid`

    • Zero or more ‘ParticipantSid`

    • 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 target room had audio tracks.

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

    An array of audio sources to exclude from the Composition. Any new Composition shall include all audio sources specified in ‘AudioSources` except for the ones specified in `AudioSourcesExcluded`. This parameter may include:

    • Zero or more ‘RecordingTrackSid`

    • Zero or more ‘MediaTrackSid`

    • Zero or more ‘ParticipantSid`

    • Zero or more Track names. These can be specified using wildcards (e.g.

    ‘student*`)

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

    A string representing the numbers 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 [Managing Video Layouts](#managing-video-layouts) section. Defaults to `640x480`.

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

    Container format of the Composition media file. 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 Composition intervals where there is no active media. 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 [Managing Video Layouts](#managing-video-layouts) section. Defaults to ‘true`.

Returns:



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 203

def create(room_sid: :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({
      'RoomSid' => room_sid,
      '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
  )

  CompositionInstance.new(@version, payload, )
end

#each ⇒ Object

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



91
92
93
94
95
96
97
98
99
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 91

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 CompositionInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of CompositionInstance



137
138
139
140
141
142
143
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 137

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

#list(status: :unset, date_created_after: :unset, date_created_before: :unset, room_sid: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

  • status (composition.Status) (defaults to: :unset) —

    Only show Compositions with the given status.

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

    Only show Compositions that started on or after this ISO8601 date-time, given as ‘YYYY-MM-DDThh:mm:ss-hh:mm`.

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

    Only show Compositions that started before this this ISO8601 date-time, given as ‘YYYY-MM-DDThh:mm:ss-hh:mm`.

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

    Only show Compositions with the given Room SID.

  • 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



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 45

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

#page(status: :unset, date_created_after: :unset, date_created_before: :unset, room_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

  • status (composition.Status) (defaults to: :unset) —

    Only show Compositions with the given status.

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

    Only show Compositions that started on or after this ISO8601 date-time, given as ‘YYYY-MM-DDThh:mm:ss-hh:mm`.

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

    Only show Compositions that started before this this ISO8601 date-time, given as ‘YYYY-MM-DDThh:mm:ss-hh:mm`.

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

    Only show Compositions with the given Room SID.

  • 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 CompositionInstance



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 114

def page(status: :unset, date_created_after: :unset, date_created_before: :unset, room_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Status' => status,
      'DateCreatedAfter' => Twilio.serialize_iso8601_datetime(date_created_after),
      'DateCreatedBefore' => Twilio.serialize_iso8601_datetime(date_created_before),
      'RoomSid' => room_sid,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  CompositionPage.new(@version, response, @solution)
end

#stream(status: :unset, date_created_after: :unset, date_created_before: :unset, room_sid: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • status (composition.Status) (defaults to: :unset) —

    Only show Compositions with the given status.

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

    Only show Compositions that started on or after this ISO8601 date-time, given as ‘YYYY-MM-DDThh:mm:ss-hh:mm`.

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

    Only show Compositions that started before this this ISO8601 date-time, given as ‘YYYY-MM-DDThh:mm:ss-hh:mm`.

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

    Only show Compositions with the given Room SID.

  • 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



73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 73

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

  page = self.page(
      status: status,
      date_created_after: date_created_after,
      date_created_before: date_created_before,
      room_sid: room_sid,
      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



227
228
229
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 227

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