跳转到主要内容
GET
/
stream
TypeScript
import { Livepeer } from "livepeer";

const livepeer = new Livepeer({
  apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await livepeer.stream.getAll();

  // Handle the result
  console.log(result);
}

run();
[
  {
    "name": "test_stream",
    "id": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
    "kind": "stream",
    "creatorId": {
      "type": "unverified",
      "value": "user123"
    },
    "userTags": {},
    "lastSeen": 1587667174725,
    "sourceSegments": 1,
    "transcodedSegments": 2,
    "sourceSegmentsDuration": 1,
    "transcodedSegmentsDuration": 2,
    "sourceBytes": 1,
    "transcodedBytes": 2,
    "ingestRate": 1,
    "outgoingRate": 2,
    "isActive": true,
    "isHealthy": "<unknown>",
    "issues": "<unknown>",
    "createdByTokenName": "abc-123-xyz-456",
    "createdAt": 1587667174725,
    "parentId": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
    "streamKey": "hgebdhhigq",
    "pull": {
      "source": "https://myservice.com/live/stream.flv",
      "headers": {
        "Authorization": "Bearer 123"
      },
      "isMobile": 0,
      "location": {
        "lat": 39.739,
        "lon": -104.988
      }
    },
    "playbackId": "eaw4nk06ts2d0mzb",
    "playbackPolicy": {
      "type": "webhook",
      "webhookId": "1bde4o2i6xycudoy",
      "webhookContext": {
        "streamerId": "my-custom-id"
      },
      "refreshInterval": 600,
      "allowedOrigins": [
        "<string>"
      ]
    },
    "profiles": [
      {
        "name": "240p0",
        "fps": 0,
        "bitrate": 250000,
        "width": 426,
        "height": 240
      },
      {
        "name": "360p0",
        "fps": 0,
        "bitrate": 800000,
        "width": 640,
        "height": 360
      },
      {
        "name": "480p0",
        "fps": 0,
        "bitrate": 1600000,
        "width": 854,
        "height": 480
      },
      {
        "name": "720p0",
        "fps": 0,
        "bitrate": 3000000,
        "width": 1280,
        "height": 720
      }
    ],
    "projectId": "aac12556-4d65-4d34-9fb6-d1f0985eb0a9",
    "record": false,
    "recordingSpec": {
      "profiles": [
        {
          "bitrate": 3000000,
          "width": 1280,
          "name": "720p",
          "height": 720,
          "quality": 23,
          "fps": 30,
          "fpsDen": 1,
          "gop": 2,
          "profile": "H264Baseline",
          "encoder": "H.264"
        }
      ]
    },
    "multistream": {
      "targets": [
        {
          "id": "PUSH123",
          "profile": "720p"
        }
      ]
    },
    "suspended": true,
    "lastTerminatedAt": 1713281212993,
    "userId": "we7818e7-610a-4057-8f6f-b785dc1e6f88",
    "renditions": {}
  }
]

​
获取所有流

授权

​
Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

查询参数

​
streamsonly
string

响应

Success

​
name
string
必填
示例:

"test_stream"

​
id
string
示例:

"de7818e7-610a-4057-8f6f-b785dc1e6f88"

​
kind
string
已弃用
示例:

"stream"

​
creatorId
object
​
userTags
object

User input tags associated with the stream

​
lastSeen
number
示例:

1587667174725

​
sourceSegments
number
示例:

1

​
transcodedSegments
number
示例:

2

​
sourceSegmentsDuration
number

Duration of all the source segments, sec

示例:

1

​
transcodedSegmentsDuration
number

Duration of all the transcoded segments, sec

示例:

2

​
sourceBytes
number
示例:

1

​
transcodedBytes
number
示例:

2

​
ingestRate
number

Rate at which sourceBytes increases (bytes/second)

示例:

1

​
outgoingRate
number

Rate at which transcodedBytes increases (bytes/second)

示例:

2

​
isActive
boolean

If currently active

示例:

true

​
isHealthy
any
​
issues
any
​
createdByTokenName
string

Name of the token used to create this object

示例:

"abc-123-xyz-456"

​
createdAt
number

Timestamp (in milliseconds) at which stream object was created

示例:

1587667174725

​
parentId
string

Points to parent stream object

示例:

"de7818e7-610a-4057-8f6f-b785dc1e6f88"

​
streamKey
string

Used to form RTMP ingest URL

示例:

"hgebdhhigq"

​
pull
object

Configuration for a stream that should be actively pulled from an external source, rather than pushed to Livepeer. If specified, the stream will not have a streamKey.

​
playbackId
string

The playback ID to use with the Playback Info endpoint to retrieve playback URLs.

示例:

"eaw4nk06ts2d0mzb"

​
playbackPolicy
object

Whether the playback policy for an asset or stream is public or signed

​
profiles
object[]

Profiles to transcode the stream into. If not specified, a default set of profiles will be used with 240p, 360p, 480p and 720p resolutions. Keep in mind that the source rendition is always kept.

​
projectId
string

The ID of the project

示例:

"aac12556-4d65-4d34-9fb6-d1f0985eb0a9"

​
record
boolean

Should this stream be recorded? Uses default settings. For more customization, create and configure an object store.

示例:

false

​
recordingSpec
object

Configuration for recording the stream. This can only be set if record is true.

​
multistream
object
​
suspended
boolean

If currently suspended

​
lastTerminatedAt
number | null

Timestamp (in milliseconds) when the stream was last terminated

示例:

1713281212993

​
userId
string
已弃用
示例:

"we7818e7-610a-4057-8f6f-b785dc1e6f88"

​
renditions
object
Last modified on March 3, 2026