Official Mux API wrapper for Node projects.
This library is intended to provide Mux API convenience methods for applications written in server-side Javascript. Please note that this package uses Mux access tokens and secret keys and is intended to be used in server-side code only.
Not familiar with Mux? Check out https://mux.com/ for more information.
See the Mux-Node docs
npm install @mux/mux-node --save
or
yarn add @mux/mux-node
To start, you will need a Mux access token and secret for your Mux environment. For more information on where to get an access token, visit the Mux Getting Started guide https://docs.mux.com/docs
Require the @mux/mux-node
npm module and create a Mux instance. Your Mux instance will have Data
and Video
properties
that will allow you to access the Mux Data and Video APIs.
const Mux = require('@mux/mux-node');
const { Video, Data } = new Mux(accessToken, secret);
If a token ID and secret aren't included as parameters, the SDK will attempt to use the MUX_TOKEN_ID
and MUX_TOKEN_SECRET
environment variables.
// assume process.env.MUX_TOKEN_ID and process.env.MUX_TOKEN_SECRET contain your credentials
const muxClient = new Mux(); // Success!
As an example, you can create a Mux asset and playback ID by using the below functions on your Video instance.
// Create an asset
const asset = await Video.Assets.create({
input: 'https://storage.googleapis.com/muxdemofiles/mux-video-intro.mp4',
});
// ...then later, a playback ID for that asset
const playbackId = await Video.Assets.createPlaybackId(asset.id, {
policy: 'public',
});
Or, if you don't have the files online already, you can ingest one via the direct uploads API.
const request = require('request');
let upload = await Video.Uploads.create({
new_asset_settings: { playback_policy: 'public' },
});
// The URL you get back from the upload API is resumable, and the file can be uploaded using a `PUT` request (or a series of them).
await fs.createReadStream('/path/to/your/file').pipe(request.put(upload.url));
// The upload may not be updated immediately, but shortly after the upload is finished you'll get a `video.asset.created` event and the upload will now have a status of `asset_created` and a new `asset_id` key.
let updatedUpload = await Video.Uploads.get(upload.id);
// Or you could decide to go get additional information about that new asset you created.
let asset = await Video.Assets.get(updatedUpload['asset_id']);
You can access the Mux Data API in the same way by using your Data instance. For example, you can list all of the
values across every breakdown for the aggregate_startup_time
metric by using the below function.
const breakdown = await Data.Metrics.breakdown('aggregate_startup_time', {
group_by: 'browser',
});
Every function will return a chainable Promise.
Video.Assets.create({
input: 'https://storage.googleapis.com/muxdemofiles/mux-video-intro.mp4',
}).then(asset => {
/* Do things with the asset */
});
The SDK returns the data
key for every object, because in the Mux API that's always the thing you actually want to see. Sometimes, however, it's useful to see more details about the request being made or the full response object. You can listen for request
and response
events to get these raw objects.
muxClient.on('request', req => {
// Request will contain everything being sent such as `headers, method, base url, etc
});
muxClient.on('response', res => {
// Response will include everything returned from the API, such as status codes/text, headers, etc
});
See the Mux-Node docs for a list of all available functions.
Run unit tests: npm test
or npm run test:unit
Run integration tests: npm run test:int
Note: running the integration tests will require you to configure the MUX_TOKEN_ID
and MUX_TOKEN_SECRET
environment variables with your Mux access token and secret.
To generate the ESDocs, run:
yarn esdoc
open ./docs/index.html
Find a bug or want to add a useful feature? That'd be amazing! If you'd like to submit a pull request to the project with changes, please do something along these lines:
- Fork the project wherever you'd like
- Create a meaningful branch name that relates to your contribution. Consider including an issue number if available.
git co -b add-node-lts-support
- Make any changes you'd like in your forked branch.
- Add any relevant tests for your changes
- Open the pull request! 🎉