uiza-player-sdk

v5.20.701

Published

2 years ago

A simple, accessible and customizable HTML5, streaming media player

Downloads

0High
0Medium
0Low

leduong

HTML5 Video HTML5 Audio Media Player HLS HLS.js Uiza Uiza Player

Uiza Player Web SDK

Uiza Player is a simple, lightweight, accessible and customizable HTML5, media player that supports modern browsers.

Demos

You can try Uiza in Codepen using our minimal templates. For Streaming we also have example integrations with: Hls.js and VOD

Quick setup

HTML

Uiza Player extends upon the standard HTML5 media element markup so that's all you need for those types.

HLS Stream Video

<video id='playerUz' data-uiza-provider=hlsjs crossorigin playsinline autoplay></video>
<script>
  var videoStreamURL = 'https://1955897154.rsc.cdn77.org/live/116881ad-3463-4209-b16f-50e0e48add10/master.m3u8?cm=eyJlbnRpdHlfaWQiOiI2ZWUyMzk5NS1mNGFhLTQ1ZDMtOTM5NS0xN2NlNjBlZWJjNDAiLCJlbnRpdHlfc291cmNlIjoibGl2ZSIsImFwcF9pZCI6IjkyYThkMjAzMmZlODQ5MmFhNzc4MDRiNGMyYzUxOWM1In0=';

(async (options) => {
  var uiza = await new Uiza(document.getElementById('playerUz'), options);
  return { uiza, time: Date.now() };
})({src: videoStreamURL});
</script>

See initialising for more information on advanced setups.

You can use our CDN for the JavaScript. There's 2 versions; one with and one without polyfills. My recommendation would be to manage polyfills seperately as part of your application but to make life easier you can use the polyfilled build.

<script src="https://sdk.uiza.io/v5/release/uiza.min.js"></script>

...or...

<script src="https://sdk.uiza.io/v5/release/uiza.polyfilled.js"></script>

CSS

Include the uiza.css stylsheet into your <head>.

<link rel="stylesheet" href="https://sdk.uiza.io/v5/release/uiza.css" />

Example

example.html

<!DOCTYPE html>
<html lang='en' dir='ltr'>

<head>
  <meta charset='utf-8'>
  <title></title>
  <meta name='viewport' content='width=device-width,initial-scale=1'>

  <link href='https://sdk.uiza.io/v5/release/uiza.css' rel='stylesheet'>
  <script src='https://sdk.uiza.io/v5/release/uiza.min.js'></script>

</head>

<body>
  <video id='playerUz' data-uiza-provider=hlsjs crossorigin playsinline autoplay></video>

  <script>
    var videoStreamURL = 'https://1955897154.rsc.cdn77.org/live/116881ad-3463-4209-b16f-50e0e48add10/master.m3u8?cm=eyJlbnRpdHlfaWQiOiI2ZWUyMzk5NS1mNGFhLTQ1ZDMtOTM5NS0xN2NlNjBlZWJjNDAiLCJlbnRpdHlfc291cmNlIjoibGl2ZSIsImFwcF9pZCI6IjkyYThkMjAzMmZlODQ5MmFhNzc4MDRiNGMyYzUxOWM1In0=';

    ((options) => {
      window.UZplayer = new Uiza(document.getElementById('playerUz'), options);
    })({ src: videoStreamURL });
  </script>

</body>

</html>

Advanced

Customizing HLS buffer

buffer: {
  maxBufferLength: 15
  maxMaxBufferLength: 90
}

maxBufferLength (default: 10 seconds, maximum 30 seconds)

Maximum buffer length in seconds. If buffer length is/become less than this value, a new fragment will be loaded. This is the guaranteed buffer length hls.js will try to reach, regardless of maxBufferSize.

maxMaxBufferLength: (default 60 seconds, maximum 120 seconds) Maximum buffer length in seconds. Hls.js will never exceed this value, even if maxBufferSize is not reached yet.

