Dashboard
Discord
Dashboard

Livestream

Update a livestream

Documentation
API Reference
SDKs
AI Video (Alpha)
What's New
Community

Overview

Introduction

Authentication

APIs

Asset

Livestream

Overview
POST
Create a livestream
GET
Retrieve a livestream
PATCH
Update a livestream
DEL
Terminates a livestream
POST
Add a multistream target
DEL
Remove a multistream target
DEL
Delete a livestream
GET
Retrieve all livestreams
POST
Create a clip
GET
Retrieve clips of a livestream

Multistream target

Session

Access control

Webhook

Task

Playback

Transcode

Viewership

Livestream

Update a livestream

PATCH

stream

{id}

Authorization

string

Bearer

Authorization

Required

string

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

string

Required

string

ID of the stream

object

creatorId

object

creatorId

object

type

enum<string>

type

Required

enum<string>

value

string

value

Required

string

record

boolean

record

boolean

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

Add Example Value

suspended

boolean

suspended

boolean

If currently suspended

multistream

object

multistream

object

targets

array

targets

array

References to targets where this stream will be simultaneously streamed to

Add Example Value

playbackPolicy

object

playbackPolicy

object

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

type

enum<string>

type

Required

enum<string>

Add Example Value

webhookId

string

webhookId

string

ID of the webhook to use for playback policy

Add Example Value

webhookContext

object

webhookContext

object

User-defined webhook context

Add Example Value

refreshInterval

number

refreshInterval

number

Interval (in seconds) at which the playback policy should be refreshed (default 600 seconds)

Add Example Value

allowedOrigins

array

allowedOrigins

array

List of allowed origins for CORS playback (<scheme>://<hostname>:<port>, <scheme>://<hostname>)

profiles

array

profiles

array

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.

recordingSpec

object

recordingSpec

object

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

profiles

array

profiles

array

Profiles to process the recording of this stream into. If not specified, default profiles will be derived based on the stream input. Keep in mind that the source rendition is always kept.

userTags

object

userTags

object

User input tags associated with the stream

Authorizations

Authorization

string

headerrequired

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

Path Parameters

string

required

ID of the stream

Body

application/json

creatorId

creatorId.type

enum<string>

required

Available options:

unverified

creatorId.value

string

required

record

boolean

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

suspended

boolean

If currently suspended

multistream

object

multistream.targets

object[]

References to targets where this stream will be simultaneously streamed to

multistream.targets.profile

string

required

Name of transcoding profile that should be sent. Use "source" for pushing source stream data

multistream.targets.videoOnly

boolean

default: false

If true, the stream audio will be muted and only silent video will be pushed to the target.

multistream.targets.id

string

ID of multistream target object where to push this stream

multistream.targets.spec

object

Inline multistream target object. Will automatically create the target resource to be used by the created stream.

multistream.targets.spec.name

string

multistream.targets.spec.url

string

required

Livepeer-compatible multistream target URL (RTMP(S) or SRT)

playbackPolicy

object | null

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

playbackPolicy.type

enum<string>

required

Available options:

public,

jwt,

webhook

playbackPolicy.webhookId

string

ID of the webhook to use for playback policy

playbackPolicy.webhookContext

object

User-defined webhook context

playbackPolicy.refreshInterval

number

Interval (in seconds) at which the playback policy should be refreshed (default 600 seconds)

playbackPolicy.allowedOrigins

string[]

List of allowed origins for CORS playback (<scheme>://<hostname>:<port>, <scheme>://<hostname>)

profiles

object[] | null

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.

profiles.width

integer

required

profiles.name

string

required

profiles.height

integer

required

profiles.bitrate

integer

required

profiles.fps

integer

required

profiles.fpsDen

integer

profiles.quality

integer

Restricts the size of the output video using the constant quality feature. Increasing this value will result in a lower quality video. Note that this parameter might not work if the transcoder lacks support for it.

profiles.gop

string

profiles.profile

enum<string>

Available options:

H264Baseline,

H264Main,

H264High,

H264ConstrainedHigh

profiles.encoder

enum<string>

Available options:

H.264

recordingSpec

object

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

recordingSpec.profiles

object[] | null

Profiles to process the recording of this stream into. If not specified, default profiles will be derived based on the stream input. Keep in mind that the source rendition is always kept.

recordingSpec.profiles.width

integer

recordingSpec.profiles.name

string

recordingSpec.profiles.height

integer

recordingSpec.profiles.bitrate

integer

required

recordingSpec.profiles.quality

integer

recordingSpec.profiles.fps

integer

recordingSpec.profiles.fpsDen

integer

recordingSpec.profiles.gop

string

recordingSpec.profiles.profile

enum<string>

Available options:

H264Baseline,

H264Main,

H264High,

H264ConstrainedHigh

recordingSpec.profiles.encoder

enum<string>

Available options:

H.264,

HEVC,

VP8,

VP9

userTags

object

User input tags associated with the stream

Was this page helpful?

Retrieve a livestream Terminates a livestream

website github twitter discord website