Skip to main content

index/interfaces/StreamCredentials.md

Stream credential fields shared by all credential-returning endpoints. Contains everything needed to configure OBS, Streamlabs, or any encoder.

Since​

8.5.0

Extended by​

Properties​

PropertyTypeDescription
playbackIdstringPlayback ID for HLS playback
rtmpsUrlstringFull RTMPS ingest URL: rtmps://global-live.mux.com:443/app/{streamKey}
srtPassphrasestringRaw SRT passphrase (for manual SRT configuration)
srtUrlstringFull SRT ingest URL: srt://global-live.mux.com:6001?streamid={streamKey}&passphrase={srtPassphrase}
statusstringStream status (IDLE, ACTIVE, DISABLED)
streamKeystringRaw stream key (for manual OBS/encoder configuration)