shotstack-sdk
Advanced tools
+1
-1
| { | ||
| "name": "shotstack-sdk", | ||
| "version": "0.2.1", | ||
| "version": "0.2.2", | ||
| "description": "Official Node SDK for the Shotstack Cloud Video Editing API", | ||
@@ -5,0 +5,0 @@ "license": "MIT", |
+371
-6
@@ -19,2 +19,4 @@ # Shotstack NodeJS SDK <!-- omit in toc --> | ||
| - [Status Check Example](#status-check-example) | ||
| - [Save a Template Example](#save-a-template-example) | ||
| - [Render a Template Example](#render-a-template-example) | ||
| - [Video Editing Schemas](#video-editing-schemas) | ||
@@ -41,2 +43,5 @@ - [Edit](#edit) | ||
| - [MergeField](#mergefield) | ||
| - [Template Schemas](#template-schemas) | ||
| - [Template](#template) | ||
| - [TemplateRender](#templaterender) | ||
| - [Output Schemas](#output-schemas) | ||
@@ -48,3 +53,8 @@ - [Output](#output) | ||
| - [Thumbnail](#thumbnail) | ||
| - [Destinations](#destinations) | ||
| - [ShotstackDestination](#shotstackdestination) | ||
| - [MuxDestination](#muxdestination) | ||
| - [MuxDestinationOptions](#muxdestinationoptions) | ||
| - [S3Destination](#s3destination) | ||
| - [S3DestinationOptions](#s3destinationoptions) | ||
| - [Render Response Schemas](#render-response-schemas) | ||
@@ -55,2 +65,10 @@ - [QueuedResponse](#queuedresponse) | ||
| - [RenderResponseData](#renderresponsedata) | ||
| - [Template Response Schemas](#template-response-schemas) | ||
| - [TemplateResponse](#templateresponse) | ||
| - [TemplateResponseData](#templateresponsedata) | ||
| - [TemplateDataResponse](#templatedataresponse) | ||
| - [TemplateDataResponseData](#templatedataresponsedata) | ||
| - [TemplateListResponse](#templatelistresponse) | ||
| - [TemplateListResponseData](#templatelistresponsedata) | ||
| - [TemplateListResponseItem](#templatelistresponseitem) | ||
| - [Inspecting Media](#inspecting-media) | ||
@@ -145,3 +163,3 @@ - [Probe Example](#probe-example) | ||
| const id = "75143ec6-4b72-46f8-a67a-fd7284546935"; // use the render id from previous example | ||
| const id = '75143ec6-4b72-46f8-a67a-fd7284546935'; // use the render id from previous example | ||
@@ -155,2 +173,107 @@ api.getRender(id, { data: false, merged: true }).then((data) => { | ||
| ### Save a Template Example | ||
| The example below uses the Edit we create in the [Video Editing Example](#video-editing-example) and saves it as a | ||
| template. The template can be rendered at a later date and can include placeholders. Placeholders can be replaced | ||
| when rendered using [merge fields](#mergefield). | ||
| This example uses a placeholder for the video src (URL), trim (TRIM), and length (LENGTH) to allow you to trim any video | ||
| using a template. | ||
| ```javascript | ||
| const Shotstack = require('shotstack-sdk'); | ||
| const defaultClient = Shotstack.ApiClient.instance; | ||
| defaultClient.basePath = 'https://api.shotstack.io/stage'; | ||
| const DeveloperKey = defaultClient.authentications['DeveloperKey']; | ||
| DeveloperKey.apiKey = 'H7jKyj90kd09lbLOF7J900jNbSWS67X87xs9j0cD'; // use the correct API key | ||
| const api = new Shotstack.EditApi(); | ||
| let videoAsset = new Shotstack.VideoAsset; | ||
| videoAsset | ||
| .setSrc('{{ URL }}') | ||
| .setTrim('{{ TRIM }}'); | ||
| let videoClip = new Shotstack.Clip; | ||
| videoClip | ||
| .setAsset(videoAsset) | ||
| .setStart(0) | ||
| .setLength('{{ LENGTH }}'); | ||
| let track = new Shotstack.Track; | ||
| track.setClips([videoClip]); | ||
| let timeline = new Shotstack.Timeline; | ||
| timeline.setTracks([track]); | ||
| let output = new Shotstack.Output; | ||
| output | ||
| .setFormat('mp4') | ||
| .setResolution('sd'); | ||
| let edit = new Shotstack.Edit; | ||
| edit | ||
| .setTimeline(timeline) | ||
| .setOutput(output); | ||
| const template = new Shotstack.Template; | ||
| template | ||
| .setName('Trim Template') | ||
| .setTemplate(edit); | ||
| api.postTemplate(template).then((data) => { | ||
| console.log(data.response.id); | ||
| }); | ||
| ``` | ||
| ### Render a Template Example | ||
| The example below renders the template we created in the previous example and includes merge fields that will replace | ||
| the placeholders. Once submitted use the returned render ID and call the [Status Check Example](#status-check-example) | ||
| to get the render progress. | ||
| ```javascript | ||
| const Shotstack = require('shotstack-sdk'); | ||
| const defaultClient = Shotstack.ApiClient.instance; | ||
| defaultClient.basePath = 'https://api.shotstack.io/stage'; | ||
| const DeveloperKey = defaultClient.authentications['DeveloperKey']; | ||
| DeveloperKey.apiKey = 'H7jKyj90kd09lbLOF7J900jNbSWS67X87xs9j0cD'; // use the correct API key | ||
| const api = new Shotstack.EditApi(); | ||
| const id = '8aeabb0e-b5eb-8c5e-847d-82297dd4802a'; // use the template id from previous example | ||
| const mergeFieldUrl = new Shotstack.MergeField; | ||
| mergeFieldUrl | ||
| .setFind('URL') | ||
| .setReplace('https://s3-ap-southeast-2.amazonaws.com/shotstack-assets/footage/skater.hd.mp4'); | ||
| const mergeFieldTrim = new Shotstack.MergeField; | ||
| mergeFieldTrim | ||
| .setFind('TRIM') | ||
| .setReplace(3); | ||
| const mergeFieldLength = new Shotstack.MergeField; | ||
| mergeFieldLength | ||
| .setFind('LENGTH') | ||
| .setReplace(6); | ||
| const template = new Shotstack.TemplateRender; | ||
| template | ||
| .setId(id) | ||
| .setMerge([ | ||
| mergeFieldUrl, | ||
| mergeFieldTrim, | ||
| mergeFieldLength, | ||
| ]); | ||
| api.postTemplateRender(template).then((data) => { | ||
| console.log(data.response.id); | ||
| }); | ||
| ``` | ||
| ## Video Editing Schemas | ||
@@ -174,3 +297,3 @@ | ||
| .setMerge(merge) | ||
| .setCallback("https://my-server.com/callback.php") | ||
| .setCallback('https://my-server.com/callback.php') | ||
| .setDisk("local"); | ||
@@ -187,3 +310,3 @@ ``` | ||
| setCallback(string callback) | An optional webhook callback URL used to receive status notifications when a render completes or fails. See [webhooks](https://shotstack.io/docs/guide/architecting-an-application/webhooks/) for more details. | - | ||
| setDisk(string disk) | The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types/) for more details. [default to `local`] <ul><li>`local` - optimized for high speed rendering with up to 512MB storage</li><li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li></ul> | - | ||
| setDisk(string disk) | **(Deprecated)** The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types/) for more details. [default to `local`] <ul><li>`local` - optimized for high speed rendering with up to 512MB storage</li><li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li></ul> | - | ||
@@ -351,2 +474,3 @@ ----- | ||
| .setVolume(0.5) | ||
| .setVolumeEffect('fadeIn') | ||
| .setCrop(crop); | ||
@@ -362,2 +486,3 @@ ``` | ||
| setVolume(float level) | Set the volume for the video clip between 0 and 1 where 0 is muted and 1 is full volume (defaults to 0). | - | ||
| setVolumeEffect(string effect) | The volume effect to apply to the video asset.<ul><li>`fadeIn` - fade volume in only</li><li>`fadeOut` - fade volume out only</li><li>`fadeInFadeOut` - fade volume in and out</li></ul> | - | ||
| setCrop([Shotstack.Crop](#crop) crop) | Crop the sides of an asset by a relative amount. The size of the crop is specified using a scale between 0 and 1, relative to the screen width - i.e. a left crop of 0.5 will crop half of the asset from the left, a top crop of 0.25 will crop the top by quarter of the asset. | - | ||
@@ -553,4 +678,4 @@ | ||
| :--- | :--- | :---: | ||
| setX(float x) | Offset an asset on the horizontal axis (left or right), range varies from -1 to 1. Positive numbers move the asset right, negative left. For all assets except titles the distance moved is relative to the width of the viewport - i.e. an X offset of 0.5 will move the asset half the screen width to the right. [default to `0`] | - | ||
| setY(float y) | Offset an asset on the vertical axis (up or down), range varies from -1 to 1. Positive numbers move the asset up, negative down. For all assets except titles the distance moved is relative to the height of the viewport - i.e. an Y offset of 0.5 will move the asset up half the screen height. [default to `0`] | - | ||
| setX(float x) | Offset an asset on the horizontal axis (left or right), range varies from -10 to 10. Positive numbers move the asset right, negative left. For all assets except titles the distance moved is relative to the width of the viewport - i.e. an X offset of 0.5 will move the asset half the screen width to the right. [default to `0`] | - | ||
| setY(float y) | Offset an asset on the vertical axis (up or down), range varies from -10 to 10. Positive numbers move the asset up, negative down. For all assets except titles the distance moved is relative to the height of the viewport - i.e. an Y offset of 0.5 will move the asset up half the screen height. [default to `0`] | - | ||
@@ -707,2 +832,53 @@ --- | ||
| ## Template Schemas | ||
| The following schemas specify how to use templates to store and render templates. A template lets you save an | ||
| [Edit](#edit) that can be rendered by its template ID and optionally include merge fields that are merged with the | ||
| template when rendered. | ||
| ### Template | ||
| A template is a saved [Edit](#edit) than can be loaded and re-used. | ||
| #### Example: | ||
| ```javascript | ||
| const Shotstack = require('shotstack-sdk'); | ||
| const template = new Shotstack.Template; | ||
| template | ||
| .setName('My Template') | ||
| .setTemplate(edit); | ||
| ``` | ||
| #### Methods: | ||
| Method | Description | Required | ||
| :--- | :--- | :---: | ||
| setName(string name) | The template name. | Y | ||
| setTemplate([Shotstack.Edit](#edit) edit)) | An edit defines the arrangement of a video on a timeline, an audio edit or an image design and the output format. | Y | ||
| ### TemplateRender | ||
| Configure the id and optional merge fields to render a template by id. | ||
| #### Example: | ||
| ```javascript | ||
| const Shotstack = require('shotstack-sdk'); | ||
| const template = new Shotstack.TemplateRender; | ||
| template | ||
| .setId('21e781c0-8232-4418-fec1-cc99f0280c21') | ||
| .setMerge(merge); | ||
| ``` | ||
| #### Methods: | ||
| Method | Description | Required | ||
| :--- | :--- | :---: | ||
| setId(string id) | The id of the template to render in UUID format. | Y | ||
| setMerge([Shotstack.MergeField[]](#mergefield) mergeField) | An array of key/value pairs that provides an easy way to create templates with placeholders. The placeholders can be used to find and replace keys with values. For example you can search for the placeholder `{{NAME}}` and replace it with the value `Jane`. | - | ||
| --- | ||
| ## Output Schemas | ||
@@ -730,2 +906,3 @@ | ||
| .setRepeat(true) | ||
| .setMute(false) | ||
| .setRange(range) | ||
@@ -749,2 +926,3 @@ .setPoster(poster) | ||
| setRepeat(bool repeat) | Loop settings for gif files. Set to `true` to loop, `false` to play only once. [default to `true`] | - | ||
| setMute(bool mute) | Mute the audio track of the output video. Set to `true` to mute, `false` to un-mute. | - | ||
| setRange([Shotstack.Range](#range) range) | Specify a time range to render, i.e. to render only a portion of a video or audio file. Omit this setting to export the entire video. Range can also be used to render a frame at a specific time point - setting a range and output format as `jpg` will output a single frame image at the range `start` point. | - | ||
@@ -851,2 +1029,4 @@ setPoster([Shotstack.Poster](#poster) poster) | Generate a poster image from a specific point on the timeline. | - | ||
| ## Destinations | ||
| ### ShotstackDestination | ||
@@ -871,3 +1051,3 @@ | ||
| :--- | :--- | :---: | ||
| setProvider(string provider) | The destination to send rendered assets to - set to `shotstack` for Shotstack hosting and CDN. [default to `shotstack`] | Y | ||
| setProvider(string provider) | The destination to send rendered assets to - set to `shotstack` for Shotstack. | Y | ||
| setExclude(bool exclude) | Set to `true` to opt-out from the Shotstack hosting and CDN service. All files must be downloaded within 24 hours of rendering. [default to `false`] | - | ||
@@ -877,2 +1057,95 @@ | ||
| ### MuxDestination | ||
| Send rendered videos to the [Mux](https://shotstack.io/docs/guide/serving-assets/destinations/mux) video hosting and | ||
| streaming service. Mux credentials are required and added via the | ||
| [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request. | ||
| #### Example: | ||
| ```javascript | ||
| const Shotstack = require('shotstack-sdk'); | ||
| const muxDestination = new Shotstack.MuxDestination; | ||
| muxDestination | ||
| .setProvider('mux') | ||
| .setOptions(muxDestinationOptions); | ||
| ``` | ||
| #### Methods: | ||
| Name | Description | Required | ||
| :--- | :--- | :---: | ||
| setProvider(string provider) | The destination to send rendered assets to - set to `mux` for Mux. | Y | ||
| setOptions([MuxDestinationOptions](#muxdestinationoptions) options) | Additional Mux configuration and features. | - | ||
| ### MuxDestinationOptions | ||
| Pass additional options to control how Mux processes video. Currently supports playback policy option. | ||
| #### Example: | ||
| ```javascript | ||
| const Shotstack = require('shotstack-sdk'); | ||
| const muxDestinationOptions = new Shotstack.MuxDestinationOptions; | ||
| muxDestinationOptions | ||
| .setPlaybackPolicy(['public']); | ||
| ``` | ||
| #### Methods: | ||
| Name | Description | Required | ||
| :--- | :--- | :---: | ||
| setPlaybackPolicy([string] policy) | Sets the Mux `playback_policy` option. Value is an array of strings - use **public**, **signed**, or both. | - | ||
| ### S3Destination | ||
| Send rendered videos to an [Amazon S3](https://shotstack.io/docs/guide/serving-assets/destinations/s3) bucket. Send | ||
| files to any region with your own prefix and filename. AWS credentials are required and added via the | ||
| [dashboard](https://dashboard.shotstack.io/integrations/s3), not in the request. | ||
| #### Example: | ||
| ```javascript | ||
| const Shotstack = require('shotstack-sdk'); | ||
| const s3Destination = new Shotstack.S3Destination; | ||
| s3Destination | ||
| .setProvider('s3') | ||
| .setOptions(S3DestinationOptions); | ||
| ``` | ||
| #### Methods: | ||
| Name | Description | Required | ||
| :--- | :--- | :---: | ||
| setProvider(string provider) | The destination to send rendered assets to - set to `s3` for S3. | Y | ||
| setOptions([S3DestinationOptions](#s3destinationoptions) options) | Additional S3 configuration options. | - | ||
| ### S3DestinationOptions | ||
| Pass additional options to control how files are stored in S3. | ||
| #### Example: | ||
| ```javascript | ||
| const Shotstack = require('shotstack-sdk'); | ||
| const S3DestinationOptions = new Shotstack.S3DestinationOptions; | ||
| S3DestinationOptions | ||
| .setRegion('us-east-1'); | ||
| .setBucket('my-bucket'); | ||
| .setPrefix('my-renders'); | ||
| .setFilename('my-file'); | ||
| .setAcl('public-read'); | ||
| ``` | ||
| #### Methods: | ||
| Name | Description | Required | ||
| :--- | :--- | :---: | ||
| setRegion(string region) | Choose the region to send the file to. Must be a valid [AWS region](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) string like `us-east-1` or `ap-southeast-2` | Y | ||
| setBucket(string bucket) | The bucket name to send files to. The bucket must exist in the AWS account before files can be sent. | Y | ||
| setPrefix(string prefix) | A prefix for the file being sent. This is typically a folder name, i.e. `videos` or `customerId/videos`. | - | ||
| setFilename(string filename) | Use your own filename instead of the default render ID filename. Note: omit the file extension as this will be appended depending n the output format. Also `poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images. | - | ||
| setAcl(string acl) | Sets the S3 Access Control List (acl) permissions. Default is `private`. Must use a valid S3 [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl). | - | ||
| ## Render Response Schemas | ||
@@ -946,2 +1219,94 @@ | ||
| --- | ||
| ## Template Response Schemas | ||
| The following schemas are returned by the templates endpoint, including create, update and rendering a template. | ||
| ### TemplateResponse | ||
| The response received after a [template](#create-template) is submitted. The template is saved and a unique | ||
| template id is returned. | ||
| #### Methods: | ||
| Method | Description | Required | ||
| :--- | :--- | :---: | ||
| getSuccess(): bool | `true` if successfully queued, else `false`. | Y | ||
| getMessage(): string | `Created`, `Bad Request` or an error message. | Y | ||
| getResponse(): [Shotstack.TemplateResponseData](#templateresponsedata) | `TemplateResponseData` or an error message. | Y | ||
| ### TemplateResponseData | ||
| The response data returned with the [Shotstack.TemplateResponse](#templateresponse). | ||
| #### Methods: | ||
| Method | Description | Required | ||
| :--- | :--- | :---: | ||
| getMessage(): string | Success response message or error details. | Y | ||
| getId(): string | The unique id of the template in UUID format. | Y | ||
| ### TemplateDataResponse | ||
| The template data including the template name and [Edit](#edit). | ||
| #### Methods: | ||
| Method | Description | Required | ||
| :--- | :--- | :---: | ||
| getSuccess(): bool | `true` if successfully queued, else `false`. | Y | ||
| getMessage(): string | `Created`, `Bad Request` or an error message. | Y | ||
| getResponse(): [Shotstack.TemplateDataResponseData](#templatedataresponsedata) | `TemplateDataResponseData` or an error message. | Y | ||
| ### TemplateDataResponseData | ||
| The response data returned with the [TemplateDataResponse](#templatedataresponse). | ||
| #### Methods: | ||
| Method | Description | Required | ||
| :--- | :--- | :---: | ||
| getId(): string | The unique id of the template in UUID format. | Y | ||
| getName(): string | The template name. | Y | ||
| getOwner(): string | The owner id of the templates. | Y | ||
| getTemplate(): [Shotstack.Edit](#edit) | `Edit` or an error message. | Y | ||
| ### TemplateListResponse | ||
| A list of previously saved templates. | ||
| #### Methods: | ||
| Method | Description | Required | ||
| :--- | :--- | :---: | ||
| getSuccess(): bool | `true` if successfully queued, else `false`. | Y | ||
| getMessage(): string | `Created`, `Bad Request` or an error message. | Y | ||
| getResponse(): [Shotstack.TemplateListResponseData](#templatelistresponsedata) | `TemplateListResponseData` or an error message. | Y | ||
| ### TemplateListResponseData | ||
| The response data returned with the [TemplateListResponse](#templatelistresponse). | ||
| #### Methods: | ||
| Method | Description | Required | ||
| :--- | :--- | :---: | ||
| getOwner(): bool | The owner id of the templates. | Y | ||
| getTemplates(): [[Shotstack.TemplateListResponseItem]](#templatelistresponseitem) | The list of templates. | Y | ||
| ### TemplateListResponseItem | ||
| The individual template item returned with the [TemplateListResponseData](#templatelistresponsedata) templates | ||
| list. | ||
| #### Methods: | ||
| Method | Description | Required | ||
| :--- | :--- | :---: | ||
| getId(): string | The unique id of the template in UUID format. | Y | ||
| getName(): string | The template name | Y | ||
| getCreated(): string | The time the template was created. | - | ||
| getUpdated(): string | The time the template was last updated. | - | ||
| --- | ||
| ## Inspecting Media | ||
@@ -948,0 +1313,0 @@ |
+18
-0
@@ -511,2 +511,20 @@ /** | ||
| /** | ||
| * Returns The volume effect to apply to the video asset <ul> <li>`fadeIn` - fade volume in only</li> <li>`fadeOut` - fade volume out only</li> <li>`fadeInFadeOut` - fade volume in and out</li> </ul> | ||
| * @return {module:model/Asset.VolumeEffectEnum} | ||
| */ | ||
| exports.prototype.getVolumeEffect = function() { | ||
| return this['volumeEffect']; | ||
| } | ||
| /** | ||
| * Sets The volume effect to apply to the video asset <ul> <li>`fadeIn` - fade volume in only</li> <li>`fadeOut` - fade volume out only</li> <li>`fadeInFadeOut` - fade volume in and out</li> </ul> | ||
| * @param {module:model/Asset.VolumeEffectEnum} volumeEffect The volume effect to apply to the video asset <ul> <li>`fadeIn` - fade volume in only</li> <li>`fadeOut` - fade volume out only</li> <li>`fadeInFadeOut` - fade volume in and out</li> </ul> | ||
| */ | ||
| exports.prototype.setVolumeEffect = function(volumeEffect) { | ||
| this['volumeEffect'] = volumeEffect; | ||
| return this; | ||
| } | ||
| /** | ||
| * @return {module:model/Crop} | ||
@@ -513,0 +531,0 @@ */ |
@@ -104,3 +104,3 @@ /** | ||
| /** | ||
| * The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types) for more details. <ul> <li>`local` - optimized for high speed rendering with up to 512MB storage</li> <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul> | ||
| * **Notice: This option is now deprecated and will be removed. Disk types are handled automatically. Setting a disk type has no effect.** The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types) for more details. <ul> <li>`local` - optimized for high speed rendering with up to 512MB storage</li> <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul> | ||
| * @member {module:model/Edit.DiskEnum} disk | ||
@@ -180,3 +180,3 @@ */ | ||
| /** | ||
| * Returns The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types) for more details. <ul> <li>`local` - optimized for high speed rendering with up to 512MB storage</li> <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul> | ||
| * Returns **Notice: This option is now deprecated and will be removed. Disk types are handled automatically. Setting a disk type has no effect.** The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types) for more details. <ul> <li>`local` - optimized for high speed rendering with up to 512MB storage</li> <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul> | ||
| * @return {module:model/Edit.DiskEnum} | ||
@@ -189,4 +189,4 @@ */ | ||
| /** | ||
| * Sets The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types) for more details. <ul> <li>`local` - optimized for high speed rendering with up to 512MB storage</li> <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul> | ||
| * @param {module:model/Edit.DiskEnum} disk The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types) for more details. <ul> <li>`local` - optimized for high speed rendering with up to 512MB storage</li> <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul> | ||
| * Sets **Notice: This option is now deprecated and will be removed. Disk types are handled automatically. Setting a disk type has no effect.** The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types) for more details. <ul> <li>`local` - optimized for high speed rendering with up to 512MB storage</li> <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul> | ||
| * @param {module:model/Edit.DiskEnum} disk **Notice: This option is now deprecated and will be removed. Disk types are handled automatically. Setting a disk type has no effect.** The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types) for more details. <ul> <li>`local` - optimized for high speed rendering with up to 512MB storage</li> <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul> | ||
| */ | ||
@@ -193,0 +193,0 @@ exports.prototype.setDisk = function(disk) { |
@@ -46,6 +46,10 @@ /** | ||
| * @class | ||
| * @param region {String} Choose the region to send the file to. Must be a valid [AWS region](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) string like `us-east-1` or `ap-southeast-2`. | ||
| * @param bucket {String} The bucket name to send files to. The bucket must exist in the AWS account before files can be sent. | ||
| */ | ||
| var exports = function() { | ||
| var exports = function(region, bucket) { | ||
| var _this = this; | ||
| _this['region'] = region; | ||
| _this['bucket'] = bucket; | ||
| }; | ||
@@ -83,3 +87,3 @@ | ||
| /** | ||
| * Choose the region to send the file to. Must be a valid [AWS region] string like `us-east-1` or `ap-southeast-2`. | ||
| * Choose the region to send the file to. Must be a valid [AWS region](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) string like `us-east-1` or `ap-southeast-2`. | ||
| * @member {String} region | ||
@@ -111,3 +115,3 @@ */ | ||
| /** | ||
| * Returns Choose the region to send the file to. Must be a valid [AWS region] string like `us-east-1` or `ap-southeast-2`. | ||
| * Returns Choose the region to send the file to. Must be a valid [AWS region](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) string like `us-east-1` or `ap-southeast-2`. | ||
| * @return {String} | ||
@@ -120,4 +124,4 @@ */ | ||
| /** | ||
| * Sets Choose the region to send the file to. Must be a valid [AWS region] string like `us-east-1` or `ap-southeast-2`. | ||
| * @param {String} region Choose the region to send the file to. Must be a valid [AWS region] string like `us-east-1` or `ap-southeast-2`. | ||
| * Sets Choose the region to send the file to. Must be a valid [AWS region](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) string like `us-east-1` or `ap-southeast-2`. | ||
| * @param {String} region Choose the region to send the file to. Must be a valid [AWS region](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) string like `us-east-1` or `ap-southeast-2`. | ||
| */ | ||
@@ -124,0 +128,0 @@ exports.prototype.setRegion = function(region) { |
@@ -43,3 +43,3 @@ /** | ||
| * Constructs a new <code>TemplateRender</code>. | ||
| * Render a template by it's id and optional merge fields. | ||
| * Configure the id and optional merge fields to render a template by id. | ||
| * @alias module:model/TemplateRender | ||
@@ -46,0 +46,0 @@ * @class |
@@ -43,3 +43,3 @@ /** | ||
| * Constructs a new <code>TemplateResponse</code>. | ||
| * The response received after a [template](#create-a-template) is submitted. The template is saved and a unique template id is returned. | ||
| * The response received after a [template](#create-template) is submitted. The template is saved and a unique template id is returned. | ||
| * @alias module:model/TemplateResponse | ||
@@ -46,0 +46,0 @@ * @class |
Network access
Supply chain riskThis module accesses the network.
Found 1 instance in 1 package
Dynamic require
Supply chain riskDynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.
Found 1 instance in 1 package
Filesystem access
Supply chain riskAccesses the file system, and could potentially read sensitive data.
Found 1 instance in 1 package
Long strings
Supply chain riskContains long string literals, which may be a sign of obfuscated or packed code.
Found 1 instance in 1 package
URL strings
Supply chain riskPackage contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.
Found 1 instance in 1 package
Network access
Supply chain riskThis module accesses the network.
Found 1 instance in 1 package
Dynamic require
Supply chain riskDynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.
Found 1 instance in 1 package
Filesystem access
Supply chain riskAccesses the file system, and could potentially read sensitive data.
Found 1 instance in 1 package
Long strings
Supply chain riskContains long string literals, which may be a sign of obfuscated or packed code.
Found 1 instance in 1 package
URL strings
Supply chain riskPackage contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.
Found 1 instance in 1 package
523503
2.87%11298
0.17%1467
33.12%