hls.js tries to buffer up to a maximum number of bytes (6 MB by default) rather than to buffer up to a maximum nb of seconds. this is to mimic the browser behaviour (the buffer eviction algorithm is starting after the browser detects that video buffer size reaches a limit in bytes)

Example for maxBufferLengthand maxMaxBufferLength. Demo here

<!DOCTYPE html>
<html lang='en' dir='ltr'>

<head>
  <meta charset='utf-8'>
  <title></title>
  <meta name='viewport' content='width=device-width,initial-scale=1'>

  <link href='https://sdk.uiza.io/v5/release/uiza.css' rel='stylesheet'>
  <script src='https://sdk.uiza.io/v5/release/uiza.min.js'></script>

</head>

<body>
  <video id='playerUz' data-uiza-provider=hlsjs crossorigin playsinline autoplay></video>

  <script>
    var videoStreamURL = 'https://1955897154.rsc.cdn77.org/live/116881ad-3463-4209-b16f-50e0e48add10/master.m3u8?cm=eyJlbnRpdHlfaWQiOiI2ZWUyMzk5NS1mNGFhLTQ1ZDMtOTM5NS0xN2NlNjBlZWJjNDAiLCJlbnRpdHlfc291cmNlIjoibGl2ZSIsImFwcF9pZCI6IjkyYThkMjAzMmZlODQ5MmFhNzc4MDRiNGMyYzUxOWM1In0=';

    ((options) => {
      window.UZplayer = new Uiza(document.getElementById('playerUz'), options);
    })({
      buffer: {
        maxBufferLength: 10,
        maxMaxBufferLength: 60
      },
      src: videoStreamURL
    });
  </script>

</body>

</html>

Customizing the UI button

ui: {
    restart: true,
    rewind: true,
    play: true,
    mute: true,
    volume: true,
    currentTime: true,
    fastForward: true,
    progress: true,
    captions: true,
    settings: true,
    pip: true,
    live: true,
    fullscreen: true,
    speed: true
}

Example for hide button pip and settings, only override configure to false. Demo here

<!DOCTYPE html>
<html lang='en' dir='ltr'>

<head>
  <meta charset='utf-8'>
  <title></title>
  <meta name='viewport' content='width=device-width,initial-scale=1'>

  <link href='https://sdk.uiza.io/v5/release/uiza.css' rel='stylesheet'>
  <script src='https://sdk.uiza.io/v5/release/uiza.min.js'></script>

</head>

<body>
  <video id='playerUz' data-uiza-provider=hlsjs crossorigin playsinline autoplay muted></video>

  <script>
    var videoStreamURL = 'https://1955897154.rsc.cdn77.org/live/116881ad-3463-4209-b16f-50e0e48add10/master.m3u8?cm=eyJlbnRpdHlfaWQiOiI2ZWUyMzk5NS1mNGFhLTQ1ZDMtOTM5NS0xN2NlNjBlZWJjNDAiLCJlbnRpdHlfc291cmNlIjoibGl2ZSIsImFwcF9pZCI6IjkyYThkMjAzMmZlODQ5MmFhNzc4MDRiNGMyYzUxOWM1In0=';

    ((options) => {
      window.UZplayer = new Uiza(document.getElementById('playerUz'), options);
    })({
      ui: {
        pip: false,
        settings: false
      }, 
      src: videoStreamURL
    });
  </script>

</body>

</html>

Customizing the CSS

If you want to change any design tokens used for the rendering of the player, you can do so using CSS Custom Properties.

Here's a list of the properties and what they are used for:

You can set them in your CSS for all players:

:root {
  --uiza-color-main: #1ac266;
}

...or for a specific class name:

.player {
  --uiza-color-main: #1ac266;
}

...or in your HTML:

<video class="player" style="--uiza-color-main: #1ac266;">
    ...
</vieo>

Cross Origin (CORS)

You'll notice the crossorigin attribute on the example <video> elements. This is because the TextTrack captions are loaded from another domain. If your TextTrack captions are also hosted on another domain, you will need to add this attribute and make sure your host has the correct headers setup. For more info on CORS checkout the MDN docs: https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS

