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

Parameters:

  • version (Version) —

    Version that contains the resource



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

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

Parameters:

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

    The SID of the Group Room with the media tracks to be used as composition sources.

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

    An object that describes the video layout of the composition in terms of regions. See [Specifying Video Layouts](www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request

  • audio_sources (Array[String]) (defaults to: :unset) —

    An array of track names from the same group room to merge into the new composition. Can include zero or more track names. The new composition 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 will match zero or more characters in a track name. For example, `student*` includes `student` as well as `studentTeam`. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request

  • audio_sources_excluded (Array[String]) (defaults to: :unset) —

    An array of track names to exclude. The new composition 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 will match zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty.

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

  • format (Format) (defaults to: :unset)
  • 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`.

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

    Whether to clip the intervals where there is no active media in the composition. 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.

Returns:



44
45
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
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 44

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

    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.



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

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



176
177
178
179
180
181
182
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 176

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 (Status) (defaults to: :unset) —

    Read only Composition resources with this status. Can be: ‘enqueued`, `processing`, `completed`, `deleted`, or `failed`.

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

    Read only Composition resources created on or after this [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date-time with time zone.

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

    Read only Composition resources created before this ISO 8601 date-time with time zone.

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

    Read only Composition resources with this 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



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

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 (Status) (defaults to: :unset) —

    Read only Composition resources with this status. Can be: ‘enqueued`, `processing`, `completed`, `deleted`, or `failed`.

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

    Read only Composition resources created on or after this [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date-time with time zone.

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

    Read only Composition resources created before this ISO 8601 date-time with time zone.

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

    Read only Composition resources with this 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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 155

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

Parameters:

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

    Read only Composition resources with this status. Can be: ‘enqueued`, `processing`, `completed`, `deleted`, or `failed`.

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

    Read only Composition resources created on or after this [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date-time with time zone.

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

    Read only Composition resources created before this ISO 8601 date-time with time zone.

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

    Read only Composition resources with this 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



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

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



187
188
189
 
# File 'lib/twilio-ruby/rest/video/v1/composition.rb', line 187

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