EmbedLink Controller

Create external embedlinks for different mediacontainers.

Reference

Embedlink find

GET/v6/embedlink/:mediaContainerId

Request Parameters

Field	Type	Required	Description
embedFormat	string	✗	Filter for the given format
flags	base64	✗	Filter for the given flags
language	iso-639	✗	language to use for metadata in embed formats. If not set, defaults to "en" or the first available metadata language
mediaContainerId	integer	✓	mediaContainerId for this embedlink
playerConfigurationId	integer	✗	Embedlink will be created with this playerConfigurationId
refresh	boolean	✗	Invalidate and ignore cached version

Response

Field	Type	Description
created	boolean	True, if the embedlink is newly created. Please check warnings to see, if the embedlink already existed.
creatorId	integer	ID of the user who created the embedlink
customerId	integer	ID of customer CustomerId will not be delivered with any API response in the future. It is determined from session.
description	string	Description for embedlink
embeds	array	Different embedformats for this embedlink
└ id	integer	Unique ID for this embedformat
└ title	string	Title for this embedformat
└ description	string	Description for this embedformat
└ contentType	string	Content-Type for this embedformat
└ code	string	Code snippet for this embedformat
end	integer	End time as unix timestamp for embedlink. After this value the embedlink will not be delivered
flag	integer	Flag 0 is the default, active embedlink. Flag 10 is a hidden player (not visible to users) but can be accessed like flag 0 embedlink. Flag 10 cannot be used in destroy operation. ≡ allowed values: 010
hasThumbnailVersions	boolean	TBA Do not use any longer.
id	integer	Unique identifier for this embedlink
lastEditorId	integer	ID of the user who last updated the embedlink
link	string	Unique link for this embedlink
mediaContainerId	integer	mediaContainerId for this embedlink
origin	integer	Origin 0 means, a user has created the embedlink. Origin 10 means the embedlink has been auto-created by an event. ≡ allowed values: 010
playerConfigurationId	integer	Embedlink will be created with this playerConfigurationId
securitySettings	object	SecuritySettings for embedlinks
└ auth	object	Please use playerConfiguration for authentication settings.
└ 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
└ extAuth	object	Please use playerConfiguration for authentication settings.
└ required	boolean
└ allowedAccessKeys	array
settings	object
└ autoplay	boolean	Sets an embedlink of type video to autoplay
└ forceQuality	string	Sets an embedlink of type video to a preset quality ≡ allowed values: lowmedhighhd
└ hideControls	boolean	If true, hides controls of an embedlink of type video in the video player
└ hideplaybutton	boolean	If true, hides playbutton of an embedlink of type video in the video player
└ loop	boolean	If true, an embedlink of type video is continously looped in the video player
└ maxAutoQuality	boolean	If true, an embedlink of type video is set to maximum quality in the video player
└ muted	boolean	If true, an embedlink of type video is muted in the video player
└ noclick	boolean	If true, TBA
└ lock	boolean	If true, the embedlink is locked an cannot be changed
└ lockUser	integer	If lock is set, lockUser contains the ID of the user who created the lock
└ subtitle	object	Subtitle instructions for video player
└ default	integer	Default subtitle id for this embedlink
└ behaviour	integer	Pre-defined behaviour or the player. See below ⟨⟩ range: 0 to 4
└ lang	iso-639	Iso-639-2 language code
└ t	integer	If set, the player will start at that position (in seconds) ⟨⟩ range: 0 to 36000
└ tc	boolean	If true, time code is shown
└ delayTranscoding	integer	Only available in testmode
start	integer	Start time as unix timestamp for embedlink. Before this value the embedlink will not be delivered
type	string	Type of original media for this embedlink ≡ allowed values: videoimageaudiodocument

Embedlink create

POST/v6/embedlink/:mediaContainerId

Request Parameters