Captions

WebVTT captions are supported. To add a caption track, check the HTML example above and look for the <track> element. Be sure to validate your caption files.

JavaScript

Initialising

You can specify a range of arguments for the constructor to use:

Note: If a NodeList, Array, or jQuery object are passed, the first element will be used for setup. To setup multiple players, see multiple players below.

Single player

Passing a CSS string selector that's compatible with querySelector:

const player = new Uiza('#playerUz');

Passing a HTMLElement:

const player = new Uiza(document.getElementById('playerUz'));

const player = new Uiza(document.querySelector('.js-player'));

The HTMLElement or string selector can be the target <video>, <audio>, or <div> wrapper for embeds.

Multiple players

You have two choices here. You can either use a simple array loop to map the constructor:

const players = Array.from(document.querySelectorAll('.js-player')).map(p => new Uiza(p));

...or use a static method where you can pass a CSS string selector, a NodeList, an Array of HTMLElement, or a JQuery object:

const players = Uiza.setup('.js-player');

Both options will also return an array of instances in the order of they were in the DOM for the string selector or the source NodeList or Array.

Options

The second argument for the constructor is the options object:

const player = new Uiza('#playerUz', {
  title: 'Example Title',
});

Options can be passed as an object to the constructor as above or as JSON in data-uiza-config attribute on each of your target elements:

<video src="/path/to/video.mp4" id="playerUz" controls data-uiza-config='{ "title": "Example Title" }'></video>

Note the single quotes encapsulating the JSON and double quotes on the object keys. Only string values need double quotes.

