Update Virtual Linear Playlist

Updates a virtual linear playlist.

Restrict a virtual linear playlist to assets that have been encoded with the same codec (i.e., AVC or HEVC).

Modifications to a virtual linear playlist are only applicable for new playback sessions. Existing playback sessions will be unaffected by your changes.

Request

Request syntax:

PATCH /linear-playlist/Playlist ID

Define the following variable when submitting the above request:

Request body parameters:

Pass the following request body parameters:

playlist List

The playlist list defines a virtual linear playlist via the following properties:

Response

The response for a successful request contains the following properties:

playlist List

The playlist list defines a virtual linear playlist via the following properties:

Sample Request/Response

Call the update_virtual_linear_playlist module (Python 3) to create a virtual linear playlist. This module imports names from the api_auth module.

import json
import requests
from api_auth import APICredentials, APIParams

class Update_VLP:
    def __init__(self):
        self.host = "https://services.uplynk.com"

    def run(self):
        self._update_virtual_linear_playlist()

    def _update_virtual_linear_playlist(self):
        playlist_id = 'abce801613f94955b17db4f7c8e8137c' # Replace with the desired playlist ID.
        url = "{}{}{}".format(self.host, "/api/v4/linear-playlist/", playlist_id)

        beam_break_duration = 45 # Sets 45 second ad breaks.

        payload = {
            'beam_break_duration': beam_break_duration
        }

        headers = {'Content-Type': 'application/json'}

        response = requests.patch(
            url, params=APIParams(APICredentials()).get_params({}), data=json.dumps(payload), headers=headers
        )

        print(response.json())

Update_VLP().run()

Response:

{
	'@id': '/api/v4/linear-playlist/abce801613f94955b17db4f7c8e8137c',
	'@type': 'LinearPlaylist',
	'id': 'abce801613f94955b17db4f7c8e8137c',
	'desc': 'Sample Playlist',
	'repeat': -1,
	'profile': '',
	'beam_break_duration': 45,
	'ad_slate_fill': 0,
	'active': 1,
	'skip_drm': 0,
	'studio_drm_required': 0,
	'playlist': [{
			'beam': {
				'id': 'abc123456defghi789jklmno012345pq'
			}
		}, {
			'ad': {
				'dur': 20
			}
		}, {
			'beam': {
				'id': '1df8d13992cd4222a7343b8fafd89cd7'
			}
		}
	]
}