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



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

def initialize(version)
  super(version)

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

Instance Method Details

#create(audio_sources: :unset, video_sources: :unset, video_layout: :unset, resolution: :unset, format: :unset, desired_bitrate: :unset, desired_max_duration: :unset, status_callback: :unset, status_callback_method: :unset, trim: :unset, reuse: :unset) ⇒ CompositionInstance

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

Parameters:

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

    The audio_sources

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

    The video_sources

  • video_layout (composition.VideoLayout) (defaults to: :unset) —

    The video_layout

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

    The resolution

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

    The format

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

    The desired_bitrate

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

    The desired_max_duration

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

    The status_callback

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

    The status_callback_method

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

    The trim

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

    The reuse

Returns:



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 146

def create(audio_sources: :unset, video_sources: :unset, video_layout: :unset, resolution: :unset, format: :unset, desired_bitrate: :unset, desired_max_duration: :unset, status_callback: :unset, status_callback_method: :unset, trim: :unset, reuse: :unset)
  data = Twilio::Values.of({
      'AudioSources' => Twilio.serialize_list(audio_sources) { |e| e },
      'VideoSources' => Twilio.serialize_list(video_sources) { |e| e },
      'VideoLayout' => video_layout,
      'Resolution' => resolution,
      'Format' => format,
      'DesiredBitrate' => desired_bitrate,
      'DesiredMaxDuration' => desired_max_duration,
      'StatusCallback' => status_callback,
      'StatusCallbackMethod' => status_callback_method,
      'Trim' => trim,
      'Reuse' => reuse,
  })

  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.



81
82
83
84
85
86
87
88
89
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 81

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



123
124
125
126
127
128
129
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 123

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, 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) —

    The status

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

    The date_created_after

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

    The date_created_before

  • 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



40
41
42
43
44
45
46
47
48
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 40

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

#page(status: :unset, date_created_after: :unset, date_created_before: :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) —

    The status

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

    The date_created_after

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

    The date_created_before

  • 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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 101

def page(status: :unset, date_created_after: :unset, date_created_before: :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),
      '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, 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) —

    The status

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

    The date_created_after

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

    The date_created_before

  • 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



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 64

def stream(status: :unset, date_created_after: :unset, date_created_before: :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,
      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



172
173
174
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 172

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