You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
setProvider(string provider) | The destination to send rendered assets to - set to `shotstack` for Shotstack hosting and CDN. [default to `shotstack`] | Y
863
+
setProvider(string provider) | The destination to send rendered assets to - set to `shotstack` for Shotstack. | Y
862
864
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`] | -
setPlaybackPolicy([string] policy) | Sets the Mux `playback_policy` option. Value is an array of strings - use **public**, **signed**, or both. | -
908
+
setPlaybackPolicy([string] policy) | Sets the Mux `playback_policy` option. Value is an array of strings - use **public**, **signed**, or both. | -
909
+
910
+
### S3Destination
911
+
912
+
Send rendered videos to an [Amazon S3](https://shotstack.io/docs/guide/serving-assets/destinations/s3) bucket. Send
913
+
files to any region with your own prefix and filename. AWS credentials are required and added via the
914
+
[dashboard](https://dashboard.shotstack.io/integrations/s3), not in the request.
915
+
916
+
#### Example:
917
+
918
+
```javascript
919
+
constShotstack=require('shotstack-sdk');
920
+
921
+
consts3Destination=newShotstack.S3Destination;
922
+
s3Destination
923
+
.setProvider('s3')
924
+
.setOptions(S3DestinationOptions);
925
+
```
926
+
#### Methods:
927
+
928
+
Name | Description | Required
929
+
:--- | :--- | :---:
930
+
setProvider(string provider) | The destination to send rendered assets to - set to `s3` for S3. | Y
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
955
+
setBucket(string bucket) | The bucket name to send files to. The bucket must exist in the AWS account before files can be sent. | Y
956
+
setPrefix(string prefix) | A prefix for the file being sent. This is typically a folder name, i.e. `videos` or `customerId/videos`. | -
957
+
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. | -
958
+
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). | -
0 commit comments