Skip to content

Latest commit

 

History

History
214 lines (138 loc) · 5.79 KB

README.md

File metadata and controls

214 lines (138 loc) · 5.79 KB
Raw

Shotstack Node Examples

Examples

Video 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.

  • merge-trim.js - Trim a video using merge fields. Replace the URL, trim and length using placeholders and merge field values.

  • transform.js - Apply transformations (rotate, skew and flip) to a video clip.

  • progress.js - Animate and overlay a progress bar on to a video using an HTML asset.

  • frames.js - A frame accurate counter, useful for testing frame accuracy.

  • countdown.js - A simple 10 second count down video, variables can be adjusted to created different speeds and counts.

  • countup.js - A simple 10 second count up video, variables can be adjusted to created different speeds and counts.

  • stitch.js - Stitch together multiple video clips into a single video.

Image examples

  • border.js - Add a border frame around a background photo.

  • gif.js - Create an animated gif that plays once.

Smart clip examples

  • videos-auto - Automatically sequence a series of video clips so that they play one after another.

  • images-auto - Automatically sequence a series of images so that they display one after another.

Template examples

  • templates/create.js Save an edit as a re-usable template with placeholders.

  • templates/render.js Render a template using merge fields to replace placeholders.

  • templates/templates.js Get a list of all templates.

  • templates/templates.js Get an individual template by template ID.

Polling example

  • status.js - Shows the status of a render task and the output video URL. Run this after running one of the render examples.

Probe example

  • probe.js - Fetch metadata for any media asset on the internet such as width, height, duration, etc...

Storage and hosting 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.

  • destination.js - Shows how to exclude a render from being sent to the Shotstack hosting destination.

  • 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).

Generative AI examples

  • create-api/text-to-image.js - Generate an image using the Shotstack text-to-image provider.

Ingest and transformation examples

  • ingest-api/resize-video.js - Resize a video from 1080p to 720p resolution.

Installation

Install the required dependencies including the Shotstack Node SDK

npm install

Set your API key

The demos use the staging endpoint by default so use your provided staging key:

export SHOTSTACK_KEY=your_key_here

Windows users (Command Prompt):

set SHOTSTACK_KEY=your_key_here

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.

Video editing (Edit API)

To run a rendering/editing example run the examples at the root of the examples folder.

To run the images video example:

node examples/images.js

To check the status of a render, run the status.js example with the render ID:

node examples/status.js 8b844085-779c-4c3a-b52f-d79deca2a960

Storing and hosting assets (Serve API)

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

or

Find an asset by asset ID:

node examples/serve-api/assetId.js 3f446298-779c-8c8c-f253-900c1627b776

Generating assets using AI (Create API)

To create assets using Generative AI providers run the examples in the examples/create-api directory.

To generate an image using the Shotstack text-to-image provider:

node examples/create-api/text-to-image.js

To check the status of a create task, run the status.js example with the asset ID:

node examples/create-api/status.js 01gx3-2827k-dxmpz-x5n32-chw4oq

Ingesting and transforming/transcoding assets (Ingest API)

To ingest and transform/transcode assets run the examples in the examples/ingest-api directory.

To resize a video from 1080p to 720p resolution:

node examples/ingest-api/resize-video.js

To check the status of an ingest task, run the status.js example with the ingest ID:

node examples/ingest-api/status.js zzy7wxvy-1h1e-vt4j-kn0y-3qn7kj1hocpw