Media Server 24.1

# GetPlaylist

Returns an HLS playlist for content in the rolling buffer. An HLS-compliant media player can use the playlist to play back video from the rolling buffer.

Type: synchronous

Parameter | Description | Required
--- | --- | ---
Duration | The duration of the playlist. You can use this parameter when you specify a start time, but if you set the `Offset` parameter, any duration is ignored. | No
Format | Specifies whether to return the playlist as text or encapsulated in XML. | No
HLSVersion | Specifies whether to return a HLS version 4 playlist. | No
LiveURL | The URL to use to play live video. The value you set for this parameter is included in the playlist in the `#HP-LIVE-URL` field and is used by the OpenText Media Player. | No
MediaSegmentTemplate | A string that describes how to build the URL for a media segment in a playlist | No
MinimumSegments | The minimum number of segments that are contained in the returned playlist. | No
Offset | Specifies the start time of the playlist by calculating an offset from the current time. For example, if you specify an offset of one hour, the start time for the playlist is one hour ago. Specify the offset as a time duration. | Set this parameter or `StartTime`
SegmentLength | The length of the segments to divide the video into (in seconds). | No
StartTime | The start time of the playlist in ISO 8601 format or epoch milliseconds. | Set this parameter or `Offset`
Stream | The name of the rolling buffer to create the playlist from. | Yes
VariantSegmentTemplate | A string that describes how to build the URL for a `getPlaylist` action in a playlist | No

You must specify one of the following combinations of parameters:

- Stream and StartTime: produces a playlist that starts at the specified UTC time and continues until the content ends.
- Stream, StartTime, and Duration: produces a playlist for a specified period of time only.
- Stream and Offset: produces a playlist with a fixed time offset, for example 10 minutes ago. The playlist continues until the content ends.

## Example

    http://localhost:14000/action=GetPlaylist
                                    &Stream=BBCNews
                                    &StartTime=1393000074243
                                    &Duration=5minutes

This action retrieves a playlist from Media Server. The playlist specifies the content for the `BBCNews` rolling buffer for five minutes from 16:27:54 PM on 21 February 2014.

## Response

A sample response appears below. There is no XML as by default `format=m3u8`.

    #EXTM3U
    #EXT-X-TARGETDURATION:10
    #EXT-X-MEDIA-SEQUENCE:141034672
    #EXT-X-BYTERANGE:5288177@133310
    #EXTINF:10,
    http://webserver:80/Stream1/Video/141/0/342915/Stream1_VIDEO_ENG_1410342915.ts
    #EXTINF:10,
    #EXT-X-BYTERANGE:5250136@5421488
    http://webserver:80/Stream1/Video/141/0/342915/Stream1_VIDEO_ENG_1410342915.ts
    #EXT-X-ENDLIST

Copyright 2023 Open Text
Version 24.1 | Last updated December 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Media Server 24.1

Topic Title: GetPlaylist