lib/twilio-ruby/rest/video/v1/composition_hook.rb in twilio-ruby-5.40.3 vs lib/twilio-ruby/rest/video/v1/composition_hook.rb in twilio-ruby-5.40.4

- old
+ new

@@ -30,14 +30,14 @@ # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [Boolean] enabled Read only CompositionHook resources with an `enabled` # value that matches this parameter. # @param [Time] date_created_after Read only CompositionHook resources created on - # or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with + # or after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with # time zone. # @param [Time] date_created_before Read only CompositionHook resources created - # before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with + # before this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with # time zone. # @param [String] friendly_name 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. # @param [Integer] limit Upper limit for the number of records to return. stream() @@ -63,14 +63,14 @@ # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [Boolean] enabled Read only CompositionHook resources with an `enabled` # value that matches this parameter. # @param [Time] date_created_after Read only CompositionHook resources created on - # or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with + # or after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with # time zone. # @param [Time] date_created_before Read only CompositionHook resources created - # before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with + # before this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with # time zone. # @param [String] friendly_name 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. # @param [Integer] limit Upper limit for the number of records to return. stream() @@ -112,14 +112,14 @@ # Retrieve a single page of CompositionHookInstance records from the API. # Request is executed immediately. # @param [Boolean] enabled Read only CompositionHook resources with an `enabled` # value that matches this parameter. # @param [Time] date_created_after Read only CompositionHook resources created on - # or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with + # or after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with # time zone. # @param [Time] date_created_before Read only CompositionHook resources created - # before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with + # before this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] datetime with # time zone. # @param [String] friendly_name 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. # @param [String] page_token PageToken provided by the API @@ -162,12 +162,12 @@ # the account. # @param [Boolean] enabled 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. # @param [Hash] video_layout An object that describes the video layout of the - # composition hook in terms of regions. See [Specifying Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # composition hook in terms of regions. See {Specifying Video + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @param [String] audio_sources 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 @@ -197,12 +197,12 @@ # * 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](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # scaled to fit. See {Specifying Video + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @param [composition_hook.Format] format The container format of the media files # used by the compositions created by the composition hook. Can be: `mp4` or # `webm` and the default is `webm`. If `mp4` or `webm`, `audio_sources` must have # one or more tracks and/or a `video_layout` element must contain a valid @@ -215,13 +215,13 @@ # `status_callback`. Can be: `POST` or `GET` and the default is `POST`. # @param [Boolean] trim 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 + # the room and join later, because those gaps will be removed. See {Specifying # Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @return [CompositionHookInstance] Created CompositionHookInstance 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, @@ -318,12 +318,12 @@ # the account. # @param [Boolean] enabled 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 never triggers. # @param [Hash] video_layout A JSON object that describes the video layout of the - # composition hook in terms of regions. See [Specifying Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # composition hook in terms of regions. See {Specifying Video + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @param [String] audio_sources 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 @@ -340,13 +340,13 @@ # This parameter can also be empty. # @param [Boolean] trim 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 + # the room and join later, because those gaps will be removed. See {Specifying # Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @param [composition_hook.Format] format The container format of the media files # used by the compositions created by the composition hook. Can be: `mp4` or # `webm` and the default is `webm`. If `mp4` or `webm`, `audio_sources` must have # one or more tracks and/or a `video_layout` element must contain a valid @@ -366,12 +366,12 @@ # * 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](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # scaled to fit. See {Specifying Video + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @param [String] status_callback 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. @@ -570,12 +570,12 @@ # the account. # @param [Boolean] enabled 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 never triggers. # @param [Hash] video_layout A JSON object that describes the video layout of the - # composition hook in terms of regions. See [Specifying Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # composition hook in terms of regions. See {Specifying Video + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @param [String] audio_sources 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 @@ -592,13 +592,13 @@ # This parameter can also be empty. # @param [Boolean] trim 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 + # the room and join later, because those gaps will be removed. See {Specifying # Video - # Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @param [composition_hook.Format] format The container format of the media files # used by the compositions created by the composition hook. Can be: `mp4` or # `webm` and the default is `webm`. If `mp4` or `webm`, `audio_sources` must have # one or more tracks and/or a `video_layout` element must contain a valid @@ -618,11 +618,11 @@ # * 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](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) + # scaled to fit. See {Specifying Video + # Layouts}[https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts] # for more info. # @param [String] status_callback 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. \ No newline at end of file