Skip to main content

Key concepts & glossary

A handful of terms come up on almost every page of these docs. This page explains the core ones first, then lists the rest as a glossary.

Organisation​

Everything you create belongs to an organisation: your company's account on Envision Streaming. Users, streams, tags, API keys and settings are all per organisation. Each organisation has a short organisation hash, which is the first part of every stream name.

Stream​

A stream is one live channel: one input from your encoder, delivered to any number of viewers. You create it once (in the Dashboard or with the REST API) and can go live on it as often as you like. Each stream has:

IdentifierLooks likeUsed for
Stream nameXXXXX-YYYYY (organisation hash, dash, stream part)Your encoder (as stream key) and the player
Stream IDA UUID, for example 1dec3bbc-758b-4879-a202-7ae877d511baThe REST API and the Dashboard URL

Stream names and IDs are case-sensitive.

Ingest name and playout name​

  • The ingest stream name (with the ingest URL) is what your encoder sends to, also called the stream key.
  • The playout stream name is what the player plays. In the REST API it is playout.h5live[0].rtmp.streamname.

They are often the same string, but not always, so always give the player the playout name.

Stream states​

StateMeaning
createdThe stream exists but has never been live.
liveThe stream is receiving video and playing right now.
endedThe stream was live and isn't anymore. You can go live on it again.
lockedThe stream has been stopped and locked; it accepts no ingest until it is unlocked.
deletedThe stream has been deleted.

Ingest and playback​

  • Ingest is the way in: your encoder sends the stream over RTMP, RTMPS or SRT.
  • Playback is the way out: the Envision Streaming player plays the stream in the browser over MOQ (Media over QUIC), with a WebSocket-based fallback.
  • Latency is the delay from camera to screen. Envision Streaming is built for ultra-low latency.

Keys and tokens​

CredentialWhat it doesWhere it belongs
API keyFull access to your organisation through the REST APIYour server, never a web page
Playback tokenA signed token that lets a player watch for a limited time when secure playback is onThe viewer's player

Glossary​

TermMeaning
Ingest channelOne stream live at the same time.
Keyframe interval (GOP)Time between full frames in your encoder; 2 seconds recommended.
MOQMedia over QUIC, the primary playback transport.
Secure playbackAccount setting that requires a playback token to watch.
TagA label on a stream for organising and filtering.
TrafficData delivered to viewers plus data ingested, counted per month.

Next steps​