| Option | -------------------- | enabled | debug | controls | settings | i18n | loadSprite | iconUrl | iconPrefix | blankVideo | autoplay² | autopause¹ | seekTime | volume | muted | clickToPlay | disableContextMenu | hideControls | resetOnEnd | keyboard | tooltips | duration | displayDuration | invertTime | toggleInvert | listeners | captions | fullscreen | ratio | storage | speed | quality | loop | urls | previewThumbnails | Type | Default | Description | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Boolean | true | Completely disable Uiza. This would allow you to do a User Agent check or similar to programmatically enable or disable Uiza for a certain UA. Example below. | | Boolean | false | Display debugging information in the console | | Array, Function or Element | ['play-large', 'play', 'progress', 'current-time', 'mute', 'volume', 'captions', 'settings', 'pip', 'airplay', 'fullscreen'] | If a function is passed, it is assumed your method will return either an element or HTML string for the controls. Three arguments will be passed to your function; id (the unique id for the player), seektime (the seektime step in seconds), and title (the media title). See CONTROLS.md for more info on how the html needs to be structured. | | Array | ['captions', 'quality', 'speed', 'loop'] | If the default controls are used, you can specify which settings to show in the menu | | Object | See defaults.js | Used for internationalization (i18n) of the text within the UI. | | Boolean | true | Load the SVG sprite specified as the iconUrl option (if a URL). If false, it is assumed you are handling sprite loading yourself. | | String | null | Specify a URL or path to the SVG sprite. See the SVG section for more info. | | String | uiza | Specify the id prefix for the icons used in the default controls (e.g. "uiza-play" would be "uiza"). This is to prevent clashes if you're using your own SVG sprite but with the default controls. Most people can ignore this option. | | String | https://cdn.Uiza.io/static/blank.mp4 | Specify a URL or path to a blank video file used to properly cancel network requests. | | Boolean | false | Autoplay the media on load. If the autoplay attribute is present on a <video> or <audio> element, this will be automatically set to true. | | Boolean | true | Only allow one player playing at once. | | Number | 10 | The time, in seconds, to seek when a user hits fast forward or rewind. | | Number | 1 | A number, between 0 and 1, representing the initial volume of the player. | | Boolean | false | Whether to start playback muted. If the muted attribute is present on a <video> or <audio> element, this will be automatically set to true. | | Boolean | true | Click (or tap) of the video container will toggle play/pause. | | Boolean | true | Disable right click menu on video to help as very primitive obfuscation to prevent downloads of content. | | Boolean | true | Hide video controls automatically after 2s of no mouse or focus movement, on control element blur (tab out), on playback start or entering fullscreen. As soon as the mouse is moved, a control element is focused or playback is paused, the controls reappear instantly. | | Boolean | false | Reset the playback to the start once playback is complete. | | Object | { focused: true, global: false } | Enable keyboard shortcuts for focused players only or globally | | Object | { controls: false, seek: true } | controls: Display control labels as tooltips on :hover & :focus (by default, the labels are screen reader only). seek: Display a seek tooltip to indicate on click where the media would seek to. | | Number | null | Specify a custom duration for media. | | Boolean | true | Displays the duration of the media on the "metadataloaded" event (on startup) in the current time display. This will only work if the preload attribute is not set to none (or is not set at all) and you choose not to display the duration (see controls option). | | Boolean | true | Display the current time as a countdown rather than an incremental counter. | | Boolean | true | Allow users to click to toggle the above. | | Object | null | Allows binding of event listeners to the controls before the default handlers. See the defaults.js for available listeners. If your handler prevents default on the event (event.preventDefault()), the default handler will not fire. | | Object | { active: false, language: 'auto', update: false } | active: Toggles if captions should be active by default. language: Sets the default language to load (if available). 'auto' uses the browser language. update: Listen to changes to tracks and update menu. This is needed for some streaming libraries, but can result in unselectable language options). | | Object | { enabled: true, fallback: true, iosNative: false, container: null } | enabled: Toggles whether fullscreen should be enabled. fallback: Allow fallback to a full-window solution (true/false/'force'). iosNative: whether to use native iOS fullscreen when entering fullscreen (no custom controls). container: A selector for an ancestor of the player element, allows contextual content to remain visual in fullscreen mode. Non-ancestors are ignored. | | String | null | Force an aspect ratio for all videos. The format is 'w:h' - e.g. '16:9' or '4:3'. If this is not specified then the default for HTML5 and Vimeo is to use the native resolution of the video. As dimensions are not available from YouTube via SDK, 16:9 is forced as a sensible default. | | Object | { enabled: true, key: 'uiza' } | enabled: Allow use of local storage to store user settings. key: The key name to use. | | Object | { selected: 1, options: [0.5, 0.75, 1, 1.25, 1.5, 1.75, 2] } | selected: The default speed for playback. options: The speed options to display in the UI. YouTube and Vimeo will ignore any options outside of the 0.5-2 range, so options outside of this range will be hidden automatically. | | Object | { default: 576, options: [4320, 2880, 2160, 1440, 1080, 720, 576, 480, 360, 240] } | default is the default quality level (if it exists in your sources). options are the options to display. This is used to filter the available sources. | | Object | { active: false } | active: Whether to loop the current video. If the loop attribute is present on a <video> or <audio> element, this will be automatically set to true This is an object to support future functionality. | | Object | See source. | If you wish to override any API URLs then you can do so here. You can also set a custom download URL for the download button. | | Object | { enabled: false, src: '' } | enabled: Whether to enable the preview thumbnails (they must be generated by you). src must be either a string or an array of strings representing URLs for the VTT files containing the image URL(s). Learn more about preview thumbnails below. |

API

There are methods, setters and getters on a Uiza object.

Object

The easiest way to access the Uiza object is to set the return value from your call to the constructor to a variable. For example:

const player = new Uiza('#player', {
  /* options */
});

You can also access the object through any events:

element.addEventListener('ready', event => {
  const player = event.detail.uiza;
});

Methods

Example method use:

player.play(); // Start playback
player.fullscreen.enter(); // Enter fullscreen