Field	Type	Required	Description
checkDuplicate	boolean	✗	if true, no new embedlink is created if mediacontainer, playerConfiguration, flag and origin are identical/existing.
description	string	✗	Description for embedlink
end	integer	✗	End time as unix timestamp for embedlink. After this value the embedlink will not be delivered
flag	integer	✗	Flag 0 is the default, active embedlink. Flag 10 is a hidden player (not visible to users) but can be accessed like flag 0 embedlink. Flag 10 cannot be used in destroy operation. ≡ allowed values: 010
mediaContainerId	integer	✓	mediaContainerId for this embedlink
origin	integer	✗	Origin 0 means, a user has created the embedlink. Origin 10 means the embedlink has been auto-created by an event. ≡ allowed values: 010
playerConfigurationId	integer	✓	Embedlink will be created with this playerConfigurationId
reactivate	boolean	✗	if true, an existing but deleted embedlink with identical origin and playerConfiguration will be re-activated
securitySettings	object	✗	SecuritySettings for embedlinks
└ auth	object	✗	Please use playerConfiguration for authentication settings.
└ 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
└ extAuth	object	✗	Please use playerConfiguration for authentication settings.
└ required	boolean	✗
└ allowedAccessKeys	array	✗
settings	object	✗	Settings for embedlink
└ autoplay	boolean	✗	Sets an embedlink of type video to autoplay
└ forceQuality	string	✗	Sets an embedlink of type video to a preset quality ≡ allowed values: lowmedhighhd
└ hideControls	boolean	✗	If true, hides controls of an embedlink of type video in the video player
└ hideplaybutton	boolean	✗	If true, hides playbutton of an embedlink of type video in the video player
└ loop	boolean	✗	If true, an embedlink of type video is continously looped in the video player
└ maxAutoQuality	boolean	✗	If true, an embedlink of type video is set to maximum quality in the video player
└ muted	boolean	✗	If true, an embedlink of type video is muted in the video player
└ noclick	boolean	✗	If true, TBA
└ lock	boolean	✗	If true, the embedlink is locked an cannot be changed
└ lockUser	integer	✗	If lock is set, lockUser contains the ID of the user who created the lock
└ subtitle	object	✗	Subtitle instructions for video player
└ default	integer	✗	Default subtitle id for this embedlink
└ behaviour	integer	✗	Pre-defined behaviour or the player. See below ⟨⟩ range: 0 to 4
└ lang	iso-639	✗	Iso-639-2 language code
└ t	integer	✗	If set, the player will start at that position (in seconds) ⟨⟩ range: 0 to 36000
└ tc	boolean	✗	If true, time code is shown
└ delayTranscoding	integer	✗	Only available in testmode
start	integer	✗	Start time as unix timestamp for embedlink. Before this value the embedlink will not be delivered

Response

Field	Type	Description
created	boolean	True, if the embedlink is newly created. Please check warnings to see, if the embedlink already existed.
creatorId	integer	ID of the user who created the embedlink
customerId	integer	ID of customer CustomerId will not be delivered with any API response in the future. It is determined from session.
description	string	Description for embedlink
embeds	array	Different embedformats for this embedlink
└ id	integer	Unique ID for this embedformat
└ title	string	Title for this embedformat
└ description	string	Description for this embedformat
└ contentType	string	Content-Type for this embedformat
└ code	string	Code snippet for this embedformat
end	integer	End time as unix timestamp for embedlink. After this value the embedlink will not be delivered
flag	integer	Flag 0 is the default, active embedlink. Flag 10 is a hidden player (not visible to users) but can be accessed like flag 0 embedlink. Flag 10 cannot be used in destroy operation. ≡ allowed values: 010
hasThumbnailVersions	boolean	TBA Do not use any longer.
id	integer	Unique identifier for this embedlink
lastEditorId	integer	ID of the user who last updated the embedlink
link	string	Unique link for this embedlink
mediaContainerId	integer	mediaContainerId for this embedlink
origin	integer	Origin 0 means, a user has created the embedlink. Origin 10 means the embedlink has been auto-created by an event. ≡ allowed values: 010
playerConfigurationId	integer	Embedlink will be created with this playerConfigurationId
securitySettings	object	SecuritySettings for embedlinks
└ auth	object	Please use playerConfiguration for authentication settings.
└ 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
└ extAuth	object	Please use playerConfiguration for authentication settings.
└ required	boolean
└ allowedAccessKeys	array
settings	object	Settings for embedlink
└ autoplay	boolean	Sets an embedlink of type video to autoplay
└ forceQuality	string	Sets an embedlink of type video to a preset quality ≡ allowed values: lowmedhighhd
└ hideControls	boolean	If true, hides controls of an embedlink of type video in the video player
└ hideplaybutton	boolean	If true, hides playbutton of an embedlink of type video in the video player
└ loop	boolean	If true, an embedlink of type video is continously looped in the video player
└ maxAutoQuality	boolean	If true, an embedlink of type video is set to maximum quality in the video player
└ muted	boolean	If true, an embedlink of type video is muted in the video player
└ noclick	boolean	If true, TBA
└ lock	boolean	If true, the embedlink is locked an cannot be changed
└ lockUser	integer	If lock is set, lockUser contains the ID of the user who created the lock
└ subtitle	object	Subtitle instructions for video player
└ default	integer	Default subtitle id for this embedlink
└ behaviour	integer	Pre-defined behaviour or the player. See below ⟨⟩ range: 0 to 4
└ lang	iso-639	Iso-639-2 language code
└ t	integer	If set, the player will start at that position (in seconds) ⟨⟩ range: 0 to 36000
└ tc	boolean	If true, time code is shown
└ delayTranscoding	integer	Only available in testmode
start	integer	Start time as unix timestamp for embedlink. Before this value the embedlink will not be delivered
type	string	Type of original media for this embedlink ≡ allowed values: videoimageaudiodocument

