/bunnycdn-stream | Type: Application | PCID required: Yes
Tools
bunnycdn_stream_add_allowed_referrer_endpoint_add_allowed_referrer
Add Allowed Referer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the requested Video Library |
Hostname | string | Yes | — | The hostname that will be added as an allowed referer |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Video Library"
},
"Hostname": {
"type": "string",
"description": "The hostname that will be added as an allowed referer"
}
},
"required": [
"PCID",
"id",
"Hostname"
]
}
bunnycdn_stream_add_blocked_referrer_endpoint_add_blocked_referrer
Add Blocked Referer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the requested Video Library |
Hostname | string | Yes | — | The hostname that will be added as a blocked referer |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Video Library"
},
"Hostname": {
"type": "string",
"description": "The hostname that will be added as a blocked referer"
}
},
"required": [
"PCID",
"id",
"Hostname"
]
}
bunnycdn_stream_add_live_thumbnail_endpoint_add_thumbnail
Add Live Thumbnail Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the requested Video Library |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Video Library"
}
},
"required": [
"PCID",
"id"
]
}
bunnycdn_stream_add_live_watermark_endpoint_add_watermark
Add Live Watermark Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the requested Video Library |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Video Library"
}
},
"required": [
"PCID",
"id"
]
}
bunnycdn_stream_add_video_library_endpoint_add_video_library
Add Video Library Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
Name | string | Yes | — | The name of the Video Library. | |
PlayerVersion | integer | null | No | — | (Optional) Sets player version used for this library |
ReplicationRegions | string[] | No | — | The geo-replication regions of the underlying storage zone |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Name": {
"type": "string",
"description": "The name of the Video Library."
},
"PlayerVersion": {
"type": [
"integer",
"null"
],
"description": "(Optional) Sets player version used for this library"
},
"ReplicationRegions": {
"type": "array",
"items": {
"type": "string"
},
"description": "The geo-replication regions of the underlying storage zone"
}
},
"required": [
"PCID",
"Name"
]
}
bunnycdn_stream_add_watermark_endpoint_add_watermark
Add Watermark Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the requested Video Library |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Video Library"
}
},
"required": [
"PCID",
"id"
]
}
bunnycdn_stream_delete_live_thumbnail_endpoint_delete_thumbnail
Delete Live Thumbnail Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the requested Video Library |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Video Library"
}
},
"required": [
"PCID",
"id"
]
}
bunnycdn_stream_delete_live_watermark_endpoint_delete_watermark
Delete Live Watermark Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the requested Video Library |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Video Library"
}
},
"required": [
"PCID",
"id"
]
}
bunnycdn_stream_delete_video_library_endpoint_delete_video_library
Delete Video Library Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the Video Library that should be deleted |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the Video Library that should be deleted"
}
},
"required": [
"PCID",
"id"
]
}
bunnycdn_stream_delete_watermark_endpoint_delete_watermark
Delete Watermark Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the requested Video Library |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Video Library"
}
},
"required": [
"PCID",
"id"
]
}
bunnycdn_stream_get_drm_statistics_endpoint_statistics
Get Video Library DRM Statistics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the video library for which the DRM statistics will be returned |
dateFrom | string | No | — | (Optional) The start date of the statistics. If no value is passed, the last 14 days will be returned |
dateTo | string | No | — | (Optional) The end date of the statistics. If no value is passed, current date will be used |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the video library for which the DRM statistics will be returned"
},
"dateFrom": {
"type": "string",
"description": "(Optional) The start date of the statistics. If no value is passed, the last 14 days will be returned"
},
"dateTo": {
"type": "string",
"description": "(Optional) The end date of the statistics. If no value is passed, current date will be used"
}
},
"required": [
"PCID",
"id"
]
}
bunnycdn_stream_get_transcribing_statistics_endpoint_statistics
Get Video Library Transcribing Statistics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the video library for which the transcribing statistics will be returned |
dateFrom | string | No | — | (Optional) The start date of the statistics. If no value is passed, the last 14 days will be returned |
dateTo | string | No | — | (Optional) The end date of the statistics. If no value is passed, current date will be used |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the video library for which the transcribing statistics will be returned"
},
"dateFrom": {
"type": "string",
"description": "(Optional) The start date of the statistics. If no value is passed, the last 14 days will be returned"
},
"dateTo": {
"type": "string",
"description": "(Optional) The end date of the statistics. If no value is passed, current date will be used"
}
},
"required": [
"PCID",
"id"
]
}
bunnycdn_stream_get_video_library_endpoint_get_video_library
Get Video Library Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the Video Library that will be returned |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the Video Library that will be returned"
}
},
"required": [
"PCID",
"id"
]
}
bunnycdn_stream_get_video_library_languages_endpoint_get_video_library_languages
Get LanguagesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
bunnycdn_stream_list_video_libraries_endpoint_list_video_libraries
List Video Libraries Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
perPage | integer | No | — | Number of results per page |
search | string | No | — | The search term that will be used to filter the results |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"perPage": {
"type": "integer",
"description": "Number of results per page"
},
"search": {
"type": "string",
"description": "The search term that will be used to filter the results"
}
},
"required": [
"PCID"
]
}
bunnycdn_stream_remove_allowed_referrer_endpoint_remove_allowed_referrer
Remove Allowed Referer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the requested Video Library |
Hostname | string | Yes | — | The hostname that will be removed as an allowed referer |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Video Library"
},
"Hostname": {
"type": "string",
"description": "The hostname that will be removed as an allowed referer"
}
},
"required": [
"PCID",
"id",
"Hostname"
]
}
bunnycdn_stream_remove_blocked_referrer_endpoint_remove_blocked_referrer
Remove Blocked Referer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the requested Video Library |
Hostname | string | Yes | — | The hostname that will be removed as a blocked referer |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Video Library"
},
"Hostname": {
"type": "string",
"description": "The hostname that will be removed as a blocked referer"
}
},
"required": [
"PCID",
"id",
"Hostname"
]
}
bunnycdn_stream_reset_video_library_api_key_endpoint_reset_video_library_api_key
Reset API Key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the video library that should have the API key reset |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the video library that should have the API key reset"
}
},
"required": [
"PCID",
"id"
]
}
bunnycdn_stream_reset_video_library_read_only_api_key_endpoint_reset_video_library_read_only_api_key
Reset Read Only API Key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the video library that should have the read only API key reset |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the video library that should have the read only API key reset"
}
},
"required": [
"PCID",
"id"
]
}
bunnycdn_stream_update_video_library_endpoint_update_video_library
Update Video Library Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
id | integer | Yes | — | The ID of the Video Library to update | |
AllowDirectPlay | boolean | null | No | — | (Optional) Determines if direct play URLs should be enabled for the library |
AllowEarlyPlay | boolean | null | No | — | (Optional) Determines if the Early-Play feature should be enabled. Enabling this will enable Expose Originals. |
AppleFairPlayDrm | object | No | — | (Optional) Configure Apple FairPlay DRM. Works only if Enterprise DRM is set up. | |
Bitrate1080p | integer | null | No | — | (Optional) The bitrate used for encoding 1080p videos |
Bitrate1440p | integer | null | No | — | (Optional) The bitrate used for encoding 1440p videos |
Bitrate2160p | integer | null | No | — | (Optional) The bitrate used for encoding 2160p videos |
Bitrate240p | integer | null | No | — | (Optional) The bitrate used for encoding 240p videos |
Bitrate360p | integer | null | No | — | (Optional) The bitrate used for encoding 360p videos |
Bitrate480p | integer | null | No | — | (Optional) The bitrate used for encoding 480p videos |
Bitrate720p | integer | null | No | — | (Optional) The bitrate used for encoding 720p videos |
BlockNoneReferrer | boolean | null | No | — | (Optional) Determines if requests without a referer should be blocked. |
CaptionsBackground | string | null | No | — | (Optional) Sets the captions display background color |
CaptionsFontColor | string | null | No | — | (Optional) Sets the captions display font color |
CaptionsFontSize | integer | null | No | — | (Optional) Sets the captions display font size |
Controls | string | null | No | — | (Optional) The comma separated list of controls that will be displayed in the video player. Possible values: play-large, play, progress, current-time, mute, volume, captions, settings, pip, airplay, fullscreen. |
CustomHTML | string | null | No | — | (Optional) Sets the player custom HTML code |
DrmVersion | integer | null | No | — | (Optional) Determines MediaCage DRM version to be used for this library |
EnableCaptionsInPlaylist | boolean | null | No | — | (Optional) Determines if any associated captions will be automatically signaled in the HLS master playlist via EXT-X-MEDIA tags, allowing client players to show captions. |
EnableContentTagging | boolean | null | No | — | (Optional) Determines if content tagging should be enabled for this library. |
EnabledResolutions | string | null | No | — | (Optional) Sets the enabled resolutions for the transcoding. At least one resolution should be enabled. Possible values: 240p, 360p, 480p, 720p, 1080p, 1440p, 2160p |
EnableDRM | boolean | null | No | — | (Optional) Determines if MediaCage DRM should be enabled for this library |
EnableMP4Fallback | boolean | null | No | — | (Optional) Determines if MP4 fallback should be enabled for this library. |
EnableMultiAudioTrackSupport | boolean | null | No | — | (Optional) Determines if multiple output audio track support is enabled on video library. |
EnableTokenAuthentication | boolean | null | No | — | (Optional) Determines if the token authentication should be enabled |
EnableTokenIPVerification | boolean | null | No | — | (Optional) Determines if the token IP verification should be enabled |
EnableTranscribing | boolean | null | No | — | (Optional) Determines if the automatic audio transcribing is currently enabled for this zone. |
EnableTranscribingChaptersGeneration | boolean | null | No | — | (Optional) Determines if automatic transcribing chapters generation is currently enabled. |
EnableTranscribingDescriptionGeneration | boolean | null | No | — | (Optional) Determines if automatic transcribing description generation is currently enabled. |
EnableTranscribingMomentsGeneration | boolean | null | No | — | (Optional) Determines if automatic transcribing moments generation is currently enabled. |
EnableTranscribingTitleGeneration | boolean | null | No | — | (Optional) Determines if automatic transcribing title generation is currently enabled. |
EncodingTier | integer | null | No | — | (Optional) Defines encoding tier to be used with video library. premium is a paid tier that offers either JIT encoding or prioritized encoding and extra codec support. |
ExposeOriginals | boolean | null | No | — | (Optional) Marks whether original video files should be exposed via CDN. Originals are not protected by DRM. Enabling Early-Play will enable this. |
ExposeVideoMetadata | boolean | null | No | — | (Optional) Marks whether video metadata in form of schema meta tags and LD+JSON should be exposed. |
FontFamily | string | null | No | — | (Optional) The captions font family. |
GoogleWidevineDrm | object | No | — | (Optional) Configure Google Widevine DRM. Works only if Enterprise DRM is set up. | |
JitEncodingEnabled | boolean | null | No | — | (Optional) Determines whether JIT encoding should be used for the library. Supported in premium encoding only. |
KeepOriginalFiles | boolean | null | No | — | (Optional) Determines if the original file should be kept after the video is processed. |
Name | string | null | No | — | (Optional) Sets name of the video library |
OutputCodecs | string | null | No | — | (Optional) Specifies which video codecs are used for encoding, provided as a comma-separated (CSV) string. Free encoding tier supports only x264. A premium encoding tier adds support for vp9, hevc, and av1. |
PlaybackSpeeds | string | null | No | — | (Optional) The comma separated list of playback speeds that will be available in the video player. Possible values: 0.25,0.5,0.75,1.0,1.25,1.5,1.75,2.0,2.5,3,3.5,4 |
PlayerKeyColor | string | null | No | — | (Optional) Sets the player key control color |
PlayerTokenAuthenticationEnabled | boolean | null | No | — | (Optional) Determines if the token authentication should be enabled. |
PlayerVersion | integer | null | No | — | (Optional) Sets player version used for this library |
RememberPlayerPosition | boolean | null | No | — | (Optional) Determines if the player will automatically remember the playback position. |
RemoveMetadataFromFallbackVideos | boolean | null | No | — | (Optional) Marks whether all potential video metadata should be removed from the fallback files |
ResetToken | boolean | null | No | — | (Optional) Set to true to reset the CDN and embed view token key |
ScaleVideoUsingBothDimensions | boolean | null | No | — | (Optional) Marks whether videos should be scaled using both dimensions. Prevents videos being upscaled or unexpected aspect ratio changes. |
ShowHeatmap | boolean | null | No | — | (Optional) Determines if the video watch heatmap should be displayed in the player. |
TranscribingCaptionLanguages | string[] | No | — | (Optional) The list of languages that the captions will be automatically transcribed to. | |
UILanguage | string | null | No | — | (Optional) Sets the UI language of the video player. |
UseSeparateAudioStream | boolean | null | No | — | (Optional) Determines whether output audio stream should be split from video stream segments. |
VastTagUrl | string | null | No | — | (Optional) Sets the Vast tag URL |
ViAiPublisherId | string | null | No | — | (Optional) Sets the vi.ai publisher ID |
WatermarkHeight | integer | null | No | — | (Optional) Sets the height of the watermark (in %) |
WatermarkPositionLeft | integer | null | No | — | (Optional) Sets the left offset of the watermark position (in %) |
WatermarkPositionTop | integer | null | No | — | (Optional) Sets the top offset of the watermark position (in %) |
WatermarkWidth | integer | null | No | — | (Optional) Sets the width of the watermark (in %) |
WebhookUrl | string | null | No | — | (Optional) Sets the webhook API url |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the Video Library to update"
},
"AllowDirectPlay": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if direct play URLs should be enabled for the library"
},
"AllowEarlyPlay": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if the Early-Play feature should be enabled. Enabling this will enable Expose Originals."
},
"AppleFairPlayDrm": {
"type": "object",
"description": "(Optional) Configure Apple FairPlay DRM. Works only if Enterprise DRM is set up.",
"properties": {
"Enabled": {
"type": "boolean",
"description": "(Optional) Enables or disables Apple FairPlay Enterprise DRM"
}
}
},
"Bitrate1080p": {
"type": [
"integer",
"null"
],
"description": "(Optional) The bitrate used for encoding 1080p videos"
},
"Bitrate1440p": {
"type": [
"integer",
"null"
],
"description": "(Optional) The bitrate used for encoding 1440p videos"
},
"Bitrate2160p": {
"type": [
"integer",
"null"
],
"description": "(Optional) The bitrate used for encoding 2160p videos"
},
"Bitrate240p": {
"type": [
"integer",
"null"
],
"description": "(Optional) The bitrate used for encoding 240p videos"
},
"Bitrate360p": {
"type": [
"integer",
"null"
],
"description": "(Optional) The bitrate used for encoding 360p videos"
},
"Bitrate480p": {
"type": [
"integer",
"null"
],
"description": "(Optional) The bitrate used for encoding 480p videos"
},
"Bitrate720p": {
"type": [
"integer",
"null"
],
"description": "(Optional) The bitrate used for encoding 720p videos"
},
"BlockNoneReferrer": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if requests without a referer should be blocked."
},
"CaptionsBackground": {
"type": [
"string",
"null"
],
"description": "(Optional) Sets the captions display background color"
},
"CaptionsFontColor": {
"type": [
"string",
"null"
],
"description": "(Optional) Sets the captions display font color"
},
"CaptionsFontSize": {
"type": [
"integer",
"null"
],
"description": "(Optional) Sets the captions display font size"
},
"Controls": {
"type": [
"string",
"null"
],
"description": "(Optional) The comma separated list of controls that will be displayed in the video player. Possible values: play-large, play, progress, current-time, mute, volume, captions, settings, pip, airplay, fullscreen."
},
"CustomHTML": {
"type": [
"string",
"null"
],
"description": "(Optional) Sets the player custom HTML code"
},
"DrmVersion": {
"type": [
"integer",
"null"
],
"description": "(Optional) Determines MediaCage DRM version to be used for this library",
"enum": [
0,
1,
2
]
},
"EnableCaptionsInPlaylist": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if any associated captions will be automatically signaled in the HLS master playlist via EXT-X-MEDIA tags, allowing client players to show captions."
},
"EnableContentTagging": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if content tagging should be enabled for this library."
},
"EnabledResolutions": {
"type": [
"string",
"null"
],
"description": "(Optional) Sets the enabled resolutions for the transcoding. At least one resolution should be enabled. Possible values: 240p, 360p, 480p, 720p, 1080p, 1440p, 2160p"
},
"EnableDRM": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if MediaCage DRM should be enabled for this library"
},
"EnableMP4Fallback": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if MP4 fallback should be enabled for this library."
},
"EnableMultiAudioTrackSupport": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if multiple output audio track support is enabled on video library."
},
"EnableTokenAuthentication": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if the token authentication should be enabled"
},
"EnableTokenIPVerification": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if the token IP verification should be enabled"
},
"EnableTranscribing": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if the automatic audio transcribing is currently enabled for this zone."
},
"EnableTranscribingChaptersGeneration": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if automatic transcribing chapters generation is currently enabled."
},
"EnableTranscribingDescriptionGeneration": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if automatic transcribing description generation is currently enabled."
},
"EnableTranscribingMomentsGeneration": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if automatic transcribing moments generation is currently enabled."
},
"EnableTranscribingTitleGeneration": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if automatic transcribing title generation is currently enabled."
},
"EncodingTier": {
"type": [
"integer",
"null"
],
"description": "(Optional) Defines encoding tier to be used with video library. premium is a paid tier that offers either JIT encoding or prioritized encoding and extra codec support.",
"enum": [
0,
1
]
},
"ExposeOriginals": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Marks whether original video files should be exposed via CDN. Originals are not protected by DRM. Enabling Early-Play will enable this."
},
"ExposeVideoMetadata": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Marks whether video metadata in form of schema meta tags and LD+JSON should be exposed."
},
"FontFamily": {
"type": [
"string",
"null"
],
"description": "(Optional) The captions font family."
},
"GoogleWidevineDrm": {
"type": "object",
"description": "(Optional) Configure Google Widevine DRM. Works only if Enterprise DRM is set up.",
"properties": {
"Enabled": {
"type": "boolean",
"description": "(Optional) Enables or disables Google Widevine Enterprise DRM"
},
"SdOnlyForL3": {
"type": "boolean",
"description": "(Optional) Only allow audio and SD access to Widevine L3 clients"
},
"MinClientSecurityLevel": {
"type": "integer",
"description": "(Optional) Minimum Client Security Level (1 being most secure, 3 least secure and is default)",
"enum": [
0,
1,
2,
3
]
}
}
},
"JitEncodingEnabled": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines whether JIT encoding should be used for the library. Supported in premium encoding only."
},
"KeepOriginalFiles": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if the original file should be kept after the video is processed."
},
"Name": {
"type": [
"string",
"null"
],
"description": "(Optional) Sets name of the video library"
},
"OutputCodecs": {
"type": [
"string",
"null"
],
"description": "(Optional) Specifies which video codecs are used for encoding, provided as a comma-separated (CSV) string. Free encoding tier supports only x264. A premium encoding tier adds support for vp9, hevc, and av1."
},
"PlaybackSpeeds": {
"type": [
"string",
"null"
],
"description": "(Optional) The comma separated list of playback speeds that will be available in the video player. Possible values: 0.25,0.5,0.75,1.0,1.25,1.5,1.75,2.0,2.5,3,3.5,4"
},
"PlayerKeyColor": {
"type": [
"string",
"null"
],
"description": "(Optional) Sets the player key control color"
},
"PlayerTokenAuthenticationEnabled": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if the token authentication should be enabled."
},
"PlayerVersion": {
"type": [
"integer",
"null"
],
"description": "(Optional) Sets player version used for this library"
},
"RememberPlayerPosition": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if the player will automatically remember the playback position."
},
"RemoveMetadataFromFallbackVideos": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Marks whether all potential video metadata should be removed from the fallback files"
},
"ResetToken": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Set to true to reset the CDN and embed view token key"
},
"ScaleVideoUsingBothDimensions": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Marks whether videos should be scaled using both dimensions. Prevents videos being upscaled or unexpected aspect ratio changes."
},
"ShowHeatmap": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines if the video watch heatmap should be displayed in the player."
},
"TranscribingCaptionLanguages": {
"type": "array",
"items": {
"type": "string"
},
"description": "(Optional) The list of languages that the captions will be automatically transcribed to."
},
"UILanguage": {
"type": [
"string",
"null"
],
"description": "(Optional) Sets the UI language of the video player."
},
"UseSeparateAudioStream": {
"type": [
"boolean",
"null"
],
"description": "(Optional) Determines whether output audio stream should be split from video stream segments."
},
"VastTagUrl": {
"type": [
"string",
"null"
],
"description": "(Optional) Sets the Vast tag URL"
},
"ViAiPublisherId": {
"type": [
"string",
"null"
],
"description": "(Optional) Sets the vi.ai publisher ID"
},
"WatermarkHeight": {
"type": [
"integer",
"null"
],
"description": "(Optional) Sets the height of the watermark (in %)"
},
"WatermarkPositionLeft": {
"type": [
"integer",
"null"
],
"description": "(Optional) Sets the left offset of the watermark position (in %)"
},
"WatermarkPositionTop": {
"type": [
"integer",
"null"
],
"description": "(Optional) Sets the top offset of the watermark position (in %)"
},
"WatermarkWidth": {
"type": [
"integer",
"null"
],
"description": "(Optional) Sets the width of the watermark (in %)"
},
"WebhookUrl": {
"type": [
"string",
"null"
],
"description": "(Optional) Sets the webhook API url"
}
},
"required": [
"PCID",
"id"
]
}