Update WebVTT Track

Replaces an asset's track.

Key information:

• You cannot use this endpoint to add a track to an asset. Please use the Add WebVTT Track endpoint instead.

• You cannot replace a track if the asset is still being sliced.

• Specify TTML data in the request or by providing a URL to it.

  You may only add the first track from TTML data.

• It takes approximately 30 seconds to add a track for a two hour asset.

Request

Request syntax:

/jobs/replace_track_vtt

Request parameters:

The set of request parameters varies according to whether you plan on replacing a single or multiple WebVTT tracks.

Single WebVTT track

Replace a single WebVTT track by passing the following parameters through the msg parameter:

Replace multiple WebVTT tracks by passing the following parameters through the msg parameter:

source List

The source list contains a dictionary for each WebVTT track that will replace an existing track within an asset. Describe each WebVTT track through the following properties:

Authentication

Pass a digital signature based off of msg.

Learn more.

Response

The response for a successful request contains the following parameter.

Sample Request/Response

A sample request/response is provided below. The Call() function, which is imported from uplynk_api2_auth module, prepares the message body and digital signature.

from uplynk_api2_auth import Call

print(Call('/api2/cloudslicer/jobs/replace_track_vtt', asset='ae01164a50a04847b5624485aae1aac3', ttml_url='https://cdn.example.com/resources/ttml/m_campaign_23.ttml', track_num=0))

{
	'job': {
		'last_error': '',
		'args': {
			'add_track_num': 0,
			'old_ranges': {
				'ranges': [[92416, -1, 92416], ... [164736, -1, 164736]],
				'full_slice_samples': 196608,
				'break_durations': {}
			},
			'ttml_data': None,
			'write_dash': 2,
			'ttml_url': 'https://cdn.example.com/resources/ttml/m_campaign_23.ttml'
		},
		'finished': 0,
		'attempts': 0,
		'source': {},
		'state': 'waiting',
		'asset': 'abb0000a6fe24c1f963e4dd51b37988e',
		'last_start': 0,
		'owner': 'cb233864a92b46a1a286cdd49b0a9bc8',
		'progress': '',
		'id': '535a7bc35e69413f945348cdc3381ae8'
	},
	'error': 0
}