Shotstack Node Examples
text.js - Create a HELLO WORLD video title against black background with a zoom in motion effect and soundtrack.
images.js - Takes an array of image URLs and creates a video with a soundtrack and simple zoom in effect.
titles.js - Create a video to demo titles using the available preset font styles, a soundtrack, zoom in motion effect and wipe right transition.
trim.js - Trim the start and end of a video clip to output a shortened video.
filters.js - Applies filters to a video clip, including a title with the name of the filter and a soundtrack.
picture-in-picture.js - Layer a small foreground clip, using position and scale, over a fullscreen background clip, to create a picture in picture effect.
merge.js - Merge data in to a video using merge fields.
transform.js - Apply transformations (rotate, skew and flip) to a video clip.
border.js - Add a border frame around a background photo.
gif.js - Create an animated gif that plays once.
- status.js - Shows the status of a render task and the output video URL. Run this after running one of the render examples.
- probe.js - Fetch metadata for any media asset on the internet such as width, height, duration, etc...
Asset management examples
serve-api/renderId.js - Fetch all assets associated with a render ID. Includes video or image and thumbnail and poster.
serve-api/assetId.js - Fetch an individual asset by asset ID.
serve-api/destination.js - Shows how to exclude a render from being sent to the Shotstack hosting destination.
Install the required dependencies including the Shotstack Node SDK
Set your API key
The demos use the staging endpoint by default so use your provided staging key:
Windows users (Command Prompt):
You can get an API key via the Shotstack web site.
Run an example
The examples directory includes a number of examples demonstrating the capabilities of the Shotstack API.
To run a rendering/editing example run the examples at the root of the examples folder, e.g. to run the images video example:
To check the status of a render, similar to polling run the
status.js example with the render ID, e.g.:
node examples/status.js 8b844085-779c-4c3a-b52f-d79deca2a960
To look up assets hosted by Shotstack run the examples in the examples/serve-api directory.
Find assets by render ID:
node examples/serve-api/renderId.js 8b844085-779c-4c3a-b52f-d79deca2a960
Find an asset by asset ID:
node examples/serve-api/assetId.js 3f446298-779c-8c8c-f253-900c1627b776