TSDuck v3.38-3738
MPEG Transport Stream Toolkit
Loading...
Searching...
No Matches
ts::hls::AltPlayList Class Reference

Description of an alternative rendition media playlist inside an HLS master playlist. More...

#include <tshlsAltPlayList.h>

Inheritance diagram for ts::hls::AltPlayList:
Collaboration diagram for ts::hls::AltPlayList:

Public Member Functions

 AltPlayList ()=default
 Constructor.
 
virtual UString toString () const override
 Convert to a string object.
 
UString urlString () const
 Get the URL string to use.
 

Public Attributes

UString assocLanguage {}
 Associated language. Optional.
 
bool autoselect = false
 The client may choose to play this Rendition in the absence of explicit user preference.
 
UString channels {}
 Ordered, slash-separated ("/") list of channel parameters.
 
UString characteristics {}
 Media Characteristic Tags (MCTs) separated by comma (,) characters.
 
UString filePath {}
 Full file path.
 
bool forced = false
 The Rendition contains content that is considered essential to play.
 
UString groupId {}
 Group to which the Rendition belongs. Required.
 
UString inStreamId {}
 Rendition within the segments in the Media Playlist.
 
bool isDefault = false
 The client should play this Rendition in the absence of information from the user indicating a different choice.
 
UString language {}
 Primary language used in the Rendition. Optional.
 
UString name {}
 Human-readable description of the Rendition. Required.
 
UString relativeURI {}
 Relative URI, verbatime from playlist.
 
UString stableRenditionId {}
 Stable identifier for the URI within the Multivariant Playlist. Optional.
 
UString type {}
 Playlist type, required, one of "AUDIO", "VIDEO", "SUBTITLES", "CLOSED-CAPTIONS".
 
URL url {}
 Full URL, invalid if accessed by file path only.
 

Detailed Description

Description of an alternative rendition media playlist inside an HLS master playlist.

Alternative rendition media playlists are introduced by the tag #EXT-X-MEDIA while regular media playlists (class MediaPlayList) are introduced by the tag #EXT-X-STREAM-INF.

Member Function Documentation

◆ toString()

virtual UString ts::hls::AltPlayList::toString ( ) const
overridevirtual

Convert to a string object.

Returns
This object, converted as a string.

Reimplemented from ts::hls::MediaElement.

◆ urlString()

UString ts::hls::MediaElement::urlString ( ) const
inherited

Get the URL string to use.

Returns
The URL string to use.

The documentation for this class was generated from the following file: