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

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ CompositionHookList

Initialize the CompositionHookList

Parameters:

  • version (Version) —

    Version that contains the resource



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

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

Create the CompositionHookInstance

Parameters:

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

    A descriptive string that you create to describe the resource. It can be up to 100 characters long and it must be unique within the account.

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

    Whether the composition hook is active. When ‘true`, the composition hook will be triggered for every completed Group Room in the account. When `false`, the composition hook will never be triggered.

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

    An object that describes the video layout of the composition hook in terms of regions. See [Specifying Video Layouts](www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.

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

    An array of track names from the same group room to merge into the compositions created by the composition hook. Can include zero or more track names. A composition triggered by the composition hook includes all audio sources specified in ‘audio_sources` except those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`.

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

    An array of track names to exclude. A composition triggered by the composition hook 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 matches 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 Compositions triggered by the composition hook. 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:



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
82
83
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 46

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    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.



144
145
146
147
148
149
150
151
152
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 144

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



189
190
191
192
193
194
195
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 189

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

    Read only CompositionHook resources with an ‘enabled` value that matches this parameter.

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

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

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

    Read only CompositionHook resources created before this [ISO 8601](en.wikipedia.org/wiki/ISO_8601) datetime with time zone.

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

    Read only CompositionHook resources with friendly names that match this string. The match is not case sensitive and can include asterisk ‘*` characters as wildcard match.

  • 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



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

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

    Read only CompositionHook resources with an ‘enabled` value that matches this parameter.

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

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

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

    Read only CompositionHook resources created before this [ISO 8601](en.wikipedia.org/wiki/ISO_8601) datetime with time zone.

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

    Read only CompositionHook resources with friendly names that match this string. The match is not case sensitive and can include asterisk ‘*` characters as wildcard match.

  • 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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 165

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

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

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

    Read only CompositionHook resources with an ‘enabled` value that matches this parameter.

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

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

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

    Read only CompositionHook resources created before this [ISO 8601](en.wikipedia.org/wiki/ISO_8601) datetime with time zone.

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

    Read only CompositionHook resources with friendly names that match this string. The match is not case sensitive and can include asterisk ‘*` characters as wildcard match.

  • 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



127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 127

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



200
201
202
 
# File 'lib/twilio-ruby/rest/video/v1/composition_hook.rb', line 200

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