| Method | Parameters | Description | | -------------------------- | ---------------- | ---------------------------------------------------------------------------------------------------------- | | play()¹ | - | Start playback. | | pause() | - | Pause playback. | | togglePlay(toggle)¹ | Boolean | Toggle playback, if no parameters are passed, it will toggle based on current status. | | stop() | - | Stop playback and reset to start. | | restart() | - | Restart playback. | | rewind(seekTime) | Number | Rewind playback by the specified seek time. If no parameter is passed, the default seek time will be used. | | forward(seekTime) | Number | Fast forward by the specified seek time. If no parameter is passed, the default seek time will be used. | | increaseVolume(step) | Number | Increase volume by the specified step. If no parameter is passed, the default step will be used. | | decreaseVolume(step) | Number | Increase volume by the specified step. If no parameter is passed, the default step will be used. | | toggleCaptions(toggle) | Boolean | Toggle captions display. If no parameter is passed, it will toggle based on current status. | | fullscreen.enter() | - | Enter fullscreen. If fullscreen is not supported, a fallback "full window/viewport" is used instead. | | fullscreen.exit() | - | Exit fullscreen. | | fullscreen.toggle() | - | Toggle fullscreen. | | airplay() | - | Trigger the airplay dialog on supported devices. | | toggleControls(toggle) | Boolean | Toggle the controls (video only). Takes optional truthy value to force it on/off. | | on(event, function) | String, Function | Add an event listener for the specified event. | | once(event, function) | String, Function | Add an event listener for the specified event once. | | off(event, function) | String, Function | Remove an event listener for the specified event. | | supports(type) | String | Check support for a mime type. | | destroy() | - | Destroy the instance and garbage collect any elements. |

For HTML5 players, play() will return a Promise for most browsers - e.g. Chrome, Firefox, Opera, Safari and Edge according to MDN at time of writing.

Getters and Setters

Example setters:

player.volume = 0.5; // Sets volume at 50%
player.currentTime = 10; // Seeks to 10 seconds

Example getters:

player.volume; // 0.5;
player.currentTime; // 10
player.fullscreen.active; // false;

| Property | Getter | Setter | Description | | -------------------- | ------ | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | isHTML5 | ✓ | - | Returns a boolean indicating if the current player is HTML5. | | isEmbed | ✓ | - | Returns a boolean indicating if the current player is an embedded player. | | playing | ✓ | - | Returns a boolean indicating if the current player is playing. | | paused | ✓ | - | Returns a boolean indicating if the current player is paused. | | stopped | ✓ | - | Returns a boolean indicating if the current player is stopped. | | ended | ✓ | - | Returns a boolean indicating if the current player has finished playback. | | buffered | ✓ | - | Returns a float between 0 and 1 indicating how much of the media is buffered | | currentTime | ✓ | ✓ | Gets or sets the currentTime for the player. The setter accepts a float in seconds. | | seeking | ✓ | - | Returns a boolean indicating if the current player is seeking. | | duration | ✓ | - | Returns the duration for the current media. | | volume | ✓ | ✓ | Gets or sets the volume for the player. The setter accepts a float between 0 and 1. | | muted | ✓ | ✓ | Gets or sets the muted state of the player. The setter accepts a boolean. | | hasAudio | ✓ | - | Returns a boolean indicating if the current media has an audio track. | | speed | ✓ | ✓ | Gets or sets the speed for the player. The setter accepts a value in the options specified in your config. Generally the minimum should be 0.5. | | quality¹ | ✓ | ✓ | Gets or sets the quality for the player. The setter accepts a value from the options specified in your config. | | loop | ✓ | ✓ | Gets or sets the current loop state of the player. The setter accepts a boolean. | | source | ✓ | ✓ | Gets or sets the current source for the player. The setter accepts an object. See source setter below for examples. | | poster | ✓ | ✓ | Gets or sets the current poster image for the player. The setter accepts a string; the URL for the updated poster image. | | autoplay | ✓ | ✓ | Gets or sets the autoplay state of the player. The setter accepts a boolean. | | currentTrack | ✓ | ✓ | Gets or sets the caption track by index. -1 means the track is missing or captions is not active | | language | ✓ | ✓ | Gets or sets the preferred captions language for the player. The setter accepts an ISO two-letter language code. Support for the languages is dependent on the captions you include. If your captions don't have any language data, or if you have multiple tracks with the same language, you may want to use currentTrack instead. | | fullscreen.active | ✓ | - | Returns a boolean indicating if the current player is in fullscreen mode. | | fullscreen.enabled | ✓ | - | Returns a boolean indicating if the current player has fullscreen enabled. | | pip¹ | ✓ | ✓ | Gets or sets the picture-in-picture state of the player. The setter accepts a boolean. This currently only supported on Safari 10+ (on MacOS Sierra+ and iOS 10+) and Chrome 70+. | | ratio | ✓ | ✓ | Gets or sets the video aspect ratio. The setter accepts a string in the same format as the ratio option. | | download | ✓ | ✓ | Gets or sets the URL for the download button. The setter accepts a string containing a valid absolute URL. |

