|
1 | 1 | /** |
2 | 2 | * Shotstack |
3 | | - * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io |
| 3 | + * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation. |
4 | 4 | * |
5 | 5 | * The version of the OpenAPI document: v1 |
6 | 6 | * |
|
72 | 72 | if (data.hasOwnProperty('callback')) { |
73 | 73 | obj['callback'] = ApiClient.convertToType(data['callback'], 'String'); |
74 | 74 | } |
| 75 | + if (data.hasOwnProperty('disk')) { |
| 76 | + obj['disk'] = ApiClient.convertToType(data['disk'], 'String'); |
| 77 | + } |
75 | 78 | } |
76 | 79 | return obj; |
77 | 80 | } |
|
85 | 88 | */ |
86 | 89 | exports.prototype['output'] = undefined; |
87 | 90 | /** |
88 | | - * An optional webhook callback URL used to receive status notifications when a render completes or fails. |
| 91 | + * An optional webhook callback URL used to receive status notifications when a render completes or fails. See [webhooks](https://shotstack.gitbook.io/docs/guides/architecting-an-application/webhooks) for more details. |
89 | 92 | * @member {String} callback |
90 | 93 | */ |
91 | 94 | exports.prototype['callback'] = undefined; |
| 95 | + /** |
| 96 | + * The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.gitbook.io/docs/guides/architecting-an-application/disk-types) for more details. <ul> <li>`local` - optimised for high speed rendering with up to 512MB storage</li> <li>`mount` - optimised for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul> |
| 97 | + * @member {module:model/Edit.DiskEnum} disk |
| 98 | + * @default 'local' |
| 99 | + */ |
| 100 | + exports.prototype['disk'] = 'local'; |
92 | 101 |
|
93 | 102 |
|
94 | 103 | /** |
|
124 | 133 |
|
125 | 134 |
|
126 | 135 | /** |
127 | | - * Returns An optional webhook callback URL used to receive status notifications when a render completes or fails. |
| 136 | + * Returns An optional webhook callback URL used to receive status notifications when a render completes or fails. See [webhooks](https://shotstack.gitbook.io/docs/guides/architecting-an-application/webhooks) for more details. |
128 | 137 | * @return {String} |
129 | 138 | */ |
130 | 139 | exports.prototype.getCallback = function() { |
131 | 140 | return this['callback']; |
132 | 141 | } |
133 | 142 |
|
134 | 143 | /** |
135 | | - * Sets An optional webhook callback URL used to receive status notifications when a render completes or fails. |
136 | | - * @param {String} callback An optional webhook callback URL used to receive status notifications when a render completes or fails. |
| 144 | + * Sets An optional webhook callback URL used to receive status notifications when a render completes or fails. See [webhooks](https://shotstack.gitbook.io/docs/guides/architecting-an-application/webhooks) for more details. |
| 145 | + * @param {String} callback An optional webhook callback URL used to receive status notifications when a render completes or fails. See [webhooks](https://shotstack.gitbook.io/docs/guides/architecting-an-application/webhooks) for more details. |
137 | 146 | */ |
138 | 147 | exports.prototype.setCallback = function(callback) { |
139 | 148 | this['callback'] = callback; |
140 | 149 | return this; |
141 | 150 | } |
142 | 151 |
|
143 | 152 |
|
| 153 | + /** |
| 154 | + * Returns The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.gitbook.io/docs/guides/architecting-an-application/disk-types) for more details. <ul> <li>`local` - optimised for high speed rendering with up to 512MB storage</li> <li>`mount` - optimised for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul> |
| 155 | + * @return {module:model/Edit.DiskEnum} |
| 156 | + */ |
| 157 | + exports.prototype.getDisk = function() { |
| 158 | + return this['disk']; |
| 159 | + } |
| 160 | + |
| 161 | + /** |
| 162 | + * Sets The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.gitbook.io/docs/guides/architecting-an-application/disk-types) for more details. <ul> <li>`local` - optimised for high speed rendering with up to 512MB storage</li> <li>`mount` - optimised for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul> |
| 163 | + * @param {module:model/Edit.DiskEnum} disk The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.gitbook.io/docs/guides/architecting-an-application/disk-types) for more details. <ul> <li>`local` - optimised for high speed rendering with up to 512MB storage</li> <li>`mount` - optimised for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul> |
| 164 | + */ |
| 165 | + exports.prototype.setDisk = function(disk) { |
| 166 | + this['disk'] = disk; |
| 167 | + } |
| 168 | + |
| 169 | + |
| 170 | + /** |
| 171 | + * Allowed values for the <code>disk</code> property. |
| 172 | + * @enum {String} |
| 173 | + * @readonly |
| 174 | + */ |
| 175 | + exports.DiskEnum = { |
| 176 | + /** |
| 177 | + * value: "local" |
| 178 | + * @const |
| 179 | + */ |
| 180 | + "local": "local", |
| 181 | + /** |
| 182 | + * value: "mount" |
| 183 | + * @const |
| 184 | + */ |
| 185 | + "mount": "mount" }; |
| 186 | + |
144 | 187 |
|
145 | 188 | return exports; |
146 | 189 | })); |
|
0 commit comments