Mux v3.2.1 Mux.Token View Source

This module provides helpers for working with Playback IDs with signed playback policies. API Documentation

Link to this section Summary

option()

Create a signed URL token for a playback ID.

Create a signed URL token for a playback ID.

Create a signed URL token for a Space ID.

option() ::
  {:type, signature_type()}
  | {:expiration, integer()}
  | {:token_id, String.t()}
  | {:token_secret, String.t()}
  | {:params, any()}

options() :: [option()]

signature_type() :: :video | :thumbnail | :gif | :storyboard | :stats

sign(String.t(), options()) :: String.t()

Create a signed URL token for a playback ID.

options object can include:

options.token_id: Signing token ID (defaults to Application.get_env(:mux, :signing_token_id))
options.token_secret: Signing token secret (defaults to Application.get_env(:mux, :signing_token_secret))
options.type: Type of signature to create. Defaults to :video, options are: :video, :gif, :thumbnail, :storyboard
options.expiration: Seconds the token is valid for. Defaults to 7 days from now (604,800)
options.params: Map that includes any additional query params. For thumbnails this would be values like height or time.

This method has been deprecated in favor of Mux.Token.sign_playback_id

sign_playback_id(String.t(), options()) :: String.t()

Create a signed URL token for a playback ID.

options object can include:

options.token_id: Signing token ID (defaults to Application.get_env(:mux, :signing_token_id))
options.token_secret: Signing token secret (defaults to Application.get_env(:mux, :signing_token_secret))
options.type: Type of signature to create. Defaults to :video, options are: :video, :gif, :thumbnail, :storyboard
options.expiration: Seconds the token is valid for. Defaults to 7 days from now (604,800)
options.params: Map that includes any additional query params. For thumbnails this would be values like height or time.

sign_space_id(String.t(), options()) :: String.t()

Create a signed URL token for a Space ID.

options object can include:

options.token_id: Signing token ID (defaults to Application.get_env(:mux, :signing_token_id))
options.token_secret: Signing token secret (defaults to Application.get_env(:mux, :signing_token_secret))
options.expiration: Seconds the token is valid for. Defaults to 7 days from now (604,800)
options.params: Map that includes any additional query params. For thumbnails this would be values like height or time.