HTML5 only

Note: src property for YouTube and Vimeo can either be the video ID or the whole URL.

| Property | Type | Description | | ------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | type | String | Either video or audio. | | title | String | Optional. Title of the new media. Used for the aria-label attribute on the play button, and outer container. YouTube and Vimeo are populated automatically. | | sources | Array | This is an array of sources. For HTML5 media, the properties of this object are mapped directly to HTML attributes so more can be added to the object if required. | | poster¹ | String | The URL for the poster image (HTML5 video only). | | tracks¹ | String | An array of track objects. Each element in the array is mapped directly to a track element and any keys mapped directly to HTML attributes so as in the example above, it will render as <track kind="captions" label="English" srclang="en" src="https://cdn.selz.com/uiza/1.0/example_captions_en.vtt" default> and similar for the French version. Booleans are converted to HTML5 value-less attributes. | | previewThumbnails¹ | Object | The same object like in the previewThumbnails constructor option. This means you can either change the thumbnails vtt via the src key or disable the thumbnails plugin for the next video by passing { enabled: false }. |

HTML5 only

Events

You can listen for events on the target element you setup Uiza on (see example under the table). Some events only apply to HTML5 audio and video. Using your reference to the instance, you can use the on() API method or addEventListener(). Access to the API can be obtained this way through the event.detail.uiza property. Here's an example:

player.on('ready', event => {
  const instance = event.detail.uiza;
});

Standard Media Events

| Event Type | Description | | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | progress | Sent periodically to inform interested parties of progress downloading the media. Information about the current amount of the media that has been downloaded is available in the media element's buffered attribute. | | playing | Sent when the media begins to play (either for the first time, after having been paused, or after ending and then restarting). | | play | Sent when playback of the media starts after having been paused; that is, when playback is resumed after a prior pause event. | | pause | Sent when playback is paused. | | timeupdate | The time indicated by the element's currentTime attribute has changed. | | volumechange | Sent when the audio volume changes (both when the volume is set and when the muted state is changed). | | seeking | Sent when a seek operation begins. | | seeked | Sent when a seek operation completes. | | ratechange | Sent when the playback speed changes. | | ended | Sent when playback completes. Note: This does not fire if autoplay is true. | | enterfullscreen | Sent when the player enters fullscreen mode (either the proper fullscreen or full-window fallback for older browsers). | | exitfullscreen | Sent when the player exits fullscreen mode. | | captionsenabled | Sent when captions are enabled. | | captionsdisabled | Sent when captions are disabled. | | languagechange | Sent when the caption language is changed. | | controlshidden | Sent when the controls are hidden. | | controlsshown | Sent when the controls are shown. | | ready | Triggered when the instance is ready for API calls. |

HTML5 only

| Event Type | Description | | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | loadstart | Sent when loading of the media begins. | | loadeddata | The first frame of the media has finished loading. | | loadedmetadata | The media's metadata has finished loading; all attributes now contain as much useful information as they're going to. | | qualitychange | The quality of playback has changed.