Skip to main content

Query ProfileSets

ProfileSets are a crucial part of the BlendVision One ecosystem, allowing you to customize your streaming experience. ProfileSets are sets of configurations that determine the streaming protocols, video codecs, and other settings for your streaming service. You can send a GET request to query a list of ProfileSets by using the following API:

GET /bv/configuration/v1/profile-sets

This API accepts several query parameters to filter the results:

ParameterTypeDescription
filter.presetstringFilter the ProfileSets based on whether they are preset or customized. Allowed values: PRESET_EXCLUDE to show only customized ProfileSets and PRESET_ONLY to show only preset ProfileSets.
current_pageintegerThe current page number of the pagination. The value should be a positive number between 1 and 100.
items_per_pageintegerThe number of items per page in the pagination. The value should be a positive number between 1 and 100.

Here is an example of querying ProfileSets:

/bv/configuration/v1/profile-sets?filter.preset=PRESET_ONLY&current_page=1&items_per_page=10

A successful response from the API will return a JSON object containing a list of ProfileSets and pagination information. Each ProfileSet object includes details such as the ID, name, protocols, video codec, and profiles.

Here is an example of a successful response:

{
"profile_sets": [
{
"id": "string",
"name": "string",
"protocols": [
"PROTOCOL_UNSPECIFIED"
],
"smart_abr": true,
"multiple_audio_track": {
"lang_from": "LANG_FROM_UNSPECIFIED",
"lang_customizes": [
{
"code": "string",
"display": "string"
}
]
},
"video_codec": "VIDEO_CODEC_UNSPECIFIED",
"profiles": [
{
"id": "string",
"name": "string",
"video_codec": "VIDEO_CODEC_UNSPECIFIED",
"video_width": 0,
"video_height": 0,
"video_bitrate": "string",
"audio_bitrate": "string",
"codec_profile": "CODEC_PROFILE_UNSPECIFIED",
"level": "CODEC_PROFILE_LEVEL_UNSPECIFIED",
"b_frame": true,
"frame_rate": "FRAME_RATE_UNSPECIFIED",
"gop_size": 0,
"segment_duration": 0,
"preset": true,
"standard": "RESOLUTION_TYPE_UNSPECIFIED"
}
],
"preset": true
}
],
"pagination": {
"total_items": 0,
"items_per_page": 0,
"current_page": 0
}
}

You can choose the appropriate ProfileSets based on your requirements and obtain the id in the ProfileSet object for further operations.