shotstack 0.2.2 → 0.2.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +9 -0
- data/Rakefile +10 -0
- data/lib/shotstack/api/create_api.rb +158 -0
- data/lib/shotstack/api/edit_api.rb +20 -20
- data/lib/shotstack/api/ingest_api.rb +338 -0
- data/lib/shotstack/api/serve_api.rb +76 -8
- data/lib/shotstack/api_client.rb +28 -24
- data/lib/shotstack/api_error.rb +3 -2
- data/lib/shotstack/configuration.rb +55 -9
- data/lib/shotstack/models/asset.rb +3 -3
- data/lib/shotstack/models/asset_render_response.rb +18 -20
- data/lib/shotstack/models/asset_response.rb +18 -20
- data/lib/shotstack/models/asset_response_attributes.rb +23 -21
- data/lib/shotstack/models/asset_response_data.rb +20 -20
- data/lib/shotstack/models/audio_asset.rb +57 -21
- data/lib/shotstack/models/audio_enhancement.rb +43 -0
- data/lib/shotstack/models/clip.rb +27 -25
- data/lib/shotstack/models/crop.rb +40 -28
- data/lib/shotstack/models/destinations.rb +78 -243
- data/lib/shotstack/models/did_generated_asset.rb +273 -0
- data/lib/shotstack/models/did_generated_asset_options.rb +54 -0
- data/lib/shotstack/models/did_text_to_avatar_options.rb +313 -0
- data/lib/shotstack/models/dolby_enhancement.rb +239 -0
- data/lib/shotstack/models/dolby_enhancement_options.rb +257 -0
- data/lib/shotstack/models/edit.rb +22 -22
- data/lib/shotstack/models/eleven_labs_generated_asset.rb +273 -0
- data/lib/shotstack/models/eleven_labs_generated_asset_options.rb +54 -0
- data/lib/shotstack/models/eleven_labs_text_to_speech_options.rb +303 -0
- data/lib/shotstack/models/enhancements.rb +215 -0
- data/lib/shotstack/models/flip_transformation.rb +16 -20
- data/lib/shotstack/models/font.rb +18 -20
- data/lib/shotstack/models/generated_asset.rb +48 -0
- data/lib/shotstack/models/generated_asset_error_response.rb +225 -0
- data/lib/shotstack/models/generated_asset_error_response_data.rb +257 -0
- data/lib/shotstack/models/generated_asset_response.rb +222 -0
- data/lib/shotstack/models/generated_asset_response_attributes.rb +376 -0
- data/lib/shotstack/models/generated_asset_response_data.rb +256 -0
- data/lib/shotstack/models/google_cloud_storage_destination.rb +232 -0
- data/lib/shotstack/models/google_cloud_storage_destination_options.rb +243 -0
- data/lib/shotstack/models/google_drive_destination.rb +239 -0
- data/lib/shotstack/models/google_drive_destination_options.rb +233 -0
- data/lib/shotstack/models/hey_gen_generated_asset.rb +273 -0
- data/lib/shotstack/models/hey_gen_generated_asset_options.rb +54 -0
- data/lib/shotstack/models/hey_gen_text_to_avatar_options.rb +396 -0
- data/lib/shotstack/models/html_asset.rb +20 -22
- data/lib/shotstack/models/image_asset.rb +18 -20
- data/lib/shotstack/models/ingest_error_response.rb +225 -0
- data/lib/shotstack/models/ingest_error_response_data.rb +257 -0
- data/lib/shotstack/models/luma_asset.rb +18 -20
- data/lib/shotstack/models/merge_field.rb +20 -20
- data/lib/shotstack/models/mux_destination.rb +18 -22
- data/lib/shotstack/models/mux_destination_options.rb +50 -25
- data/lib/shotstack/models/offset.rb +28 -24
- data/lib/shotstack/models/open_ai_generated_asset.rb +273 -0
- data/lib/shotstack/models/open_ai_generated_asset_options.rb +54 -0
- data/lib/shotstack/models/open_ai_text_generator_options.rb +313 -0
- data/lib/shotstack/models/output.rb +27 -29
- data/lib/shotstack/models/outputs.rb +227 -0
- data/lib/shotstack/models/outputs_response.rb +218 -0
- data/lib/shotstack/models/poster.rb +18 -20
- data/lib/shotstack/models/probe_response.rb +22 -20
- data/lib/shotstack/models/queued_response.rb +22 -20
- data/lib/shotstack/models/queued_response_data.rb +20 -20
- data/lib/shotstack/models/queued_source_response.rb +222 -0
- data/lib/shotstack/models/queued_source_response_data.rb +240 -0
- data/lib/shotstack/models/range.rb +26 -22
- data/lib/shotstack/models/render_response.rb +22 -20
- data/lib/shotstack/models/render_response_data.rb +22 -20
- data/lib/shotstack/models/rendition.rb +429 -0
- data/lib/shotstack/models/rendition_response_attributes.rb +336 -0
- data/lib/shotstack/models/rotate_transformation.rb +16 -20
- data/lib/shotstack/models/s3_destination.rb +18 -22
- data/lib/shotstack/models/s3_destination_options.rb +21 -21
- data/lib/shotstack/models/shotstack_destination.rb +19 -23
- data/lib/shotstack/models/shotstack_generated_asset.rb +273 -0
- data/lib/shotstack/models/shotstack_generated_asset_options.rb +60 -0
- data/lib/shotstack/models/shotstack_image_to_video_options.rb +298 -0
- data/lib/shotstack/models/shotstack_text_generator_options.rb +274 -0
- data/lib/shotstack/models/shotstack_text_to_image_options.rb +308 -0
- data/lib/shotstack/models/shotstack_text_to_speech_options.rb +339 -0
- data/lib/shotstack/models/size.rb +36 -32
- data/lib/shotstack/models/skew_transformation.rb +16 -20
- data/lib/shotstack/models/soundtrack.rb +18 -20
- data/lib/shotstack/models/source.rb +244 -0
- data/lib/shotstack/models/source_list_response.rb +225 -0
- data/lib/shotstack/models/source_response.rb +222 -0
- data/lib/shotstack/models/source_response_attributes.rb +373 -0
- data/lib/shotstack/models/source_response_data.rb +256 -0
- data/lib/shotstack/models/speed.rb +254 -0
- data/lib/shotstack/models/stability_ai_generated_asset.rb +273 -0
- data/lib/shotstack/models/stability_ai_generated_asset_options.rb +54 -0
- data/lib/shotstack/models/stability_ai_text_to_image_options.rb +390 -0
- data/lib/shotstack/models/template.rb +18 -20
- data/lib/shotstack/models/template_data_response.rb +23 -21
- data/lib/shotstack/models/template_data_response_data.rb +24 -20
- data/lib/shotstack/models/template_list_response.rb +24 -22
- data/lib/shotstack/models/template_list_response_data.rb +20 -20
- data/lib/shotstack/models/template_list_response_item.rb +20 -20
- data/lib/shotstack/models/template_render.rb +18 -20
- data/lib/shotstack/models/template_response.rb +22 -20
- data/lib/shotstack/models/template_response_data.rb +20 -20
- data/lib/shotstack/models/thumbnail.rb +20 -20
- data/lib/shotstack/models/timeline.rb +19 -21
- data/lib/shotstack/models/title_asset.rb +18 -20
- data/lib/shotstack/models/track.rb +18 -20
- data/lib/shotstack/models/transcription.rb +250 -0
- data/lib/shotstack/models/transfer.rb +259 -0
- data/lib/shotstack/models/transfer_response.rb +222 -0
- data/lib/shotstack/models/transfer_response_attributes.rb +280 -0
- data/lib/shotstack/models/transfer_response_data.rb +225 -0
- data/lib/shotstack/models/transformation.rb +16 -20
- data/lib/shotstack/models/transition.rb +16 -20
- data/lib/shotstack/models/upload_response.rb +222 -0
- data/lib/shotstack/models/upload_response_attributes.rb +257 -0
- data/lib/shotstack/models/upload_response_data.rb +256 -0
- data/lib/shotstack/models/video_asset.rb +57 -21
- data/lib/shotstack/version.rb +3 -3
- data/lib/shotstack.rb +61 -2
- data/shotstack.gemspec +8 -8
- metadata +69 -16
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9696b3f6d9627da8217c280bcac571281c4c4f0157a032152f955f27df2ed901
|
4
|
+
data.tar.gz: 0ac97e916f6a934eb0519cadfdf87f0b0c55451b8356aeddb8f6c1b7bc058c16
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0c868d028cd6c837174f31da955e7157481e6a4ee4a2a618df11362ead2077eca42cd126bd89faa4d8c11834a1782d5053b431b30691cf2956f989dd00ce0dc0
|
7
|
+
data.tar.gz: 5561e90e6a05edf47ae4784c63488479b4dbd91118b1d6319a57a114221ec873c3d0e8f4f69d2eb8c4081cb9354e682d010635af09f23753871eb4e3929a5232
|
data/Gemfile
ADDED
data/Rakefile
ADDED
@@ -0,0 +1,158 @@
|
|
1
|
+
=begin
|
2
|
+
#Shotstack
|
3
|
+
|
4
|
+
# Official Ruby SDK for the Shotstack Cloud Video Editing API
|
5
|
+
|
6
|
+
The version of the OpenAPI document: v1
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
Generator version: 7.4.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module Shotstack
|
16
|
+
class CreateApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Get Generated Asset
|
23
|
+
# Get the generated assets status, url and details by ID. **Base URL:** <a href=\"#\">https://api.shotstack.io/create/{version}</a>
|
24
|
+
# @param id [String] The id of the source file in [KSUID](https://github.com/segmentio/ksuid#what-is-a-ksuid) format.
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [GeneratedAssetResponse]
|
27
|
+
def get_generated_asset(id, opts = {})
|
28
|
+
data, _status_code, _headers = get_generated_asset_with_http_info(id, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Get Generated Asset
|
33
|
+
# Get the generated assets status, url and details by ID. **Base URL:** <a href=\"#\">https://api.shotstack.io/create/{version}</a>
|
34
|
+
# @param id [String] The id of the source file in [KSUID](https://github.com/segmentio/ksuid#what-is-a-ksuid) format.
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(GeneratedAssetResponse, Integer, Hash)>] GeneratedAssetResponse data, response status code and response headers
|
37
|
+
def get_generated_asset_with_http_info(id, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: CreateApi.get_generated_asset ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'id' is set
|
42
|
+
if @api_client.config.client_side_validation && id.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CreateApi.get_generated_asset"
|
44
|
+
end
|
45
|
+
pattern = Regexp.new(/^[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{12}$/)
|
46
|
+
if @api_client.config.client_side_validation && id !~ pattern
|
47
|
+
fail ArgumentError, "invalid value for 'id' when calling CreateApi.get_generated_asset, must conform to the pattern #{pattern}."
|
48
|
+
end
|
49
|
+
|
50
|
+
# resource path
|
51
|
+
local_var_path = '/assets/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
52
|
+
|
53
|
+
# query parameters
|
54
|
+
query_params = opts[:query_params] || {}
|
55
|
+
|
56
|
+
# header parameters
|
57
|
+
header_params = opts[:header_params] || {}
|
58
|
+
# HTTP header 'Accept' (if needed)
|
59
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
60
|
+
|
61
|
+
# form parameters
|
62
|
+
form_params = opts[:form_params] || {}
|
63
|
+
|
64
|
+
# http body (model)
|
65
|
+
post_body = opts[:debug_body]
|
66
|
+
|
67
|
+
# return_type
|
68
|
+
return_type = opts[:debug_return_type] || 'GeneratedAssetResponse'
|
69
|
+
|
70
|
+
# auth_names
|
71
|
+
auth_names = opts[:debug_auth_names] || ['DeveloperKey']
|
72
|
+
|
73
|
+
new_options = opts.merge(
|
74
|
+
:operation => :"CreateApi.get_generated_asset",
|
75
|
+
:header_params => header_params,
|
76
|
+
:query_params => query_params,
|
77
|
+
:form_params => form_params,
|
78
|
+
:body => post_body,
|
79
|
+
:auth_names => auth_names,
|
80
|
+
:return_type => return_type
|
81
|
+
)
|
82
|
+
|
83
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
84
|
+
if @api_client.config.debugging
|
85
|
+
@api_client.config.logger.debug "API called: CreateApi#get_generated_asset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
86
|
+
end
|
87
|
+
return data, status_code, headers
|
88
|
+
end
|
89
|
+
|
90
|
+
# Generate Asset
|
91
|
+
# Generate an asset using a Shotstack or third party provider. Chose the provider, type of asset and provide prompts, inputs and options to generate the asset. Once generated the asset can be used with the [Edit](#tocs_edit) API or downloaded. **Base URL:** <a href=\"#\">https://api.shotstack.io/create/{version}</a>
|
92
|
+
# @param generated_asset [GeneratedAsset] Generate an asset using the specified provider, type and options.
|
93
|
+
# @param [Hash] opts the optional parameters
|
94
|
+
# @return [GeneratedAssetResponse]
|
95
|
+
def post_generate_asset(generated_asset, opts = {})
|
96
|
+
data, _status_code, _headers = post_generate_asset_with_http_info(generated_asset, opts)
|
97
|
+
data
|
98
|
+
end
|
99
|
+
|
100
|
+
# Generate Asset
|
101
|
+
# Generate an asset using a Shotstack or third party provider. Chose the provider, type of asset and provide prompts, inputs and options to generate the asset. Once generated the asset can be used with the [Edit](#tocs_edit) API or downloaded. **Base URL:** <a href=\"#\">https://api.shotstack.io/create/{version}</a>
|
102
|
+
# @param generated_asset [GeneratedAsset] Generate an asset using the specified provider, type and options.
|
103
|
+
# @param [Hash] opts the optional parameters
|
104
|
+
# @return [Array<(GeneratedAssetResponse, Integer, Hash)>] GeneratedAssetResponse data, response status code and response headers
|
105
|
+
def post_generate_asset_with_http_info(generated_asset, opts = {})
|
106
|
+
if @api_client.config.debugging
|
107
|
+
@api_client.config.logger.debug 'Calling API: CreateApi.post_generate_asset ...'
|
108
|
+
end
|
109
|
+
# verify the required parameter 'generated_asset' is set
|
110
|
+
if @api_client.config.client_side_validation && generated_asset.nil?
|
111
|
+
fail ArgumentError, "Missing the required parameter 'generated_asset' when calling CreateApi.post_generate_asset"
|
112
|
+
end
|
113
|
+
# resource path
|
114
|
+
local_var_path = '/assets'
|
115
|
+
|
116
|
+
# query parameters
|
117
|
+
query_params = opts[:query_params] || {}
|
118
|
+
|
119
|
+
# header parameters
|
120
|
+
header_params = opts[:header_params] || {}
|
121
|
+
# HTTP header 'Accept' (if needed)
|
122
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
123
|
+
# HTTP header 'Content-Type'
|
124
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
125
|
+
if !content_type.nil?
|
126
|
+
header_params['Content-Type'] = content_type
|
127
|
+
end
|
128
|
+
|
129
|
+
# form parameters
|
130
|
+
form_params = opts[:form_params] || {}
|
131
|
+
|
132
|
+
# http body (model)
|
133
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(generated_asset)
|
134
|
+
|
135
|
+
# return_type
|
136
|
+
return_type = opts[:debug_return_type] || 'GeneratedAssetResponse'
|
137
|
+
|
138
|
+
# auth_names
|
139
|
+
auth_names = opts[:debug_auth_names] || ['DeveloperKey']
|
140
|
+
|
141
|
+
new_options = opts.merge(
|
142
|
+
:operation => :"CreateApi.post_generate_asset",
|
143
|
+
:header_params => header_params,
|
144
|
+
:query_params => query_params,
|
145
|
+
:form_params => form_params,
|
146
|
+
:body => post_body,
|
147
|
+
:auth_names => auth_names,
|
148
|
+
:return_type => return_type
|
149
|
+
)
|
150
|
+
|
151
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
152
|
+
if @api_client.config.debugging
|
153
|
+
@api_client.config.logger.debug "API called: CreateApi#post_generate_asset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
154
|
+
end
|
155
|
+
return data, status_code, headers
|
156
|
+
end
|
157
|
+
end
|
158
|
+
end
|
@@ -1,12 +1,12 @@
|
|
1
1
|
=begin
|
2
2
|
#Shotstack
|
3
3
|
|
4
|
-
#
|
4
|
+
# Official Ruby SDK for the Shotstack Cloud Video Editing API
|
5
5
|
|
6
6
|
The version of the OpenAPI document: v1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
|
9
|
+
Generator version: 7.4.0
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -20,7 +20,7 @@ module Shotstack
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Delete Template
|
23
|
-
# Delete a template by its template id. **Base URL:** https://api.shotstack.io/{version}
|
23
|
+
# Delete a template by its template id. **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
24
24
|
# @param id [String] The id of the template in UUID format
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [nil]
|
@@ -30,7 +30,7 @@ module Shotstack
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Delete Template
|
33
|
-
# Delete a template by its template id. **Base URL:** https://api.shotstack.io/{version}
|
33
|
+
# Delete a template by its template id. **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
34
34
|
# @param id [String] The id of the template in UUID format
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -86,7 +86,7 @@ module Shotstack
|
|
86
86
|
end
|
87
87
|
|
88
88
|
# Get Render Status
|
89
|
-
# Get the rendering status, temporary asset url and details of a render by ID. **Base URL:** https://api.shotstack.io/{version}
|
89
|
+
# Get the rendering status, temporary asset url and details of a render by ID. **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
90
90
|
# @param id [String] The id of the timeline render task in UUID format
|
91
91
|
# @param [Hash] opts the optional parameters
|
92
92
|
# @option opts [Boolean] :data Include the data parameter in the response. The data parameter includes the original timeline, output and other settings sent to the API.<br><br><b>Note:</b> the default is currently `true`, this is deprecated and the default will soon be `false`. If you rely on the data being returned in the response you should explicitly set the parameter to `true`.
|
@@ -98,7 +98,7 @@ module Shotstack
|
|
98
98
|
end
|
99
99
|
|
100
100
|
# Get Render Status
|
101
|
-
# Get the rendering status, temporary asset url and details of a render by ID. **Base URL:** https://api.shotstack.io/{version}
|
101
|
+
# Get the rendering status, temporary asset url and details of a render by ID. **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
102
102
|
# @param id [String] The id of the timeline render task in UUID format
|
103
103
|
# @param [Hash] opts the optional parameters
|
104
104
|
# @option opts [Boolean] :data Include the data parameter in the response. The data parameter includes the original timeline, output and other settings sent to the API.<br><br><b>Note:</b> the default is currently `true`, this is deprecated and the default will soon be `false`. If you rely on the data being returned in the response you should explicitly set the parameter to `true`.
|
@@ -160,7 +160,7 @@ module Shotstack
|
|
160
160
|
end
|
161
161
|
|
162
162
|
# Retrieve Template
|
163
|
-
# Retrieve a template by template id. **Base URL:** https://api.shotstack.io/{version}
|
163
|
+
# Retrieve a template by template id. **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
164
164
|
# @param id [String] The id of the template in UUID format
|
165
165
|
# @param [Hash] opts the optional parameters
|
166
166
|
# @return [TemplateDataResponse]
|
@@ -170,7 +170,7 @@ module Shotstack
|
|
170
170
|
end
|
171
171
|
|
172
172
|
# Retrieve Template
|
173
|
-
# Retrieve a template by template id. **Base URL:** https://api.shotstack.io/{version}
|
173
|
+
# Retrieve a template by template id. **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
174
174
|
# @param id [String] The id of the template in UUID format
|
175
175
|
# @param [Hash] opts the optional parameters
|
176
176
|
# @return [Array<(TemplateDataResponse, Integer, Hash)>] TemplateDataResponse data, response status code and response headers
|
@@ -228,7 +228,7 @@ module Shotstack
|
|
228
228
|
end
|
229
229
|
|
230
230
|
# List Templates
|
231
|
-
# Retrieve a list of templates stored against a users account
|
231
|
+
# Retrieve a list of templates stored against a users account and stage. **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
232
232
|
# @param [Hash] opts the optional parameters
|
233
233
|
# @return [TemplateListResponse]
|
234
234
|
def get_templates(opts = {})
|
@@ -237,7 +237,7 @@ module Shotstack
|
|
237
237
|
end
|
238
238
|
|
239
239
|
# List Templates
|
240
|
-
# Retrieve a list of templates stored against a users account
|
240
|
+
# Retrieve a list of templates stored against a users account and stage. **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
241
241
|
# @param [Hash] opts the optional parameters
|
242
242
|
# @return [Array<(TemplateListResponse, Integer, Hash)>] TemplateListResponse data, response status code and response headers
|
243
243
|
def get_templates_with_http_info(opts = {})
|
@@ -285,7 +285,7 @@ module Shotstack
|
|
285
285
|
end
|
286
286
|
|
287
287
|
# Render Asset
|
288
|
-
# Queue and render the contents of an [Edit](#tocs_edit) as a video, image or audio file. **Base URL:** https://api.shotstack.io/{version}
|
288
|
+
# Queue and render the contents of an [Edit](#tocs_edit) as a video, image or audio file. **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
289
289
|
# @param edit [Edit] The video, image or audio edit specified using JSON.
|
290
290
|
# @param [Hash] opts the optional parameters
|
291
291
|
# @return [QueuedResponse]
|
@@ -295,7 +295,7 @@ module Shotstack
|
|
295
295
|
end
|
296
296
|
|
297
297
|
# Render Asset
|
298
|
-
# Queue and render the contents of an [Edit](#tocs_edit) as a video, image or audio file. **Base URL:** https://api.shotstack.io/{version}
|
298
|
+
# Queue and render the contents of an [Edit](#tocs_edit) as a video, image or audio file. **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
299
299
|
# @param edit [Edit] The video, image or audio edit specified using JSON.
|
300
300
|
# @param [Hash] opts the optional parameters
|
301
301
|
# @return [Array<(QueuedResponse, Integer, Hash)>] QueuedResponse data, response status code and response headers
|
@@ -353,7 +353,7 @@ module Shotstack
|
|
353
353
|
end
|
354
354
|
|
355
355
|
# Create Template
|
356
|
-
# Save an [Edit](#tocs_edit) as a re-usable template. Templates can be retrieved and modified in your application before being rendered. [Merge fields](#tocs_mergefield) can be also used to merge data in to a template and [render](#render-template) it in a single request. **Base URL:** https://api.shotstack.io/{version}
|
356
|
+
# Save an [Edit](#tocs_edit) as a re-usable template. Templates can be retrieved and modified in your application before being rendered. [Merge fields](#tocs_mergefield) can be also used to merge data in to a template and [render](#render-template) it in a single request. **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
357
357
|
# @param template [Template] Create a template with a name and [Edit](#tocs_edit).
|
358
358
|
# @param [Hash] opts the optional parameters
|
359
359
|
# @return [TemplateResponse]
|
@@ -363,7 +363,7 @@ module Shotstack
|
|
363
363
|
end
|
364
364
|
|
365
365
|
# Create Template
|
366
|
-
# Save an [Edit](#tocs_edit) as a re-usable template. Templates can be retrieved and modified in your application before being rendered. [Merge fields](#tocs_mergefield) can be also used to merge data in to a template and [render](#render-template) it in a single request. **Base URL:** https://api.shotstack.io/{version}
|
366
|
+
# Save an [Edit](#tocs_edit) as a re-usable template. Templates can be retrieved and modified in your application before being rendered. [Merge fields](#tocs_mergefield) can be also used to merge data in to a template and [render](#render-template) it in a single request. **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
367
367
|
# @param template [Template] Create a template with a name and [Edit](#tocs_edit).
|
368
368
|
# @param [Hash] opts the optional parameters
|
369
369
|
# @return [Array<(TemplateResponse, Integer, Hash)>] TemplateResponse data, response status code and response headers
|
@@ -421,7 +421,7 @@ module Shotstack
|
|
421
421
|
end
|
422
422
|
|
423
423
|
# Render Template
|
424
|
-
# Render an asset from a template id and optional merge fields. Merge fields can be used to replace placeholder variables within the [Edit](#tocs_edit). **Base URL:** https://api.shotstack.io/{version}
|
424
|
+
# Render an asset from a template id and optional merge fields. Merge fields can be used to replace placeholder variables within the [Edit](#tocs_edit). **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
425
425
|
# @param template_render [TemplateRender] Render a template by template id.
|
426
426
|
# @param [Hash] opts the optional parameters
|
427
427
|
# @return [QueuedResponse]
|
@@ -431,7 +431,7 @@ module Shotstack
|
|
431
431
|
end
|
432
432
|
|
433
433
|
# Render Template
|
434
|
-
# Render an asset from a template id and optional merge fields. Merge fields can be used to replace placeholder variables within the [Edit](#tocs_edit). **Base URL:** https://api.shotstack.io/{version}
|
434
|
+
# Render an asset from a template id and optional merge fields. Merge fields can be used to replace placeholder variables within the [Edit](#tocs_edit). **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
435
435
|
# @param template_render [TemplateRender] Render a template by template id.
|
436
436
|
# @param [Hash] opts the optional parameters
|
437
437
|
# @return [Array<(QueuedResponse, Integer, Hash)>] QueuedResponse data, response status code and response headers
|
@@ -489,7 +489,7 @@ module Shotstack
|
|
489
489
|
end
|
490
490
|
|
491
491
|
# Inspect Media
|
492
|
-
# Inspects any media asset (image, video, audio) on the internet using a hosted version of [FFprobe](https://ffmpeg.org/ffprobe.html). The probe endpoint returns useful information about an asset such as width, height, duration, rotation, framerate, etc... **Base URL:** https://api.shotstack.io/{version}
|
492
|
+
# Inspects any media asset (image, video, audio) on the internet using a hosted version of [FFprobe](https://ffmpeg.org/ffprobe.html). The probe endpoint returns useful information about an asset such as width, height, duration, rotation, framerate, etc... **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
493
493
|
# @param url [String] The URL of the media to inspect, must be **URL encoded**.
|
494
494
|
# @param [Hash] opts the optional parameters
|
495
495
|
# @return [ProbeResponse]
|
@@ -499,7 +499,7 @@ module Shotstack
|
|
499
499
|
end
|
500
500
|
|
501
501
|
# Inspect Media
|
502
|
-
# Inspects any media asset (image, video, audio) on the internet using a hosted version of [FFprobe](https://ffmpeg.org/ffprobe.html). The probe endpoint returns useful information about an asset such as width, height, duration, rotation, framerate, etc... **Base URL:** https://api.shotstack.io/{version}
|
502
|
+
# Inspects any media asset (image, video, audio) on the internet using a hosted version of [FFprobe](https://ffmpeg.org/ffprobe.html). The probe endpoint returns useful information about an asset such as width, height, duration, rotation, framerate, etc... **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
503
503
|
# @param url [String] The URL of the media to inspect, must be **URL encoded**.
|
504
504
|
# @param [Hash] opts the optional parameters
|
505
505
|
# @return [Array<(ProbeResponse, Integer, Hash)>] ProbeResponse data, response status code and response headers
|
@@ -552,7 +552,7 @@ module Shotstack
|
|
552
552
|
end
|
553
553
|
|
554
554
|
# Update Template
|
555
|
-
# Update an existing template by template id. **Base URL:** https://api.shotstack.io/{version}
|
555
|
+
# Update an existing template by template id. **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
556
556
|
# @param id [String] The id of the template in UUID format
|
557
557
|
# @param template [Template] Update an individual templates name and [Edit](#tocs_edit). Both template name and template must be provided. If the template parameter is omitted a blank template will be saved.
|
558
558
|
# @param [Hash] opts the optional parameters
|
@@ -563,7 +563,7 @@ module Shotstack
|
|
563
563
|
end
|
564
564
|
|
565
565
|
# Update Template
|
566
|
-
# Update an existing template by template id. **Base URL:** https://api.shotstack.io/{version}
|
566
|
+
# Update an existing template by template id. **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>
|
567
567
|
# @param id [String] The id of the template in UUID format
|
568
568
|
# @param template [Template] Update an individual templates name and [Edit](#tocs_edit). Both template name and template must be provided. If the template parameter is omitted a blank template will be saved.
|
569
569
|
# @param [Hash] opts the optional parameters
|