mint.json

{
  "$schema": "https://mintlify.com/schema.json",
  "name": "Livepeer Docs",
  "logo": {
    "dark": "/logo/dark.svg",
    "light": "/logo/light.svg"
  },
  "redirects": [
    {
      "source": "/guides/developing/quickstart",
      "destination": "/developers/quick-start"
    },
    {
      "source": "/guides/overview",
      "destination": "/developers/guides/overview"
    },
    {
      "source": "/guides/developing/player",
      "destination": "/developers/guides/playback-an-asset"
    },
    {
      "source": "/guides/developing/create-a-livestream",
      "destination": "/developers/guides/create-livestream"
    },
    {
      "source": "/guides/developing/stream-via-obs",
      "destination": "/developers/guides/stream-via-obs"
    },
    {
      "source": "/developing/stream-via-browser",
      "destination": "/developers/guides/livestream-from-browser"
    },
    {
      "source": "/guides/developing/upload-a-video-asset",
      "destination": "/developers/guides/upload-video-asset"
    },
    {
      "source": "/guides/developing/mint-a-video-nft",
      "destination": "/developers/guides/mint-video-nft"
    },
    {
      "source": "/guides/developing/dstorage-playback",
      "destination": "/developers/guides/dstorage-playback"
    },
    {
      "source": "/guides/developing/access-control",
      "destination": "/developers/guides/access-control-webhooks"
    },
    {
      "source": "/guides/developing/access-control-vod",
      "destination": "/developers/guides/access-control-webhooks"
    },
    {
      "source": "/guides/developing/encrypted-vod",
      "destination": "/developers/guides/encrypted-asset"
    },
    {
      "source": "/guides/developing/listen-for-webhooks",
      "destination": "/developers/guides/setup-and-listen-to-webhooks"
    },
    {
      "source": "/guides/developing/multistream",
      "destination": "/developers/guides/multistream"
    },
    {
      "source": "/guides/developing/monitor-stream-health",
      "destination": "/developers/guides/monitor-stream-health"
    },
    {
      "source": "/guides/developing/viewer-engagement",
      "destination": "/developers/guides/get-engagement-analytics-via-api"
    },
    {
      "source": "/guides/developing/transcode-video-storj",
      "destination": "/developers/guides/transcode-video-storj"
    },
    {
      "source": "/guides/developing/transcode-video-w3s",
      "destination": "/developers/guides/transcode-video-w3s"
    },
    {
      "source": "/tutorials/developing/optimize-latency",
      "destination": "/developers/guides/optimize-latency-of-a-livestream"
    },

    {
      "source": "/tutorials/developing/analyze-engagement-timeplus",
      "destination": "/developers/guides/get-engagement-analytics-via-timeplus"
    },
    {
      "source": "/tutorials/developing/visualize-engagement-metrics-grafana",
      "destination": "/developers/guides/get-engagement-analytics-via-grafana"
    },
    {
      "source": "/tutorials/developing/token-gate-videos-using-guildxyz",
      "destination": "/developers/tutorials/token-gate-videos-with-lit"
    },
    {
      "source": "/tutorials/developing/token-gate-videos-using-lit",
      "destination": "/developers/tutorials/token-gate-videos-with-lit"
    },
    {
      "source": "/tutorials/developing/build-decentralized-video-app-with-fvm",
      "destination": "/developers/tutorials/decentralized-app-with-fvm"
    },
    {
      "source": "/tutorials/developing/upload-playback-videos-on-ipfs-4everland",
      "destination": "/developers/tutorials/upload-playback-videos-4everland"
    },
    {
      "source": "/tutorials/developing/upload-playback-videos-on-ipfs",
      "destination": "/developers/tutorials/upload-playback-videos-on-ipfs"
    },
    {
      "source": "/tutorials/developing/upload-playback-videos-on-arweave",
      "destination": "/developers/tutorials/upload-playback-videos-on-arweave"
    },
    {
      "source": "/reference/api",
      "destination": "/api-reference/overview/introduction"
    },
    {
      "source": "/reference/deployed-contract-addresses",
      "destination": "/references/contract-addresses"
    },
    {
      "source": "/reference/example-applications",
      "destination": "/references/example-applications"
    },
    {
      "source": "/reference/api-support-matrix",
      "destination": "/references/api-support-matrix"
    },
    {
      "source": "/reference/go-livepeer",
      "destination": "/references/go-livepeer/bandwidth-requirements"
    },
    {
      "source": "/reference/go-livepeer/cli-reference",
      "destination": "/references/go-livepeer/cli-reference"
    },
    {
      "source": "/reference/go-livepeer/gpu-support",
      "destination": "/references/go-livepeer/gpu-support"
    },
    {
      "source": "/reference/go-livepeer/hardware-requirements",
      "destination": "/references/go-livepeer/hardware-requirements"
    },
    {
      "source": "/reference/go-livepeer/bandwidth-requirements",
      "destination": "/references/go-livepeer/bandwidth-requirements"
    },
    {
      "source": "/reference/go-livepeer/prometheus-metrics",
      "destination": "/references/go-livepeer/prometheus-metrics"
    },
    {
      "source": "/guides/delegating/bridge-lpt-to-arbitrum",
      "destination": "/delegators/guides/bridge-lpt-to-arbitrum"
    },
    {
      "source": "/guides/delegating/migrate-stake-to-arbitrum",
      "destination": "/delegators/guides/migrate-stake-to-arbitrum"
    },
    {
      "source": "/delegators/reference/yield-calculation",
      "destination": "/delegators/guides/yield-calculation"
    },
    {
      "source": "/guides/orchestrating/get-started",
      "destination": "/orchestrators/guides/get-started"
    },
    {
      "source": "/guides/orchestrating/install-go-livepeer",
      "destination": "/orchestrators/guides/install-go-livepeer"
    },
    {
      "source": "/guides/orchestrating/connect-to-arbitrum",
      "destination": "/orchestrators/guides/connect-to-arbitrum"
    },
    {
      "source": "/guides/orchestrating/configure-reward-calling",
      "destination": "/orchestrators/guides/configure-reward-calling"
    },
    {
      "source": "/guides/orchestrating/set-session-limits",
      "destination": "/orchestrators/guides/set-session-limits"
    },
    {
      "source": "/guides/orchestrating/set-pricing",
      "destination": "/orchestrators/guides/set-pricing"
    },
    {
      "source": "/guides/orchestrating/benchmark-transcoding",
      "destination": "/orchestrators/guides/benchmark-transcoding"
    },
    {
      "source": "/guides/orchestrating/assess-capabilities",
      "destination": "/orchestrators/guides/assess-capabilities"
    },
    {
      "source": "/guides/orchestrating/monitor-metrics",
      "destination": "/orchestrators/guides/monitor-metrics"
    },
    {
      "source": "/guides/orchestrating/vote",
      "destination": "/orchestrators/guides/vote"
    },
    {
      "source": "/guides/orchestrating/dual-mine",
      "destination": "/orchestrators/guides/dual-mine"
    },
    {
      "source": "/guides/orchestrating/o-t-split",
      "destination": "/orchestrators/guides/o-t-split"
    },
    {
      "source": "/guides/orchestrating/migrate-to-arbitrum",
      "destination": "/orchestrators/guides/migrate-to-arbitrum"
    },
    {
      "source": "/guides/orchestrating/migrate-from-contract-wallet",
      "destination": "/orchestrators/guides/migrate-from-contract-wallet"
    },
    {
      "source": "/guides/orchestrating/broadcaster-introspection",
      "destination": "/orchestrators/guides/broadcaster-introspection"
    },
    {
      "source": "/guides/orchestrating/troubleshoot",
      "destination": "/orchestrators/guides/troubleshoot"
    },
    {
      "source": "/reference/livepeer-react",
      "destination": "/react/getting-started"
    },
    {
      "source": "/reference/livepeer-react/getting-started",
      "destination": "/react/getting-started"
    },
    {
      "source": "/reference/livepeer-react/client",
      "destination": "/react/getting-started"
    },
    {
      "source": "/reference/livepeer-react/LivepeerConfig",
      "destination": "/sdks/react/migration/3.x/LivepeerConfig"
    },
    {
      "source": "/reference/livepeer-react/Player",
      "destination": "/react/player/Root"
    },
    {
      "source": "/reference/livepeer-react/Broadcast",
      "destination": "/react/broadcast/Root"
    },
    {
      "source": "/reference/livepeer-react/providers/studio",
      "destination": "/sdks/react/migration/3.x/providers/studio"
    },
    {
      "source": "/reference/livepeer-react/asset/useAsset",
      "destination": "/sdks/react/migration/3.x/asset/useAsset"
    },
    {
      "source": "/reference/livepeer-react/asset/useCreateAsset",
      "destination": "/sdks/react/migration/3.x/asset/useCreateAsset"
    },
    {
      "source": "/reference/livepeer-react/asset/useAssetMetrics",
      "destination": "/sdks/react/migration/3.x/asset/useAssetMetrics"
    },
    {
      "source": "/reference/livepeer-react/asset/useUpdateAsset",
      "destination": "/sdks/react/migration/3.x/asset/useUpdateAsset"
    },
    {
      "source": "/reference/livepeer-react/stream/useStream",
      "destination": "/sdks/react/migration/3.x/stream/useStream"
    },
    {
      "source": "/reference/livepeer-react/stream/useStreamSession",
      "destination": "/sdks/react/migration/3.x/stream/useStreamSession"
    },
    {
      "source": "/reference/livepeer-react/stream/useStreamSessions",
      "destination": "/sdks/react/migration/3.x/stream/useStreamSessions"
    },
    {
      "source": "/reference/livepeer-react/stream/useCreateStream",
      "destination": "/sdks/react/migration/3.x/stream/useCreateStream"
    },
    {
      "source": "/reference/livepeer-react/stream/useUpdateStream",
      "destination": "/sdks/react/migration/3.x/stream/useUpdateStream"
    },
    {
      "source": "/reference/livepeer-react/playback/usePlaybackInfo",
      "destination": "/sdks/react/migration/3.x/playback/usePlaybackInfo"
    },
    {
      "source": "/reference/livepeer-react/constants/abis",
      "destination": "/sdks/react/migration/3.x/constants/abis"
    },
    {
      "source": "/reference/livepeer-react/constants/contract-addresses",
      "destination": "/sdks/react/migration/3.x/constants/contract-addresses"
    }
  ],
  "favicon": "/favicon.png",
  "colors": {
    "primary": "#2AB673",
    "light": "#55D799",
    "dark": "#117866"
  },
  "feedback": {
    "suggestEdit": true,
    "raiseIssue": true,
    "thumbsRating": true
  },
  "openapi": "https://raw.githubusercontent.com/livepeer/studio/master/packages/api/src/schema/api-schema.yaml",
  "api": {
    "baseUrl": "https://livepeer.studio/api"
  },
  "modeToggle": {
    "default": "dark"
  },
  "backgroundImage": "/images/background.png",
  "topbarLinks": [
    {
      "name": "Discord",
      "url": "https://discord.gg/livepeer"
    }
  ],
  "versions": ["Developers", "Delegators", "Orchestrators"],
  "topbarCtaButton": {
    "name": "Dashboard",
    "url": "https://livepeer.studio"
  },
  "topAnchor": {
    "name": "Documentation",
    "icon": "code"
  },
  "anchors": [
    {
      "name": "API Reference",
      "icon": "rectangle-terminal",
      "url": "api-reference"
    },
    {
      "name": "Livepeer Dev Kit (LDK)",
      "icon": "brackets-curly",
      "url": "sdks"
    },
    {
      "name": "Catalyst",
      "icon": "flask",
      "url": "catalyst"
    },
    {
      "name": "What's New",
      "icon": "rocket",
      "url": "https://livepeer.canny.io/changelog"
    },
    {
      "name": "Community",
      "icon": "discord",
      "url": "https://discord.gg/livepeer",
      "iconType": "brands"
    }
  ],
  "navigation": [
    {
      "group": "Getting Started",
      "pages": [
        "developers/introduction",
        "developers/quick-start",
        "developers/livepeer-studio-cli"
      ]
    },
    {
      "group": "Guides",
      "pages": [
        "developers/guides/overview",
        {
          "group": "Assets",
          "icon": "video",
          "pages": [
            "developers/guides/upload-video-asset",
            "developers/guides/playback-an-asset",
            "developers/guides/dstorage-playback",
            "developers/guides/listen-to-asset-events",
            "developers/guides/encrypted-asset",
            "developers/guides/mint-video-nft",
            "developers/guides/thumbnails-vod"
          ]
        },
        {
          "group": "Livestream",
          "icon": "camera",
          "pages": [
            "developers/guides/create-livestream",
            "developers/guides/playback-a-livestream",
            "developers/guides/stream-via-obs",
            "developers/guides/livestream-from-browser",
            "developers/guides/optimize-latency-of-a-livestream",
            "developers/guides/monitor-stream-health",
            "developers/guides/listen-to-stream-events",
            "developers/guides/multistream",
            "developers/guides/clip-a-livestream",
            "developers/guides/thumbnails-live"
          ]
        },
        {
          "group": "Access control",
          "icon": "lock",
          "pages": [
            "developers/guides/access-control-webhooks",
            "developers/guides/access-control-jwt"
          ]
        },
        {
          "group": "Webhooks",
          "icon": "bell",
          "pages": ["developers/guides/setup-and-listen-to-webhooks"]
        },
        {
          "group": "Transcode API",
          "icon": "photo-film",
          "pages": [
            "developers/guides/transcode-video-storj",
            "developers/guides/transcode-video-w3s"
          ]
        },
        {
          "group": "Viewership Metrics",
          "icon": "chart-bar",
          "pages": [
            "developers/guides/get-engagement-analytics-via-api",
            "developers/guides/get-engagement-analytics-via-grafana",
            "developers/guides/get-engagement-analytics-via-timeplus"
          ]
        },
        {
          "group": "Integrations",
          "icon": "puzzle-piece",
          "pages": [
            "developers/tutorials/decentralized-app-with-fvm",
            "developers/tutorials/token-gate-videos-with-lit",
            {
              "group": "Storage Provider Integration",
              "pages": [
                "developers/tutorials/upload-playback-videos-4everland",
                "developers/tutorials/upload-playback-videos-on-arweave",
                "developers/tutorials/upload-playback-videos-on-ipfs"
              ]
            }
          ]
        }
      ],
      "version": "Developers"
    },
    {
      "group": "Guides",
      "pages": [
        "delegators/guides/bridge-lpt-to-arbitrum",
        "delegators/guides/migrate-stake-to-arbitrum",
        "delegators/guides/yield-calculation"
      ],
      "version": "Delegators"
    },
    {
      "group": "Guides",
      "pages": [
        "orchestrators/guides/get-started",
        "orchestrators/guides/install-go-livepeer",
        "orchestrators/guides/connect-to-arbitrum",
        "orchestrators/guides/configure-reward-calling",
        "orchestrators/guides/set-session-limits",
        "orchestrators/guides/set-pricing",
        "orchestrators/guides/benchmark-transcoding",
        "orchestrators/guides/assess-capabilities",
        "orchestrators/guides/monitor-metrics",
        "orchestrators/guides/vote",
        "orchestrators/guides/dual-mine",
        "orchestrators/guides/o-t-split",
        "orchestrators/guides/migrate-to-arbitrum",
        "orchestrators/guides/migrate-from-contract-wallet",
        "orchestrators/guides/broadcaster-introspection",
        "orchestrators/guides/troubleshoot"
      ],
      "version": "Orchestrators"
    },
    {
      "group": "Catalyst",
      "pages": [
        "catalyst/introduction",
        "catalyst/running-catalyst",
        "catalyst/developing-with-catalyst"
      ]
    },
    {
      "group": "References",
      "pages": [
        "references/api-support-matrix",
        {
          "group": "Livepeer Node Software",
          "icon": "golang",
          "pages": [
            "references/go-livepeer/bandwidth-requirements",
            "references/go-livepeer/cli-reference",
            "references/go-livepeer/gpu-support",
            "references/go-livepeer/hardware-requirements",
            "references/go-livepeer/prometheus-metrics"
          ]
        },
        "references/contract-addresses",
        "references/example-applications",
        "references/awesome-livepeer",
        {
          "group": "FAQs",
          "icon": "book",
          "pages": [
            "references/knowledge-base/livestream",
            "references/knowledge-base/playback",
            "references/knowledge-base/vod"
          ]
        }
      ]
    },
    {
      "group": "Core Concepts",
      "icon": "notes",
      "pages": [
        {
          "group": "Livepeer Primitives",
          "pages": [
            "developers/core-concepts/core-api/asset",
            "developers/core-concepts/core-api/stream",
            "developers/core-concepts/core-api/multistream",
            "developers/core-concepts/core-api/access-control"
          ]
        },
        {
          "group": "Livepeer Studio Dashboard",
          "pages": [
            "developers/core-concepts/studio/webhooks",
            "developers/core-concepts/studio/stream-health",
            "developers/core-concepts/studio/in-browser-broadcast"
          ]
        },
        {
          "group": "Livepeer Player",
          "pages": ["developers/core-concepts/player/overview"]
        },
        {
          "group": "Livepeer Network",
          "pages": [
            "developers/core-concepts/livepeer-network/delegators",
            "developers/core-concepts/livepeer-network/orchestrators"
          ]
        }
      ]
    },
    {
      "group": "Overview",
      "pages": ["sdks/introduction"]
    },
    {
      "group": "Server-side SDKs",
      "pages": ["sdks/javascript", "sdks/ruby", "sdks/go", "sdks/python"]
    },
    {
      "group": "React UI Kit",
      "icon": "circle-play",
      "pages": [
        "sdks/react/getting-started",
        {
          "group": "Player",
          "icon": "circle-play",
          "pages": [
            "sdks/react/player/Root",
            "sdks/react/player/Container",
            "sdks/react/player/Video",
            "sdks/react/player/Error",
            "sdks/react/player/Loading",
            "sdks/react/player/Portal",
            "sdks/react/player/Poster",
            {
              "group": "Controls",
              "pages": [
                "sdks/react/player/Controls",
                "sdks/react/player/Clip",
                "sdks/react/player/Fullscreen",
                "sdks/react/player/Live",
                "sdks/react/player/PictureInPicture",
                "sdks/react/player/Play",
                "sdks/react/player/RateSelect",
                "sdks/react/player/Seek",
                "sdks/react/player/Time",
                "sdks/react/player/VideoQualitySelect",
                "sdks/react/player/Volume"
              ]
            },
            {
              "group": "Functions",
              "pages": [
                "sdks/react/player/get-src",
                "sdks/react/player/useMediaContext"
              ]
            }
          ]
        },
        {
          "group": "Broadcast",
          "icon": "signal-stream",
          "pages": [
            "sdks/react/broadcast/Root",
            "sdks/react/broadcast/Container",
            "sdks/react/broadcast/Video",
            "sdks/react/broadcast/Enabled",
            "sdks/react/broadcast/Error",
            "sdks/react/broadcast/Loading",
            "sdks/react/broadcast/Portal",
            {
              "group": "Controls",
              "pages": [
                "sdks/react/broadcast/Controls",
                "sdks/react/broadcast/Audio",
                "sdks/react/broadcast/Camera",
                "sdks/react/broadcast/Fullscreen",
                "sdks/react/broadcast/PictureInPicture",
                "sdks/react/broadcast/Screenshare",
                "sdks/react/broadcast/Source",
                "sdks/react/broadcast/Status"
              ]
            },
            {
              "group": "Functions",
              "pages": [
                "sdks/react/broadcast/get-ingest",
                "sdks/react/broadcast/useBroadcastContext"
              ]
            }
          ]
        },
        {
          "group": "Examples",
          "icon": "clipboard",
          "pages": ["sdks/react/Player", "sdks/react/Broadcast"]
        },
        {
          "group": "Migration",
          "icon": "right-left",
          "pages": [
            "sdks/react/migration/migration-4.x",
            {
              "group": "Livepeer React (3.x and below)",
              "pages": [
                "sdks/react/migration/3.x/getting-started",
                "sdks/react/migration/3.x/client",
                "sdks/react/migration/3.x/LivepeerConfig",
                "sdks/react/migration/3.x/Player",
                "sdks/react/migration/3.x/Broadcast",
                {
                  "group": "Asset",
                  "pages": [
                    "sdks/react/migration/3.x/asset/useCreateAsset",
                    "sdks/react/migration/3.x/asset/useAsset",
                    "sdks/react/migration/3.x/asset/useUpdateAsset",
                    "sdks/react/migration/3.x/asset/useAssetMetrics"
                  ]
                },
                {
                  "group": "Stream",
                  "pages": [
                    "sdks/react/migration/3.x/stream/useCreateStream",
                    "sdks/react/migration/3.x/stream/useStream",
                    "sdks/react/migration/3.x/stream/useUpdateStream",
                    "sdks/react/migration/3.x/stream/useStreamSession",
                    "sdks/react/migration/3.x/stream/useStreamSessions"
                  ]
                },
                {
                  "group": "Playback",
                  "pages": ["sdks/react/migration/3.x/playback/usePlaybackInfo"]
                },
                {
                  "group": "Constants",
                  "pages": [
                    "sdks/react/migration/3.x/constants/abis",
                    "sdks/react/migration/3.x/constants/contract-addresses"
                  ]
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "group": "Overview",
      "pages": [
        "api-reference/overview/introduction",
        "api-reference/overview/authentication"
      ]
    },
    {
      "group": "APIs",
      "pages": [
        {
          "group": "Asset",
          "icon": "video",
          "pages": [
            "api-reference/asset/overview",
            "api-reference/asset/upload",
            "api-reference/asset/upload-via-url",
            "api-reference/asset/get",
            "api-reference/asset/update",
            "api-reference/asset/delete",
            "api-reference/asset/get-all"
          ]
        },
        {
          "group": "Livestream",
          "icon": "camera",
          "pages": [
            "api-reference/stream/overview",
            "api-reference/stream/create",
            "api-reference/stream/get",
            "api-reference/stream/update",
            "api-reference/stream/terminate",
            "api-reference/stream/add-multistream-target",
            "api-reference/stream/delete-multistream-target",
            "api-reference/stream/delete",
            "api-reference/stream/get-all",
            "api-reference/stream/create-clip",
            "api-reference/stream/get-clip"
          ]
        },
        {
          "group": "Multistream target",
          "icon": "arrows-split-up-and-left",
          "pages": [
            "api-reference/multistream/overview",
            "api-reference/multistream/create",
            "api-reference/multistream/get",
            "api-reference/multistream/update",
            "api-reference/multistream/delete",
            "api-reference/multistream/get-all"
          ]
        },

        {
          "group": "Session",
          "icon": "film",
          "pages": [
            "api-reference/session/overview",
            "api-reference/session/get",
            "api-reference/session/get-all",
            "api-reference/session/get-recording",
            "api-reference/session/get-clip"
          ]
        },
        {
          "group": "Access control",
          "icon": "lock",
          "pages": [
            "api-reference/signing-key/overview",
            "api-reference/signing-key/create",
            "api-reference/signing-key/get",
            "api-reference/signing-key/update",
            "api-reference/signing-key/delete",
            "api-reference/signing-key/get-all"
          ]
        },
        {
          "group": "Webhook",
          "icon": "bell",
          "pages": [
            "api-reference/webhook/overview",
            "api-reference/webhook/create",
            "api-reference/webhook/get",
            "api-reference/webhook/update",
            "api-reference/webhook/delete",
            "api-reference/webhook/get-all"
          ]
        },

        {
          "group": "Task",
          "icon": "gear",
          "pages": [
            "api-reference/task/overview",
            "api-reference/task/get-all",
            "api-reference/task/get"
          ]
        },
        {
          "group": "Playback",
          "icon": "play",
          "pages": [
            "api-reference/playback/overview",
            "api-reference/playback/get"
          ]
        },
        {
          "group": "Transcode",
          "icon": "photo-film",
          "pages": [
            "api-reference/transcode/overview",
            "api-reference/transcode/create"
          ]
        },
        {
          "group": "Viewership",
          "icon": "chart-bar",
          "pages": [
            "api-reference/viewership/get-viewership-metrics",
            "api-reference/viewership/get-usage-metrics",
            "api-reference/viewership/get-public-total-views",
            "api-reference/viewership/get-creators-metrics"
          ]
        }
      ]
    }
  ],
  "footerSocials": {
    "website": "https://livepeer.org",
    "github": "https://github.com/livepeer",
    "twitter": "https://twitter.com/Livepeer",
    "discord": "https://discord.gg/livepeer"
  },
  "search": {
    "prompt": "Need help? Ask our AI"
  }
}