Embedlink update

PUT/v6/embedlink/:mediaContainerId/:embedId

Request Parameters

Field	Type	Required	Description
description	string	✗	Description for embedlink
embedId	integer	✓	Unique identifier (ID) for this embedlink
end	integer	✗	End time as unix timestamp for embedlink. After this value the embedlink will not be delivered
flag	integer	✗	Flag 0 is the default, active embedlink. Flag 10 is a hidden player (not visible to users) but can be accessed like flag 0 embedlink. Flag 10 cannot be used in destroy operation. ≡ allowed values: 010
mediaContainerId	integer	✓	mediaContainerId for this embedlink
playerConfigurationId	integer	✗	Embedlink will be created with this playerConfigurationId
securitySettings	object	✗	SecuritySettings for embedlinks
└ auth	object	✗	Please use playerConfiguration for authentication settings.
└ 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
└ extAuth	object	✗	Please use playerConfiguration for authentication settings.
└ required	boolean	✗
└ allowedAccessKeys	array	✗
settings	object	✗
└ autoplay	boolean	✗	Sets an embedlink of type video to autoplay
└ forceQuality	string	✗	Sets an embedlink of type video to a preset quality ≡ allowed values: lowmedhighhd
└ hideControls	boolean	✗	If true, hides controls of an embedlink of type video in the video player
└ hideplaybutton	boolean	✗	If true, hides playbutton of an embedlink of type video in the video player
└ loop	boolean	✗	If true, an embedlink of type video is continously looped in the video player
└ maxAutoQuality	boolean	✗	If true, an embedlink of type video is set to maximum quality in the video player
└ muted	boolean	✗	If true, an embedlink of type video is muted in the video player
└ noclick	boolean	✗	If true, TBA
└ lock	boolean	✗	If true, the embedlink is locked an cannot be changed
└ lockUser	integer	✗	If lock is set, lockUser contains the ID of the user who created the lock
└ subtitle	object	✗	Subtitle instructions for video player
└ default	integer	✗	Default subtitle id for this embedlink
└ behaviour	integer	✗	Pre-defined behaviour or the player. See below ⟨⟩ range: 0 to 4
└ lang	iso-639	✗	Iso-639-2 language code
└ t	integer	✗	If set, the player will start at that position (in seconds) ⟨⟩ range: 0 to 36000
└ tc	boolean	✗	If true, time code is shown
└ delayTranscoding	integer	✗	Only available in testmode
start	integer	✗	Start time as unix timestamp for embedlink. Before this value the embedlink will not be delivered

Response

Field	Type	Description
created	boolean	True, if the embedlink is newly created. Please check warnings to see, if the embedlink already existed.
creatorId	integer	ID of the user who created the embedlink
customerId	integer	ID of customer CustomerId will not be delivered with any API response in the future. It is determined from session.
description	string	Description for embedlink
embeds	array	Different embedformats for this embedlink
└ id	integer	Unique ID for this embedformat
└ title	string	Title for this embedformat
└ description	string	Description for this embedformat
└ contentType	string	Content-Type for this embedformat
└ code	string	Code snippet for this embedformat
end	integer	End time as unix timestamp for embedlink. After this value the embedlink will not be delivered
flag	integer	Flag 0 is the default, active embedlink. Flag 10 is a hidden player (not visible to users) but can be accessed like flag 0 embedlink. Flag 10 cannot be used in destroy operation. ≡ allowed values: 010
hasThumbnailVersions	boolean	TBA Do not use any longer.
id	integer	Unique identifier for this embedlink
lastEditorId	integer	ID of the user who last updated the embedlink
link	string	Unique link for this embedlink
mediaContainerId	integer	mediaContainerId for this embedlink
origin	integer	Origin 0 means, a user has created the embedlink. Origin 10 means the embedlink has been auto-created by an event. ≡ allowed values: 010
playerConfigurationId	integer	Embedlink will be created with this playerConfigurationId
securitySettings	object	SecuritySettings for embedlinks
└ auth	object	Please use playerConfiguration for authentication settings.
└ 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
└ extAuth	object	Please use playerConfiguration for authentication settings.
└ required	boolean
└ allowedAccessKeys	array
settings	object
└ autoplay	boolean	Sets an embedlink of type video to autoplay
└ forceQuality	string	Sets an embedlink of type video to a preset quality ≡ allowed values: lowmedhighhd
└ hideControls	boolean	If true, hides controls of an embedlink of type video in the video player
└ hideplaybutton	boolean	If true, hides playbutton of an embedlink of type video in the video player
└ loop	boolean	If true, an embedlink of type video is continously looped in the video player
└ maxAutoQuality	boolean	If true, an embedlink of type video is set to maximum quality in the video player
└ muted	boolean	If true, an embedlink of type video is muted in the video player
└ noclick	boolean	If true, TBA
└ lock	boolean	If true, the embedlink is locked an cannot be changed
└ lockUser	integer	If lock is set, lockUser contains the ID of the user who created the lock
└ subtitle	object	Subtitle instructions for video player
└ default	integer	Default subtitle id for this embedlink
└ behaviour	integer	Pre-defined behaviour or the player. See below ⟨⟩ range: 0 to 4
└ lang	iso-639	Iso-639-2 language code
└ t	integer	If set, the player will start at that position (in seconds) ⟨⟩ range: 0 to 36000
└ tc	boolean	If true, time code is shown
└ delayTranscoding	integer	Only available in testmode
start	integer	Start time as unix timestamp for embedlink. Before this value the embedlink will not be delivered
type	string	Type of original media for this embedlink ≡ allowed values: videoimageaudiodocument

