Class M3uParser

M3u parser class to parse m3u playlist string to playlist object

Hierarchy

M3uParser

Index

Constructors

Methods

getAttributes getPlaylist isDirective isValidM3u parse processCustomData processDirective processExtM3uAttributes processMedia

Constructors

constructor

new M3uParser(): M3uParser
Returns M3uParser

Methods

`Static` `Private` getAttributes

getAttributes(attributesString: string): M3uAttributes
Private
Get m3u attributes object from attributes string

Returns
attributes object e.g. {"tvg-id": "", "group-title": ""}
Parameters
- attributesString: string
  
  e.g. 'tvg-id="" group-title=""'
Returns M3uAttributes
- Defined in m3u-parser.ts:46

`Static` `Private` getPlaylist

getPlaylist(lines: string[], customDataMapping?: M3uCustomDataMapping): M3uPlaylist
Private
Get playlist returns m3u playlist object parsed from m3u string lines

Returns
parsed m3u playlist object
Parameters
- lines: string[]
  
  m3u string lines
- customDataMapping: M3uCustomDataMapping = {}
  
  whole custom directive data mapping configuration
Returns M3uPlaylist
- Defined in m3u-parser.ts:196

`Static` `Private` isDirective

isDirective(item: string): boolean
Private
Is directive method detect if line contains m3u directive

Returns
true if it is line with directive, otherwise false
Parameters
- item: string
  
  string line of playlist
Returns boolean
- Defined in m3u-parser.ts:220

`Static` `Private` isValidM3u

isValidM3u(firstLine: string[]): boolean
Private
Is valid m3u method detect if first line of playlist contains #EXTM3U directive

Returns
true if line starts with #EXTM3U, false otherwise
Parameters
- firstLine: string[]
  
  first line of m3u playlist string
Returns boolean
- Defined in m3u-parser.ts:230

`Static` parse

parse(m3uString: string, config?: M3uParserConfig): M3uPlaylist
Parse is static method to parse m3u playlist string into m3u playlist object. Playlist need to contain #EXTM3U directive on first line. All lines are trimmed and blank ones are removed.

Returns
parsed m3u playlist object

Example
```
const playlist = M3uParser.parse(m3uString);
playlist.medias.forEach(media => media.location);
```
Parameters
- m3uString: string
  
  whole m3u playlist string
- Optional config: M3uParserConfig
  
  additional parsing configuration
Returns M3uPlaylist
- Defined in m3u-parser.ts:247

`Static` `Private` processCustomData

processCustomData(playlist: M3uPlaylist, media: M3uMedia, trackInformation: string, directive: string, customDataMapping: M3uCustomDataMapping): void
Private
Process custom unknown directive and add it into playlist or media object, based on mapping configuration
Parameters
- playlist: M3uPlaylist
  
  m3u playlist object processed until now
- media: M3uMedia
  
  actual m3u media object
- trackInformation: string
  
  track information, whole part of string after directive and semicolon
- directive: string
  
  unknown directive e.g. #EXT-CUSTOM
- customDataMapping: M3uCustomDataMapping
  
  whole custom directive data mapping configuration
Returns void
- Defined in m3u-parser.ts:157

`Static` `Private` processDirective

processDirective(item: string, customDataMapping: M3uCustomDataMapping, playlist: M3uPlaylist, media: M3uMedia): void
Private
Process directive method detects directive on line and call proper method to another processing
Parameters
- item: string
  
  actual line of m3u playlist string e.g. '#EXTINF:-1 tvg-id="" group-title="",Tv Name'
- customDataMapping: M3uCustomDataMapping
  
  whole custom directive data mapping configuration
- playlist: M3uPlaylist
  
  m3u playlist object processed until now
- media: M3uMedia
  
  actual m3u media object
Returns void
- Defined in m3u-parser.ts:86

`Static` `Private` processExtM3uAttributes

processExtM3uAttributes(item: string, playlist: M3uPlaylist): void
Private
Process attributes in #EXTM3U line
Parameters
- item: string
  
  first line of m3u playlist string e.g. '#EXTM3U url-tvg="http://example.com/tvg.xml"'
- playlist: M3uPlaylist
  
  m3u playlist object processed until now
Returns void
- Defined in m3u-parser.ts:179

`Static` `Private` processMedia

processMedia(trackInformation: string, media: M3uMedia): void
Private
Process media method parse trackInformation and fill media with parsed info
Parameters
- trackInformation: string
  
  media substring of m3u string line e.g. '-1 tvg-id="" group-title="",Tv Name'
- media: M3uMedia
  
  actual m3u media object
Returns void
- Defined in m3u-parser.ts:65

Class M3uParser

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns M3uParser

Methods

Static Private getAttributes

Returns

Parameters

attributesString: string

Returns M3uAttributes

Static Private getPlaylist

Returns

Parameters

lines: string[]

customDataMapping: M3uCustomDataMapping = {}

Returns M3uPlaylist

Static Private isDirective

Returns

Parameters

item: string

Returns boolean

Static Private isValidM3u

Returns

Parameters

firstLine: string[]

Returns boolean

Static parse

Returns

Example

Parameters

m3uString: string

Optional config: M3uParserConfig

Returns M3uPlaylist

Static Private processCustomData

Parameters

playlist: M3uPlaylist

media: M3uMedia

trackInformation: string

directive: string

customDataMapping: M3uCustomDataMapping

Returns void

Static Private processDirective

Parameters

item: string

customDataMapping: M3uCustomDataMapping

playlist: M3uPlaylist

media: M3uMedia

Returns void

Static Private processExtM3uAttributes

Parameters

item: string

playlist: M3uPlaylist

Returns void

Static Private processMedia

Parameters

trackInformation: string

media: M3uMedia

Returns void

Settings

Member Visibility

Theme

`Static` `Private` getAttributes

`Static` `Private` getPlaylist

`Static` `Private` isDirective

`Static` `Private` isValidM3u

`Static` parse

`Optional` config: M3uParserConfig

`Static` `Private` processCustomData

`Static` `Private` processDirective

`Static` `Private` processExtM3uAttributes

`Static` `Private` processMedia