Skip to content
Welcome to the new, unified Livepeer documentation! 👋

Add a Player

We demonstrate below how to playback live or on demand videos in your application using either Livepeer.js or Video.js.

Using the Livepeer.js Player

The example below show to use the Livepeer.js Player to view a video asset, with some custom styles to demonstrate what's possible.

Step 1: Configuring Providers

First, we create a new livepeer.js client with a gateway provider and a CORS-protected API key, as well as a theme to use for all livepeer.js React components.

import {
} from '@livepeer/react';
import * as React from 'react';
const livepeerClient = createReactClient({
  provider: studioProvider({
    apiKey: process.env.NEXT_PUBLIC_STUDIO_API_KEY,
const theme: ThemeConfig = {
  colors: {
    accent: 'rgb(0, 145, 255)',
    containerBorderColor: 'rgba(0, 145, 255, 0.9)',
  fonts: {
    display: 'Inter',
function App() {
  return (
    <LivepeerConfig client={livepeerClient} theme={theme}>
      <CreateAndViewAsset />

Step 2: Play Video

Now that our providers are set up, we use the Player with an IPFS CID as our playbackId, which we created previously when uploading a video asset and storing to IPFS. We use Next.js Image (opens in a new tab) as our optimized poster image, but this could also be a simple image URL.

We also override some of the custom styling to match the flow of our app!

import { Player } from '@livepeer/react';
import Image from 'next/image';
const playbackId =
import blenderPoster from '../../public/images/blender-poster.png';
const PosterImage = () => {
  return (
export const DemoPlayer = () => {
  return (
      poster={<PosterImage />}
        autohide: 3000,
        borderStyles: { containerBorderStyle: 'hidden' },
        radii: { containerBorderRadius: '10px' },

Using your own player

Using livepeer.js is the recommended way to play back a video or a live stream - it handles errors from the API correctly and is a true web3-native media player. However, if you want to use an alternative, you can do so by following the instructions below.


Please note that to play back live streams inside your application you'll need to use a video player component that supports HLS.


To ensure consistent viewer experience, we strongly recommend using a player (like the Livepeer Player) that gracefully recovers from routine RTMP reconnects through custom polling logic. In the absence of this capability, reconnects may degrade viewer experience and require a hard refresh to resolve.

Fetch the playback URL

To playback a live stream in other players, you'll need to fetch the HLS URL. HLS is a protocol that allows you to stream video and audio content over HTTP. Most of the video you watch on the web is delivered using HLS. Livepeer also uses HLS to deliver video and audio content.


The playback URL format is subject to change. Do not try to create the playback URLs manually, as they may change periodically.

You can get the playback url by using the below format and replacing the PLAYBACK_ID with your stream or asset's playbackId.{PLAYBACK_ID}

The API will return a JSON payload which looks like:

  "type": "vod",
  "meta": {
    "source": [
        "hrn": "HLS (TS)",
        "type": "html5/application/",
        "url": "{RECORDING_ID}/index.m3u8"

The format of this payload is defined here (opens in a new tab). The url field can be used as the playback URL.

Use the playback URL in a player

You can use the playback URL with any video player that supports HLS. Here is a list of popular players that support HLS:

Here is an example of how to use the playback URL in video.js player.

  <link href="" rel="stylesheet" />
  <!-- If you'd like to support IE8 (for Video.js versions prior to v7) -->
  <!-- <script src=""></script> -->
  <script src=""></script>

Embeddable Player


The embeddable player is currently in beta and some elements may change as we mature the product. For a production-grade application consider using Livepeer.js instead.

This is one of the easiest way to playback a video on your website/applications. You can embed the player on your website/applications by using the below code snippet.

You can replace the PLAYBACK_ID with your video's playback id.

  allow="autoplay; encrypted-media; picture-in-picture"