Get Encoding Profiles

Retrieves all of the encoding profiles associated with your account.

Request

Request syntax:

GET /slicers/encoding-profiles

Response

The response for a successful request contains the following properties:

items List

The items list describes each encoding profile through the following properties:

top_ray Dictionary

The top_ray dictionary describes the top ray through the following properties:

Sample Request/Response

Call the get_encoding_profiles module (Python 3) to retrieve all of your encoding profiles. This module imports names from the api_auth module.

import json
import requests
from api_auth import APICredentials, APIParams

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

    def run(self):
        """
        Get all encoding profiles.
        """
        self._get_all_encoding_profiles()

    def _get_all_encoding_profiles(self):
        url = "{}{}".format(self.host, "/api/v4/slicers/encoding-profiles")

        response = requests.get(
            url, params=APIParams(APICredentials()).get_params({})
        )

        print(response.json())

EncodingProfile().run()

Response:

{
	'@id': '/api/v4/slicers/encoding-profiles',
	'@type': 'Collection',
	'items': [{
			'@id': '/api/v4/slicers/encoding-profiles/2b030d5779654cfa811d4eef66923cfc',
			'@type': 'EncodingProfile',
			'id': '2b030d5779654cfa811d4eef66923cfc',
			'parent': 'db46efcaa07046e99ef2ef11bf7bda18',
			'desc': '720p30 v4',
			'identifier': 'systemdefault',
			'version': 5,
			'suppressARayExceptOnIOS': 0,
			'rate_card_id': 'HD 720p25/30',
			'top_ray': {
				'max_bframes': 3,
				'profile': 'high',
				'aoKbps': None,
				'skipF': 0,
				'fps': 30,
				'vKbps': 2400,
				'aKbps': 128,
				'aMaxChannels': 2,
				'maxW': 1280,
				'isHD': False,
				'maxH': 720,
				'preset': 'veryfast',
				'threads': 4,
				'vPasses': 2,
				'EncryptionKey': 1,
				'id': 4
			},
			'top_ray_bit_rate': 2400,
			'top_ray_width': 1280,
			'top_ray_height': 720,
			'top_ray_fps': 30,
			'top_ray_gpu_flag': 'not allowed',
			'top_ray_bframes_max': '',
			'top_ray_passes': 2,
			'top_ray_audio_rate': 128,
			'is_default_vod_profile': 1,
			'is_default_live_profile': 1,
			'is_default_system_profile': 1
		}
	],
	'total_items': 1
}