Open j0sh opened 5 years ago
I'm on board for this. If we want to do this, we should also consider how to name our current streamID
(which is basically a MediaPlaylist ID inside a MasterPlaylist).
Should we call it MediaPlaylistID
? or just PlaylistID
?
Need to review this a little more closely, but we're using the StreamID structure in progressively fewer places, and the places where we do use it may be fine without it. I've been wondering if we can eventually remove it entirely.
Is your feature request related to a problem? Please describe. The "Manifest ID" has been a Livepeer-specific concept that has seen quite a bit of evolution. In its current form, the manifest ID can be simply seen as a "stream name".
Referring to the "stream name" throughout the codebase and in our documentation may be more intuitive for users [1] who are unfamiliar with the concept of HLS manifests. This makes it easier to for them to get acclimated to the Livepeer technical environment.
[1] Even seasoned video developers don't necessarily immediately make the connection between "manifestID" and "HLS manifest" or "HLS playlist". Even then, it's a bit ambiguous when considering master playlists vs media playlists, etc.
Describe the solution you'd like
Start by updating the documentation, program output and any user-facing features (eg, CLI API) to refer to the "stream name" rather than the "manifest ID".
We don't have to do a wholesale replacement of the term within the user-invisible codebase immediately (such as variable names); the renaming can be done gradually as we work on various areas.
Describe alternatives you've considered
We can call it a "stream ID". However, I prefer the "stream name" terminology for a few reasons (all of them entirely subjective):
We can also maintain the "manifest ID" terminology. But then a couple levels of exposition probably have to follow. In my head, the conversation goes like this:
Q: "What's a ManifestID?" A: It's a stream identifier
Q: "What format is the identifier in?" A: Anything you want!
Q: "So it's like a stream name?" A: Exactly!