Test

Unit::Base

Base

allows configuration to be passed in as params

allows configuration to be passed in via environment variables

prioritizes params over environment variables

allows configuration to be passed in via the parent instance

http requests

fire an event on a request

fire an event on a response

Unit::Data

Data

throws an error if an api key is not given

throws an error if a secret key is not given

creates a new Data instance

Unit::Errors

Unit::Exports

Unit::Filters

Filters

throws an error if an api key is not given

throws an error if a secret key is not given

creates a new Filters instance

Filters.get

throws an error if a filter Id is not provided

Unit::Incidents

Incidents

throws an error if an api key is not given

throws an error if a secret key is not given

creates a new Incidents instance

Incidents.get

throws an error if an incident Id is not provided

Incidents.related

throws an error if an incident Id is not provided

makes a get request to the Mux data incidents route

Unit::Metrics

Metrics

throws an error if an api key is not given

throws an error if a secret key is not given

creates a new Metrics instance

Metrics.comparison

throws an error if the value query parameter is not provided

Metrics.insights

throws an error if a metric Id is not provided

Metrics.overall

throws an error if a metric Id is not provided

Metrics.timeseries

throws an error if a metric Id is not provided

Unit::RealTime

RealTime

throws an error if an api key is not given

throws an error if a secret key is not given

creates a new RealTime instance

RealTime.breakdown

throws an error if the value query parameter is not provided

RealTime.histogramTimeseries

throws an error if the value query parameter is not provided

RealTime.timeseries

throws an error if the value query parameter is not provided

Unit::VideoViews

VideoViews

throws an error if an api key is not given

throws an error if a secret key is not given

creates a new VideoViews instance

Unit::Mux

Mux

exposes Mux Video and Data as instance methods

exposes JWT Helper utilities as static methods

exposes Webhooks.verifyHeader

Utils::JWT

sign

defaults to video and includes an expiration

maps type video to v

maps type thumbnail to t

maps type gif to g

maps type storyboard to s

takes a file path for a secret

falls back to using environment variables for the key and secret

accepts a timestamp or time shorthand

Unit::Assets

Assets

throws an error if an api key is not given

throws an error if a secret key is not given

creates a new Assets instance

Assets.create

throws an error if no asset params are given

Assets.get

throws an error when an asset id is not given

Assets.del

throws an error when an asset id is not given

Assets.inputInfo

throws an error when an asset id is not given

Assets.list

makes a GET request to list 100 assets offset by 2 pages

Assets.deletePlaybackId

makes a DELETE request to delete a Playback Id for an asset

throws an error if an asset id is not given

Assets.playbackId

makes a GET request to get a Playback Id for an asset

throws an error if an asset id is not given

throws an error if playbackId params are not given

Assets.createTrack

makes a POST request to create a text track for an asset

throws an error if an asset id is not given

throws an error if track params are not given

Assets.deleteTrack

makes a DELETE request to delete a text track for an asset

throws an error if an asset id is not given

throws an error if text track ID is not given

Unit::DeliveryUsage

DeliveryUsage.list

makes a GET request to list 100 delivery usage records offset by 2 pages with a timeframe

Unit::LiveStreams

LiveStreams

throws an error if an api key is not given

throws an error if a secret key is not given

creates a new LiveStreams instance

LiveStreams.del

throws an error when a live stream ID is not given

LiveStreams.list

makes a GET request to list 100 live streams offset by 2 pages

LiveStreams.get

throws an error when a live stream ID is not given

LiveStreams.signalComplete

throws an error when a live stream ID is not given

LiveStreams.resetStreamKey

throws an error when a live stream ID is not given

LiveStreams.createPlaybackId

throws an error if a live stream ID is not given

LiveStreams.deletePlaybackId

throws an error if a live stream ID is not given

LiveStreams.createSimulcastTarget

throws an error if a live stream ID is not given

LiveStreams.getSimulcastTarget

throws an error if a live stream ID is not given

throws an error if a simulcast target id is not given

LiveStreams.deleteSimulcastTarget

throws an error if a live stream ID is not given

throws an error if a simulcast target id is not given

LiveStreams.enable

throws an error if a live stream ID is not given

LiveStreams.disable

throws an error if a live stream ID is not given

Unit::PlaybackIds

PlaybackIds

throws an error if an api key is not given

throws an error if a secret key is not given

creates a new PlaybackIds instance

PlaybackIds.get

throws an error when an playback ID is not given

Unit::SigningKeys

SigningKeys.get

throws an error when an key id is not given

SigningKeys.del

throws an error when an key id is not given

SigningKeys.list

makes a GET request to list 100 signing keys offset by 2 pages

Unit::Uploads

Uploads.create

throws an error if no params are given

Uploads.get

throws an error when an upload id is not given

Uploads.cancel

throws an error when an upload id is not given

Uploads.list

makes a GET request to list 100 uploads offset by 2 pages

Unit::Video

Video

throws an error if an api key is not given

throws an error if a secret key is not given

creates a new Video instance

Unit::VerifyHeader

VerifyHeader

parseHeader with a known-hard coded header value

will correctly parse the header value to the known timestamp and signature

verify

with a malformatted header value

will throw an unable to extract timestamp and signatures error

with a header value that has the wrong scheme

will throw a no signatures found with expected scheme error

with a header value that is valid expect that it is outside the tolerated time range

will throw a timestamp outside the tolerance zone error

with a header value that is actually valid

will return true when the payload is a string

will return true when the payload is a buffer

Unit::Webhooks

verifyHeader

returns true for a valid header