Embedlink destroy

DELETE/v6/embedlink/:mediaContainerId/:embedId

Request Parameters

Field	Type	Required	Description
embedId	integer	✓	Unique identifier (ID) for this embedlink
flag	integer	✗	Flag 0 is the default, active embedlink. Flag 10 is a hidden player (not visible to users) but can be accessed like flag 0 embedlink. Flag 10 cannot be used in destroy operation. ≡ allowed values: 010

Response

Field	Type	Description
created	boolean	True, if the embedlink is newly created. Please check warnings to see, if the embedlink already existed.
creatorId	integer	ID of the user who created the embedlink
customerId	integer	ID of customer CustomerId will not be delivered with any API response in the future. It is determined from session.
description	string	Description for embedlink
embeds	array	Different embedformats for this embedlink
└ id	integer	Unique ID for this embedformat
└ title	string	Title for this embedformat
└ description	string	Description for this embedformat
└ contentType	string	Content-Type for this embedformat
└ code	string	Code snippet for this embedformat
end	integer	End time as unix timestamp for embedlink. After this value the embedlink will not be delivered
flag	integer	Flag 0 is the default, active embedlink. Flag 10 is a hidden player (not visible to users) but can be accessed like flag 0 embedlink. Flag 10 cannot be used in destroy operation. ≡ allowed values: 010
hasThumbnailVersions	boolean	TBA Do not use any longer.
id	integer	Unique identifier for this embedlink
lastEditorId	integer	ID of the user who last updated the embedlink
link	string	Unique link for this embedlink
mediaContainerId	integer	mediaContainerId for this embedlink
origin	integer	Origin 0 means, a user has created the embedlink. Origin 10 means the embedlink has been auto-created by an event. ≡ allowed values: 010
playerConfigurationId	integer	Embedlink will be created with this playerConfigurationId
securitySettings	object	SecuritySettings for embedlinks
└ auth	object	Please use playerConfiguration for authentication settings.
└ 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
└ extAuth	object	Please use playerConfiguration for authentication settings.
└ required	boolean
└ allowedAccessKeys	array
settings	object
└ autoplay	boolean	Sets an embedlink of type video to autoplay
└ forceQuality	string	Sets an embedlink of type video to a preset quality ≡ allowed values: lowmedhighhd
└ hideControls	boolean	If true, hides controls of an embedlink of type video in the video player
└ hideplaybutton	boolean	If true, hides playbutton of an embedlink of type video in the video player
└ loop	boolean	If true, an embedlink of type video is continously looped in the video player
└ maxAutoQuality	boolean	If true, an embedlink of type video is set to maximum quality in the video player
└ muted	boolean	If true, an embedlink of type video is muted in the video player
└ noclick	boolean	If true, TBA
└ lock	boolean	If true, the embedlink is locked an cannot be changed
└ lockUser	integer	If lock is set, lockUser contains the ID of the user who created the lock
└ subtitle	object	Subtitle instructions for video player
└ default	integer	Default subtitle id for this embedlink
└ behaviour	integer	Pre-defined behaviour or the player. See below ⟨⟩ range: 0 to 4
└ lang	iso-639	Iso-639-2 language code
└ t	integer	If set, the player will start at that position (in seconds) ⟨⟩ range: 0 to 36000
└ tc	boolean	If true, time code is shown
└ delayTranscoding	integer	Only available in testmode
start	integer	Start time as unix timestamp for embedlink. Before this value the embedlink will not be delivered
type	string	Type of original media for this embedlink ≡ allowed values: videoimageaudiodocument

API

Reference

Embedlink find

Embedlink create

Embedlink update

Embedlink destroy

Related Articles