Skip to content

Commit dae0501

Browse files
author
Jeff Shillitto
committed
Add Mux destination to readme
1 parent e2b23c1 commit dae0501

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@ For examples of how to use the SDK to create videos using code checkout the Node
4343
- [Range](#range)
4444
- [Poster](#poster)
4545
- [Thumbnail](#thumbnail)
46+
- [Destinations](#destinations)
4647
- [ShotstackDestination](#shotstackdestination)
48+
- [MuxDestination](#muxdestination)
49+
- [MuxDestinationOptions](#muxdestinationoptions)
4750
- [Render Response Schemas](#render-response-schemas)
4851
- [QueuedResponse](#queuedresponse)
4952
- [QueuedResponseData](#queuedresponsedata)
@@ -834,6 +837,8 @@ setScale(float scale) | Scale the thumbnail size to a fraction of the viewport s
834837
835838
---
836839
840+
## Destinations
841+
837842
### ShotstackDestination
838843
839844
Send rendered assets to the Shotstack hosting and CDN service. This destination is enabled by default.
@@ -858,6 +863,48 @@ setExclude(bool exclude) | Set to `true` to opt-out from the Shotstack hosting a
858863
859864
---
860865
866+
### MuxDestination
867+
868+
Send rendered videos to the [Mux](https://shotstack.io/docs/guide/serving-assets/destinations/mux) video hosting and
869+
streaming service. Mux credentials are required and added via the
870+
[dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request.
871+
872+
#### Example:
873+
874+
```javascript
875+
const Shotstack = require('shotstack-sdk');
876+
877+
const muxDestination = new Shotstack.MuxDestination;
878+
muxDestination
879+
.setProvider('mux')
880+
.setOptions(options);
881+
```
882+
#### Methods:
883+
884+
Name | Description | Required
885+
:--- | :--- | :---:
886+
setProvider(string provider) | The destination to send rendered assets to - set to `mux` for Mux hosting and CDN. [default to `mux`] | Y
887+
setOptions([MuxDestinationOptions](#muxdestinationoptions) options) | Additional Mux configuration and features. | -
888+
889+
### MuxDestinationOptions
890+
891+
Pass additional options to control how Mux processes video. Currently supports playback policy option.
892+
893+
#### Example:
894+
895+
```javascript
896+
const Shotstack = require('shotstack-sdk');
897+
898+
const muxDestinationOptions = new Shotstack.MuxDestinationOptions;
899+
muxDestination
900+
.setPlaybackPolicy(['public']);
901+
```
902+
#### Methods:
903+
904+
Name | Description | Required
905+
:--- | :--- | :---:
906+
setPlaybackPolicy([string] policy) | Sets the Mux `playback_policy` option. Value is an array of strings - use **public**, **signed**, or both. | -
907+
861908
## Render Response Schemas
862909
863910
The following schemas are returned by the render request and status request.

0 commit comments

Comments
 (0)