Livepeer 为开发者、创作者和基础设施运营商提供多种访问接口,以与协议和网络交互。这些接口包括 SDK、REST 和 gRPC API、CLI、GraphQL 端点,以及用于链上和链下应用的播放工具。本页按使用场景、目标用户和示例集成路径对每个接口进行拆解。
接口类别
| Interface | Use case | Users | Access |
|---|
REST API(Livepeer Studio)
可用地址:https://livepeer.studio/api
常用端点:
POST /stream — 创建视频流摄取会话
POST /transcode — 按需文件转码
POST /ai/infer — 提交 AI 任务(例如图像增强)
GET /session/:id — 获取会话状态
文档: livepeer.studio/docs
gRPC API(网关节点)
gRPC 支持高吞吐、低延迟的 Orchestrator 路由。
方法(示例): ReserveSession, Heartbeat, ReportJobComplete, OrchestratorList
使用方:Studio Gateway、Daydream Gateway、Cascade。
Proto: gateway.proto
GraphQL Explorer API
访问详细的 Livepeer 链上和网络状态。
端点: https://explorer.livepeer.org/graphql
示例查询:
query GetOrchestrators {
orchestrators {
id
totalStake
rewardCut
serviceURI
}
}
还支持:委托人奖励、通胀率、总活跃质押、轮次信息。使用方 Explorer.
JS SDK
GitHub: @livepeer/sdk
安装:
npm install @livepeer/sdk
特性: 摄取(创建流、推送视频)、AI 任务提交、查看会话输出、钱包支持(ETH、信用)、播放和统计。
示例:
const { createStream } = require('@livepeer/sdk');
const stream = await createStream({ name: 'My Stream' });
使用于:Livepeer Studio、Daydream、VJ 应用(例如 MetaDJ)。
CLI
通过 Go 构建或 Docker 安装:
go install github.com/livepeer/go-livepeer
命令(示例): stake, unbond, withdraw, reward, claim, transcode, broadcast, query
适用于 Orchestrator 测试和协议分析。
智能合约接口
通过 RPC 和 ABI 直接与协议(Arbitrum)交互。
| Contract | Function (examples) | Address source |
|---|
Current Arbitrum contract addresses and ABIs are listed in Blockchain contracts. Use ethers.js, viem, hardhat, or JSON-RPC to call contracts.
工作流示例
从网页应用转码:
await sdk.createStream({ profile: '720p', name: 'MyCam' });
运行 AI 图像到图像(curl):
curl -X POST https://livepeer.studio/api/ai/infer \
-d '{ "model": "sdxl", "input": "image.png" }'
检查节点指标:
参考文献
Last modified on March 1, 2026