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

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/video/v1/composition.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ CompositionList

Initialize the CompositionList



26
27
28
29
30
31
32
33
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 26

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/Compositions"
    
end

Instance Method Details

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

Create the CompositionInstance



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 46

def create(
    room_sid: nil, 
    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,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    CompositionInstance.new(
        @version,
        payload,
    )
end

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

Create the CompositionInstanceMetadata



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 95

def create_with_metadata(
  room_sid: nil, 
  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,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    composition_instance = CompositionInstance.new(
        @version,
        response.body,
    )
    CompositionInstanceMetadata.new(
        @version,
        composition_instance,
        response.headers,
        response.status_code
    )
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.



227
228
229
230
231
232
233
234
235
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 227

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.



272
273
274
275
276
277
278
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 272

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.



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

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

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



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

def list_with_metadata(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)
    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,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

    response = @version.page('GET', @uri, params: params, headers: headers)

    CompositionPageMetadata.new(@version, response, @solution, limits[:limit])
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.



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 248

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,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    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 Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 180

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



283
284
285
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 283

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