API method mapping for Web SDK

Review a table representing an API method mapping for Web SDK.

AMP1 methodAMP2 methodStatusMigration example
play()play()✓ CompatibleDirect mapping, both return Promise
pause()pause()✓ CompatibleDirect mapping, both return Promise
load()load(source)AlternativeAMP1 reloads current media, AMP2 requires source
seek(value)seek(value)✓ CompatibleDirect mapping, both return Promise
replay()N/AAlternativeUse seek(0) then play()
end()N/AAlternativeUse pause() and seek to end
mute()mute()✓ CompatibleDirect mapping
unmute()unmute()✓ CompatibleDirect mapping
enterFullScreen()setViewMode(fullscreenElement)AlternativeEnter full screen method available via API
exitFullScreen()setViewMode(Inline|Fullscreen|PictureInPicture)AlternativeExit full screen method available via API
enterPictureInPicture()setViewMode(Inline|Fullscreen|PictureInPicture)AlternativePiP available in Bitmovin Player API via method
exitPictureInPicture()setViewMode(Inline|Fullscreen|PictureInPicture)AlternativePiP available in Bitmovin Player API via method
goLive()N/AAlternativeUse seek to live edge in Bitmovin
addEventListener(type, func)on(type, func)AlternativeDifferent method name, same functionality
removeEventListener(type, func)off(type, func)AlternativeDifferent method name, same functionality
addListener()on()AlternativeAlias for addEventListener
removeListener()off()AlternativeAlias for removeEventListener
once(type, func)N/AAlternativeImplement with regular listener and removeEventListener
dispatch(type, detail)N/A✗ MissingCustom event dispatching not available
dispatchEvent(event)N/A✗ MissingCustom event dispatching not available
emit(type, detail)N/A✗ MissingAlias for dispatch, not available
destroy()destroy()✓ CompatibleDirect mapping, both return Promise
canPlayType(type)N/A✗ MissingUse browser's native canPlayType
loadResources(resources, callback)N/A✗ MissingResource loading handled differently
request(options)N/A✗ MissingUse standard fetch or XMLHttpRequest
getLocalizedString(value, context)N/AAlternativeHandle localization through an UI config
evaluateBindings(binding)N/A✗ MissingTemplate binding not available
fromUTC(value)N/A✗ MissingTime conversion utilities not provided
toUTC(value)N/A✗ MissingTime conversion utilities not provided
addTransform(type, transform)N/A✗ MissingTransform system not available
removeTransform(type, transform)N/A✗ MissingTransform system not available
sortTransforms(type, sort)N/A✗ MissingTransform system not available
transform(type, value)N/A✗ MissingTransform system not available
recordContentChange(content)N/A✗ MissingAnalytics handled differently

Did this page help you?