Add S3 destination example

README.md

@@ -80,6 +80,10 @@
 - **mux.js** -
     Sends a rendered video to Mux hosting and excludes it from Shotstack. Requires a Mux account.
 
+- **s3.js** -
+    Sends a rendered video to an AWS S3 bucket and excludes it from Shotstack. Requires an AWS account and correctly
+    configured bucket (see: https://community.shotstack.io/t/s3-permission-issue/397).
+
 ### Installation
 
 Install the required dependencies including the [Shotstack Node SDK](https://www.npmjs.com/package/shotstack-sdk)

examples/s3.js

@@ -0,0 +1,111 @@
+/**
+ * S3 Destinations Demo
+ * Ensure S3 credentials are configured in the Shotstack dashboard and an S3 bucket has been configured before running this demo.
+ * See: https://shotstack.io/docs/guide/serving-assets/destinations/s3
+ * See: https://community.shotstack.io/t/s3-permission-issue/397
+ */
+const Shotstack = require('shotstack-sdk');
+
+const defaultClient = Shotstack.ApiClient.instance;
+const DeveloperKey = defaultClient.authentications['DeveloperKey'];
+const api = new Shotstack.EditApi();
+
+let apiUrl = 'https://api.shotstack.io/stage';
+
+if (!process.env.SHOTSTACK_KEY) {
+    console.log('API Key is required. Set using: export SHOTSTACK_KEY=your_key_here');
+    process.exit(1);
+}
+
+if (process.env.SHOTSTACK_HOST) {
+    apiUrl = process.env.SHOTSTACK_HOST;
+}
+
+defaultClient.basePath = apiUrl;
+DeveloperKey.apiKey = process.env.SHOTSTACK_KEY;
+
+const images = [
+    'https://s3-ap-southeast-2.amazonaws.com/shotstack-assets/examples/images/pexels/pexels-photo-712850.jpeg',
+    'https://s3-ap-southeast-2.amazonaws.com/shotstack-assets/examples/images/pexels/pexels-photo-867452.jpeg',
+    'https://s3-ap-southeast-2.amazonaws.com/shotstack-assets/examples/images/pexels/pexels-photo-752036.jpeg'
+];
+
+let clips = [];
+let start = 0;
+const length = 4;
+
+let soundtrack = new Shotstack.Soundtrack;
+soundtrack
+    .setSrc('https://s3-ap-southeast-2.amazonaws.com/shotstack-assets/music/gangsta.mp3')
+    .setEffect('fadeInFadeOut');
+
+images.forEach((image) => {
+    let imageAsset = new Shotstack.ImageAsset;
+    imageAsset
+        .setSrc(image);
+
+    let clip = new Shotstack.Clip;
+    clip
+        .setAsset(imageAsset)
+        .setStart(start)
+        .setLength(length)
+        .setEffect('zoomIn');
+
+    start = start + length;
+    clips.push(clip);
+});
+
+let track = new Shotstack.Track;
+track
+    .setClips(clips);
+
+let timeline = new Shotstack.Timeline;
+timeline
+    .setBackground('#000000')
+    .setSoundtrack(soundtrack)
+    .setTracks([track]);
+
+// Exclude from Shotstack hosting
+let shotstackDestination = new Shotstack.ShotstackDestination;
+shotstackDestination.setExclude(true);
+
+// Send to S3 bucket
+let s3Destination = new Shotstack.S3Destination;
+let s3Options = new Shotstack.S3DestinationOptions;
+
+// Configure the S3 options below with your own region, bucket, prefix and filename
+s3Options
+    .setRegion('ap-southeast-2')
+    .setBucket('my-bucket')
+    .setPrefix('my-folder')
+    .setFilename('my-video')
+    .setAcl('public-read');
+
+s3Destination.setOptions(s3Options);
+
+let output = new Shotstack.Output;
+output
+    .setFormat('mp4')
+    .setResolution('sd')
+    .setDestinations([
+        shotstackDestination,
+        s3Destination,
+    ]);
+
+let edit = new Shotstack.Edit;
+edit
+    .setTimeline(timeline)
+    .setOutput(output);
+
+api.postRender(edit).then((data) => {
+    let message = data.response.message;
+    let id = data.response.id
+
+    console.log(message + '\n');
+    console.log('>> Now check the progress of your render by running:');
+    console.log('>> node examples/status.js ' + id);
+
+}, (error) => {
+    console.error('Request failed: ', error);
+    process.exit(1);
+});