PlayerConfiguration Controller

PlayerConfiguration control the way media is delivered. And even though images or documents do not use a player (literally), playerconfiguration controller also handles embedlinks for images and documents.

PlayerConfigurations control which formats are delivered, if they are downloadable or if you want to use security measures to protect your embedlinks.

Reference

Find playerConfigurations

Find playerconfigurations for the current customer including the number of embedlinks for this player.

GET/v5/playerconfiguration

Request Parameters

Field	Type	Required	Description
id	integer	✗	Id of the playerConfiguration
refresh	boolean	✗	Fetch data fresh from database
showCountEmbeds	boolean	✗	Show number of embeds for all playerConfigurations
showFormats	boolean	✗	Show formats for playerConfigurations

Response

Field	Type	Description
configuration	object	Configuration for playerConfiguration
└ mediaTypes	array	array of media types (video, audio, etc) this playerconfiguration can be used for
creatorId	integer	CreatorId for this playerConfiguration
customerId	integer	CustomerId for this playerConfiguration
formats	array	Formats for playerConfiguration
└ formatId	integer
└ downloadable	boolean
freshness	integer	Shows the timestamp of this delivered version. If delivered from cache it can be different from now.
height	integer	Height of the the player. If not set, the player is responsive.
id	integer	Id of the playerConfiguration
lastEditorId	integer	Last editor for this playerConfiguration
name	string	Name for playerConfiguration
securitySettings	object	SecuritySettings for playerConfiguration
└ auth	object
└ enabled	boolean	TBA
└ extAuth	object	TBA
└ enabled	boolean	Set to true to enable extAuth.
└ allowedAccessKeys	array	Array of accessKeys for extAuth
└ oauth	object	TBA
└ enabled	boolean	Enable OAuth
└ clientId	string	Allowed clientId for OAuth
└ grants	array	TBA Deprecated
└ ipWhiteList	object	TBA
└ enabled	boolean	Enable ipWhiteListing
└ authOnly	boolean	TBA
└ bandwidthControl	array
└ cidr	cidr	Array of objects, e.g. [{ cidr: "8.8.8.8/32" }]
└ type	string	TBA
└ limit	integer	TBA
└ ipWhiteList	cidr	Array of objects with keys cidr and type ("ipv4", "ipv6") with list of allowed CIDRs for each key.
└ matchReferer	array	List of allowed referer domains (e.g. ["www.admiralcloud.com,…] or ["*.admiralcloud.com",…]
└ url	object
└ cname	fqdn	CNAME to use for this playerconfiguration
settings	object	Settings for playerConfiguration
└ auth	object	Deprecated
└ enabled	boolean	TBA
└ extAuth	object	TBA
└ enabled	boolean	TBA
└ allowedAccessKeys	array	TBA
└ oauth	object	TBA
└ enabled	boolean	Enable OAuth
└ clientId	string	TBA
└ ipWhiteList	object	TBA
└ enabled	boolean	Enable ipWhiteListing
└ authOnly	boolean	TBA
└ cname	fqdn	Deprecated
└ customer	object	Customer data for embedlinks Deprecated
└ name	string	OEmbed customer name
└ url	fqdn	OEmbed customer url
└ providerName	string	OEmbed provider name
└ providerUrl	fqdn	OEmbed provider url
└ fixedPreviewImage	object
└ enabled	boolean
└ mediaContainerId	integer
└ preferredFileExtensions	array
└ subtitle	object
└ default	integer
└ behaviour	integer
└ lang	iso-639-2
└ matchReferer	array	Deprecated
└ ipWhiteList	cidr	Deprecated
templateId	integer	TemplateId for playerConfiguration. Can be 0 for playerConfigurations of type image or document
type	string	Type for playerConfiguration
width	integer	Width of the the player. If not set, the player is responsive.

// Success Example
 [{
      "id": 1,
     "name": "VideoJS V1.0 AC Version",
      "templateId": 1,
      "width": 640,
      "height": 360,
      "autoGenerate": true,
      "settings": {},
      "formats": [{
        "playerConfigurationId": 147,
        "formatId": 1,
        "downloadable": false
      },{
        "playerConfigurationId": 147,
        "formatId": 10,
        "downloadable": true
      }],
      "countEmbeds": 13
    }, {...}
   ]

Creates a new playerconfiguration. You can define different formats for each player configuration, as well as if those formats can be downloaded

Create playerConfigurations

POST/v5/playerconfiguration

Request Parameters

Field	Type	Required	Description
configuration	object	✗	Configuration for playerConfiguration
└ mediaTypes	array	✗	array of media types (video, audio, etc) this playerconfiguration can be used for
formats	array	✓	Formats for playerConfiguration
height	integer	✗	Height of the the player. If not set, the player is responsive.
name	string	✓	Name for playerConfiguration
securitySettings	object	✗	SecuritySettings for playerConfiguration
└ auth	object	✗
└ enabled	boolean	✗	TBA
└ extAuth	object	✗	TBA
└ enabled	boolean	✗	Set to true to enable extAuth.
└ allowedAccessKeys	array	✗	Array of accessKeys for extAuth
└ oauth	object	✗	TBA
└ enabled	boolean	✗	Enable OAuth
└ clientId	string	✗	Allowed clientId for OAuth
└ grants	array	✗	TBA
└ ipWhiteList	object	✗	TBA
└ enabled	boolean	✗	Enable ipWhiteListing
└ authOnly	boolean	✗	TBA
└ bandwidthControl	array	✗
└ ipWhiteList	cidr	✗	Array of objects with keys cidr and type ("ipv4", "ipv6") with list of allowed CIDRs for each key.
└ matchReferer	array	✗	List of allowed referer domains (e.g. ["www.admiralcloud.com,…] or ["*.admiralcloud.com",…]
└ url	object	✗
└ cname	fqdn	✗	CNAME to use for this playerconfiguration
settings	object	✗	Settings for playerConfiguration
└ auth	object	✗
└ enabled	boolean	✗	TBA
└ extAuth	object	✗	TBA
└ enabled	boolean	✗	TBA
└ allowedAccessKeys	array	✗	TBA
└ oauth	object	✗	TBA
└ enabled	boolean	✗	Enable OAuth
└ clientId	string	✗	TBA
└ ipWhiteList	object	✗	TBA
└ enabled	boolean	✗	Enable ipWhiteListing
└ authOnly	boolean	✗	TBA
└ cname	fqdn	✗
└ customer	object	✗	Customer data for embedlinks
└ name	string	✗	OEmbed customer name
└ url	fqdn	✗	OEmbed customer url
└ providerName	string	✗	OEmbed provider name
└ providerUrl	fqdn	✗	OEmbed provider url
└ fixedPreviewImage	object	✗
└ enabled	boolean	✗
└ mediaContainerId	integer	✗
└ preferredFileExtensions	array	✗
└ subtitle	object	✗
└ default	integer	✗
└ behaviour	integer	✗
└ lang	iso-639-2	✗
└ matchReferer	array	✗
└ ipWhiteList	cidr	✗
templateId	integer	✓	TemplateId for playerConfiguration. Required for video and audio players, otherwise send 0
type	string	✓	Type for playerConfiguration
width	integer	✗	Width of the the player. If not set, the player is responsive.

Response

Field	Type	Description
configuration	object	Configuration for playerConfiguration
└ mediaTypes	array	array of media types (video, audio, etc) this playerconfiguration can be used for
creatorId	integer	CreatorId for this playerConfiguration
customerId	integer	CustomerId for this playerConfiguration
formats	array	Formats for playerConfiguration
└ formatId	integer
└ downloadable	boolean
freshness	integer	Shows the timestamp of this delivered version. If delivered from cache it can be different from now.
height	integer	Height of the the player. If not set, the player is responsive.
id	integer	Id of the playerConfiguration
lastEditorId	integer	Last editor for this playerConfiguration
name	string	Name for playerConfiguration
securitySettings	object	SecuritySettings for playerConfiguration
└ auth	object
└ enabled	boolean	TBA
└ extAuth	object	TBA
└ enabled	boolean	Set to true to enable extAuth.
└ allowedAccessKeys	array	Array of accessKeys for extAuth
└ oauth	object	TBA
└ enabled	boolean	Enable OAuth
└ clientId	string	Allowed clientId for OAuth
└ grants	array	TBA Deprecated
└ ipWhiteList	object	TBA
└ enabled	boolean	Enable ipWhiteListing
└ authOnly	boolean	TBA
└ bandwidthControl	array
└ cidr	cidr	Array of objects, e.g. [{ cidr: "8.8.8.8/32" }]
└ type	string	TBA
└ limit	integer	TBA
└ ipWhiteList	cidr	Array of objects with keys cidr and type ("ipv4", "ipv6") with list of allowed CIDRs for each key.
└ matchReferer	array	List of allowed referer domains (e.g. ["www.admiralcloud.com,…] or ["*.admiralcloud.com",…]
└ url	object
└ cname	fqdn	CNAME to use for this playerconfiguration
settings	object	Settings for playerConfiguration
└ auth	object	Deprecated
└ enabled	boolean	TBA
└ extAuth	object	TBA
└ enabled	boolean	TBA
└ allowedAccessKeys	array	TBA
└ oauth	object	TBA
└ enabled	boolean	Enable OAuth
└ clientId	string	TBA
└ ipWhiteList	object	TBA
└ enabled	boolean	Enable ipWhiteListing
└ authOnly	boolean	TBA
└ cname	fqdn	Deprecated
└ customer	object	Customer data for embedlinks Deprecated
└ name	string	OEmbed customer name
└ url	fqdn	OEmbed customer url
└ providerName	string	OEmbed provider name
└ providerUrl	fqdn	OEmbed provider url
└ fixedPreviewImage	object
└ enabled	boolean
└ mediaContainerId	integer
└ preferredFileExtensions	array
└ subtitle	object
└ default	integer
└ behaviour	integer
└ lang	iso-639-2
└ matchReferer	array	Deprecated
└ ipWhiteList	cidr	Deprecated
templateId	integer	TemplateId for playerConfiguration. Can be 0 for playerConfigurations of type image or document
type	string	Type for playerConfiguration
width	integer	Width of the the player. If not set, the player is responsive.

Examples

A simple video player

// POST /v5/playerconfiguration 
{
   "name":"My Player 01",
   "formats":[
      {
         "formatId":1
      },
      {
         "formatId":3,
         "downloadable":true
      }
   ],
   "templateId":11
}

Player with restrictions

{
   "name":"Player with restrictions",
   "formats":[
      {
         "formatId":1
      },
      {
         "formatId":3,
         "downloadable":true
      }
   ],
   "templateId":3,
   "settings":{
      "matchReferer":[
         "*.admiralcloud.com"
      ],
      "ipWhiteList":[
         "cidr":"4.4.4.4/32",
         "type":"ipv4"
      ]
   }
}

Update playerConfigurations

Update the playerconfiguration and also the associated formats.

Please make sure that all formats are always sent with this call. All formats not in the payload will be removed from the playerconfiguration without warning!

PUT/v5/playerconfiguration/:id

Request Parameters

Field	Type	Required	Description
configuration	object	✗	Configuration for playerConfiguration
└ mediaTypes	array	✗	array of media types (video, audio, etc) this playerconfiguration can be used for
formats	array	✓	Formats for playerConfiguration
height	integer	✗	Height of the the player. If not set, the player is responsive.
id	integer	✓	Id of the playerConfiguration
name	string	✗	Name for playerConfiguration
securitySettings	object	✗	SecuritySettings for playerConfiguration
└ auth	object	✗
└ enabled	boolean	✗	TBA
└ extAuth	object	✗	TBA
└ enabled	boolean	✗	Set to true to enable extAuth.
└ allowedAccessKeys	array	✗	Array of accessKeys for extAuth
└ oauth	object	✗	TBA
└ enabled	boolean	✗	Enable OAuth
└ clientId	string	✗	Allowed clientId for OAuth
└ grants	array	✗	TBA
└ ipWhiteList	object	✗	TBA
└ enabled	boolean	✗	Enable ipWhiteListing
└ authOnly	boolean	✗	TBA
└ bandwidthControl	array	✗
└ ipWhiteList	cidr	✗	Array of objects with keys cidr and type ("ipv4", "ipv6") with list of allowed CIDRs for each key.
└ matchReferer	array	✗	List of allowed referer domains (e.g. ["www.admiralcloud.com,…] or ["*.admiralcloud.com",…]
└ url	object	✗
└ cname	fqdn	✗	CNAME to use for this playerconfiguration
settings	object	✗	Settings for playerConfiguration
└ auth	object	✗
└ enabled	boolean	✗	TBA
└ extAuth	object	✗	TBA
└ enabled	boolean	✗	TBA
└ allowedAccessKeys	array	✗	TBA
└ oauth	object	✗	TBA
└ enabled	boolean	✗	Enable OAuth
└ clientId	string	✗	TBA
└ ipWhiteList	object	✗	TBA
└ enabled	boolean	✗	Enable ipWhiteListing
└ authOnly	boolean	✗	TBA
└ cname	fqdn	✗
└ customer	object	✗	Customer data for embedlinks
└ name	string	✗	OEmbed customer name
└ url	fqdn	✗	OEmbed customer url
└ providerName	string	✗	OEmbed provider name
└ providerUrl	fqdn	✗	OEmbed provider url
└ fixedPreviewImage	object	✗
└ enabled	boolean	✗
└ mediaContainerId	integer	✗
└ preferredFileExtensions	array	✗
└ subtitle	object	✗
└ default	integer	✗
└ behaviour	integer	✗
└ lang	iso-639-2	✗
└ matchReferer	array	✗
└ ipWhiteList	cidr	✗
templateId	integer	✗	TemplateId for playerConfiguration. Required for video and audio players, otherwise send 0
width	integer	✗	Width of the the player. If not set, the player is responsive.

Response

Field	Type	Description
configuration	object	Configuration for playerConfiguration
└ mediaTypes	array	array of media types (video, audio, etc) this playerconfiguration can be used for
creatorId	integer	CreatorId for this playerConfiguration
customerId	integer	CustomerId for this playerConfiguration
formats	array	Formats for playerConfiguration
└ formatId	integer
└ downloadable	boolean
freshness	integer	Shows the timestamp of this delivered version. If delivered from cache it can be different from now.
height	integer	Height of the the player. If not set, the player is responsive.
id	integer	Id of the playerConfiguration
lastEditorId	integer	Last editor for this playerConfiguration
name	string	Name for playerConfiguration
securitySettings	object	SecuritySettings for playerConfiguration
└ auth	object
└ enabled	boolean	TBA
└ extAuth	object	TBA
└ enabled	boolean	Set to true to enable extAuth.
└ allowedAccessKeys	array	Array of accessKeys for extAuth
└ oauth	object	TBA
└ enabled	boolean	Enable OAuth
└ clientId	string	Allowed clientId for OAuth
└ grants	array	TBA Deprecated
└ ipWhiteList	object	TBA
└ enabled	boolean	Enable ipWhiteListing
└ authOnly	boolean	TBA
└ bandwidthControl	array
└ cidr	cidr	Array of objects, e.g. [{ cidr: "8.8.8.8/32" }]
└ type	string	TBA
└ limit	integer	TBA
└ ipWhiteList	cidr	Array of objects with keys cidr and type ("ipv4", "ipv6") with list of allowed CIDRs for each key.
└ matchReferer	array	List of allowed referer domains (e.g. ["www.admiralcloud.com,…] or ["*.admiralcloud.com",…]
└ url	object
└ cname	fqdn	CNAME to use for this playerconfiguration
settings	object	Settings for playerConfiguration
└ auth	object	Deprecated
└ enabled	boolean	TBA
└ extAuth	object	TBA
└ enabled	boolean	TBA
└ allowedAccessKeys	array	TBA
└ oauth	object	TBA
└ enabled	boolean	Enable OAuth
└ clientId	string	TBA
└ ipWhiteList	object	TBA
└ enabled	boolean	Enable ipWhiteListing
└ authOnly	boolean	TBA
└ cname	fqdn	Deprecated
└ customer	object	Customer data for embedlinks Deprecated
└ name	string	OEmbed customer name
└ url	fqdn	OEmbed customer url
└ providerName	string	OEmbed provider name
└ providerUrl	fqdn	OEmbed provider url
└ fixedPreviewImage	object
└ enabled	boolean
└ mediaContainerId	integer
└ preferredFileExtensions	array
└ subtitle	object
└ default	integer
└ behaviour	integer
└ lang	iso-639-2
└ matchReferer	array	Deprecated
└ ipWhiteList	cidr	Deprecated
templateId	integer	TemplateId for playerConfiguration. Can be 0 for playerConfigurations of type image or document
type	string	Type for playerConfiguration
width	integer	Width of the the player. If not set, the player is responsive.

Destroy playerConfigurations

Destroys a player configuration. If there are embedlinks connected to this configuration the API will respond with an error.

* You can then resend the request with the parameter move which defines if the playerConfiguration and all embedlinks should be deleted (move = -1)

* or move the players to the new configuration

* ATTENTION. If you sent move = -1 all embedlinks with this playerConfiguration are deleted (flagged as deleted) and no longer available!

DELETE/v5/playerconfiguration/:id

Request Parameters

Field	Type	Required	Description
autoGenerate	boolean	✗	array of media types (video, audio, etc) this playerconfiguration is automatically created for
id	integer	✓	Id of the playerConfiguration
move	integer	✗	PlayerConfig to move embedlinks to

Response

Field	Type	Description
configuration	object	Configuration for playerConfiguration
└ mediaTypes	array	array of media types (video, audio, etc) this playerconfiguration can be used for
creatorId	integer	CreatorId for this playerConfiguration
customerId	integer	CustomerId for this playerConfiguration
formats	array	Formats for playerConfiguration
└ formatId	integer
└ downloadable	boolean
freshness	integer	Shows the timestamp of this delivered version. If delivered from cache it can be different from now.
height	integer	Height of the the player. If not set, the player is responsive.
id	integer	Id of the playerConfiguration
lastEditorId	integer	Last editor for this playerConfiguration
name	string	Name for playerConfiguration
securitySettings	object	SecuritySettings for playerConfiguration
└ auth	object
└ enabled	boolean	TBA
└ extAuth	object	TBA
└ enabled	boolean	Set to true to enable extAuth.
└ allowedAccessKeys	array	Array of accessKeys for extAuth
└ oauth	object	TBA
└ enabled	boolean	Enable OAuth
└ clientId	string	Allowed clientId for OAuth
└ grants	array	TBA Deprecated
└ ipWhiteList	object	TBA
└ enabled	boolean	Enable ipWhiteListing
└ authOnly	boolean	TBA
└ bandwidthControl	array
└ cidr	cidr	Array of objects, e.g. [{ cidr: "8.8.8.8/32" }]
└ type	string	TBA
└ limit	integer	TBA
└ ipWhiteList	cidr	Array of objects with keys cidr and type ("ipv4", "ipv6") with list of allowed CIDRs for each key.
└ matchReferer	array	List of allowed referer domains (e.g. ["www.admiralcloud.com,…] or ["*.admiralcloud.com",…]
└ url	object
└ cname	fqdn	CNAME to use for this playerconfiguration
settings	object	Settings for playerConfiguration
└ auth	object	Deprecated
└ enabled	boolean	TBA
└ extAuth	object	TBA
└ enabled	boolean	TBA
└ allowedAccessKeys	array	TBA
└ oauth	object	TBA
└ enabled	boolean	Enable OAuth
└ clientId	string	TBA
└ ipWhiteList	object	TBA
└ enabled	boolean	Enable ipWhiteListing
└ authOnly	boolean	TBA
└ cname	fqdn	Deprecated
└ customer	object	Customer data for embedlinks Deprecated
└ name	string	OEmbed customer name
└ url	fqdn	OEmbed customer url
└ providerName	string	OEmbed provider name
└ providerUrl	fqdn	OEmbed provider url
└ fixedPreviewImage	object
└ enabled	boolean
└ mediaContainerId	integer
└ preferredFileExtensions	array
└ subtitle	object
└ default	integer
└ behaviour	integer
└ lang	iso-639-2
└ matchReferer	array	Deprecated
└ ipWhiteList	cidr	Deprecated
templateId	integer	TemplateId for playerConfiguration. Can be 0 for playerConfigurations of type image or document
type	string	Type for playerConfiguration
width	integer	Width of the the player. If not set, the player is responsive.

API

Reference

Find playerConfigurations

Create playerConfigurations

Update playerConfigurations

Destroy playerConfigurations

Related Articles