Skip to main content

Player webhooks

player.*

player.created

  • Event for when a video player is created.
  • Event payload:
    {
    "data": {
    "AdAnnouncement": "Ad starting in ",
    "AdAnnouncementState": false,
    "AdAnnouncementTimeBeforeAd": 5,
    "AdsRequireInteraction": false,
    "Advertising": false,
    "AfterMidrollBacktrackState": false,
    "AfterMidrollBacktrackTime": 3,
    "Airplay": "Airplay",
    "AirplayButton": true,
    "AllowSeekOnLive": false,
    "AudioOnlyButton": false,
    "Auto": "Auto",
    "AutoCollapseAfterAds": false,
    "AutoPauseOnCuePointContinueUnMuted": false,
    "AutoPauseOnCuePointOnDesktop": false,
    "AutoPauseOnCuePointOnMobile": false,
    "AutoPauseOnCuePointPlayButtonUrl": "",
    "AutoPauseOnCuePointState": false,
    "AutoPauseOnCuePointTimeToPause": 0,
    "AutoPauseOnViewableOn": false,
    "AutoPauseOnViewablePercentage": 0.5,
    "AutoPauseWhenNotViewable": false,
    "AutoPlay": true,
    "AutoStartOnLoad": true,
    "AutoStartOnLoadMobile": false,
    "AutoStartOnLoadOnData": false,
    "AutoStartOnViewableMobile": false,
    "AutoStartOnViewableOn": false,
    "AutoStartOnViewableOnData": false,
    "AutoStartOnViewablePercentage": 0.5,
    "Autoplay": "Autoplay",
    "AutoplayOff": "Autoplay off",
    "AutoplayOn": "Autoplay on",
    "BigPlayButton": true,
    "CaptionsOff": "Captions off",
    "Casting": false,
    "ChannelUrl": "",
    "ChromeCastButton": true,
    "ChromeCastPlayingOn": "Chromecast playing",
    "Chromecast": "ChromeCast",
    "CloudHostedPlayerLibrary": "https://host.vpplayer.tech/xxxxxx/pxxxxxx.js",
    "CompanionAds": false,
    "CompanionAdsDivID": "string",
    "CompanionAdsHeight": 0,
    "CompanionAdsWidth": 0,
    "ContinueAfterPause": "Continue playing",
    "ContinueWatching": "Continue Watching",
    "ControlBarBackgroundColor": "FFFFFF00",
    "ControlBarGradientMidpoint": 50,
    "ControlBarIconsDefaultColor": "ffffff",
    "ControlBarIconsHoverColor": "ffffff",
    "ControlBarLoaderColor": "808080",
    "ControlBarSpreadOptionId": 1,
    "ControlBarTextColor": "ffffff",
    "ControlBarTimeSliderOnAdDraggerColor": "ffffff",
    "ControlBarTimeSliderOnAdProgressColor": "f5c338",
    "ControlBarTimeSliderOnAdRailColor": "808080",
    "ControlBarTimesliderBufferColor": "e2e2e2",
    "ControlBarTimesliderDraggerColor": "F26822",
    "ControlBarTimesliderProgressColor": "F26822",
    "ControlBarTimesliderRailColor": "FFFFFF80",
    "ControlBarVolumeDraggerColor": "ffffff",
    "ControlBarVolumeNotifierColor": "0000004d",
    "ControlBarVolumeProgressColor": "ffffff",
    "ControlBarVolumeRailColor": "9f9f9f",
    "CountDownMessage": "string",
    "CueText": "string",
    "Debug": false,
    "DefaultBandwidthEstimateOption": {
    "Id": 1,
    "Name": "None",
    "Value": "0"
    },
    "DefaultBandwidthEstimateOptionId": 1,
    "DelayLiveVideos": false,
    "DelayLiveVideosTime": 0,
    "Dismiss": "Dismiss",
    "DispAdverisementAbove": false,
    "EnableGravityChange": false,
    "EnableHapticFeedbackOnButtonClick": false,
    "EnableHapticFeedbackOnPinchToZoom": false,
    "EnablePlayBackRateControls": true,
    "FloatDismissible": false,
    "FloatOnMobile": false,
    "FloatOnScroll": false,
    "FloatPositionOption": {
    "Id": 1,
    "Name": "Top right (default)",
    "Value": "TOP_RIGHT"
    },
    "FloatPositionOptionId": 1,
    "FloatRequiresInteraction": false,
    "FloatWidth": "340",
    "FocusOnAutoStart": false,
    "ForceSound": false,
    "FullScreen": "FullScreen",
    "FullScreenButton": true,
    "GeoBlockedDescription": "Unfortunately, the publisher has not made this video available in your country.",
    "GeoBlockedTitle": "Video not available in your country.",
    "GoogleAnalytics": false,
    "Height": 360,
    "HelperButtonImageUrl": "",
    "HighlightCurrentVideo": false,
    "IncludeCompatibilityScript": false,
    "Info": "Info",
    "KeepVisibleWhenControlsHidden": false,
    "Live": "Live",
    "LogoDefaultOpacity": 1,
    "LogoInactiveOpacity": 0.5,
    "LogoOn": false,
    "LogoOnClickUrl": "",
    "LogoPositionOption": {
    "Id": 1,
    "Name": "Top right (default)",
    "Value": "TOP_RIGHT"
    },
    "LogoPositionOptionId": 1,
    "LogoUrl": "",
    "LoopContent": false,
    "MenuAutoplayOffColor": "a7a7a7",
    "MenuAutoplayOnColor": "cc0000",
    "MenuBackroundDefaultColor": "1c1c1cb3",
    "MenuBackroundHoverColor": "00000080",
    "MenuLinksDefaultColor": "ffffff",
    "MenuLinksHoverColor": "F26822",
    "Mute": "Mute",
    "MuteOnStart": true,
    "Name": "Untitled Player test1",
    "Next": "Next",
    "NextButton": true,
    "NextVideoBackgroundColor": "2e2e2e",
    "NextVideoCancel": "Cancel",
    "NextVideoCancelBackgroundColor": "FFFFFF",
    "NextVideoCancelTextColor": "000000",
    "NextVideoIconsPlayDefaultColor": "FFFFFF",
    "NextVideoIconsPlayHoverColor": "FFFFFF",
    "NextVideoPlayNowBackgroundColor": "FFFFFF",
    "NextVideoPlayNowTextColor": "000000",
    "NextVideoTextColor": "FFFFFF",
    "NextVideoTsIconsCloseColor": "FFFFFF",
    "NextVideoTsProgressColor": "FFFFFF",
    "NextVideoTsRailColor": "000000",
    "Normal": "Normal",
    "Off": "Off",
    "OnHoverPlay": false,
    "OriginalZoom": "Original Zoom",
    "OutstreamPlayer": false,
    "Pause": "Pause",
    "PauseOtherVideos": true,
    "PauseWhenRelatedIsShown": false,
    "PictureInPicture": "Picture In Picture",
    "PictureInPictureButton": false,
    "Play": "Play",
    "PlayAdsMuted": true,
    "PlayNow": "Play Now",
    "PlaybackErrorDescription": "Unfortunately, this video could not be played at this moment.",
    "PlaybackErrorTitle": "There was a problem playing this video.",
    "PlaybackRate": "Playback Rate",
    "PlayerSizeType": {
    "Id": 1,
    "Name": "Responsive"
    },
    "PlayerSizeTypeId": 1,
    "PlaylistBackgroundColor": "1c1c1cb3",
    "PlaylistCardBackgroundColor": "1c1c1cb3",
    "PlaylistCardDurationBackgroundColor": "1a1a1a80",
    "PlaylistCardDurationTextColor": "FFFFFF",
    "PlaylistCardIconPlayDefaulColor": "FFFFFF",
    "PlaylistCardIconPlayHoverColor": "FFFFFF",
    "PlaylistCardTitleColor": "FFFFFF",
    "PlaylistIconsArrActiveColor": "FFFFFF",
    "PlaylistIconsArrInactiveColor": "666666",
    "PlaylistIconsCloseColor": "FFFFFF",
    "PlaylistTextColor": "FFFFFF",
    "PreloadAds": false,
    "PreloadOption": {
    "Id": 2,
    "Name": "Quick Start (default)",
    "TooltipText": "For the fastest startup time. When the player becomes viewable or if it's the only player on the embedded page, the player will load the media's metadata and up to one segment.",
    "Value": "metadata"
    },
    "PreloadOptionId": 2,
    "PublicId": "pxxxxxx",
    "Quality": "Quality",
    "ReadQualities": false,
    "Recommendation": false,
    "ReleaseChannel": {
    "Id": 205,
    "Name": "v2.0.4",
    "OriginalPath": "xxxxxx/v2.0.4/xxxxxx.js",
    "TemplateOriginalPath": "https://host.vpplayer.tech/xxxxxx/v2.0.4/xxxxxx.js"
    },
    "ReleaseChannelId": 205,
    "Replay": "Replay",
    "ResponsiveSizeOption": {
    "Height": 9,
    "Id": 1,
    "Name": "16:9",
    "Width": 16
    },
    "ResponsiveSizeOptionId": 1,
    "SeekLiveAfterPause": false,
    "Settings": "Settings",
    "SettingsButton": true,
    "Share": "Share Audio",
    "ShareButton": false,
    "Sharing": false,
    "ShowAutoPlay": false,
    "ShowContentDescription": true,
    "ShowContentTitle": true,
    "ShowControls": true,
    "ShowControlsOnVPAID": false,
    "ShowHelperButton": false,
    "ShowLiveIcon": false,
    "ShowPlayerControlsDuringVideoAdvertisement": false,
    "ShowQualities": false,
    "ShowSubtitles": false,
    "SimultaneousAds": "Simultaneous Ads",
    "Skip": "Skip",
    "SkipAmount": 1,
    "SkipCountDown": "string",
    "SkipIn": "SkipIn",
    "SkipIntro": "Skip Intro",
    "SocialNetworkIds": [],
    "StreamInterruptedDescription": "Something went wrong. Try refreshing the page.",
    "StreamInterruptedTitle": "Livestream is interrupted",
    "Subtitles": "Subtitles",
    "Theater": "Theater",
    "TheaterButton": true,
    "TooltipsBackroundColor": "ffffff00",
    "TooltipsTextColor": "ffffff00",
    "UnMute": "Unmute",
    "UpNext": "Up Next",
    "Visit": "Visit",
    "Volume": 0.5,
    "VolumeButton": true,
    "VolumeText": "Volume",
    "Width": 640,
    "ZoomIn": "Zoom in",
    "ZoomOut": "Zoom out"
    },
    "eventTime": "2023-10-19T11:21:35.3993315Z",
    "eventType": "player.created"
    }

player.updated

  • Event for when a video player is updated.
  • Event payload:
    {
    "data": {
    "AdAnnouncement": "Ad starting in ",
    "AdAnnouncementState": false,
    "AdAnnouncementTimeBeforeAd": 5,
    "AdsRequireInteraction": false,
    "Advertising": false,
    "AfterMidrollBacktrackState": false,
    "AfterMidrollBacktrackTime": 3,
    "Airplay": "Airplay",
    "AirplayButton": true,
    "AllowSeekOnLive": false,
    "AudioOnlyButton": false,
    "Auto": "Auto",
    "AutoCollapseAfterAds": false,
    "AutoPauseOnCuePointContinueUnMuted": false,
    "AutoPauseOnCuePointOnDesktop": false,
    "AutoPauseOnCuePointOnMobile": false,
    "AutoPauseOnCuePointPlayButtonUrl": "",
    "AutoPauseOnCuePointState": false,
    "AutoPauseOnCuePointTimeToPause": 0,
    "AutoPauseOnViewableOn": false,
    "AutoPauseOnViewablePercentage": 0.5,
    "AutoPauseWhenNotViewable": false,
    "AutoPlay": true,
    "AutoStartOnLoad": true,
    "AutoStartOnLoadMobile": false,
    "AutoStartOnLoadOnData": false,
    "AutoStartOnViewableMobile": false,
    "AutoStartOnViewableOn": false,
    "AutoStartOnViewableOnData": false,
    "AutoStartOnViewablePercentage": 0.5,
    "Autoplay": "Autoplay",
    "AutoplayOff": "Autoplay off",
    "AutoplayOn": "Autoplay on",
    "BigPlayButton": true,
    "CaptionsOff": "Captions off",
    "Casting": false,
    "ChannelUrl": "",
    "ChromeCastButton": true,
    "ChromeCastPlayingOn": "Chromecast playing",
    "Chromecast": "ChromeCast",
    "CloudHostedPlayerLibrary": "https://host.vpplayer.tech/xxxxxx/pxxxxxx.js",
    "CompanionAds": false,
    "CompanionAdsDivID": "string",
    "CompanionAdsHeight": 0,
    "CompanionAdsWidth": 0,
    "ContinueAfterPause": "Continue playing",
    "ContinueWatching": "Continue Watching",
    "ControlBarBackgroundColor": "FFFFFF00",
    "ControlBarGradientMidpoint": 50,
    "ControlBarIconsDefaultColor": "ffffff",
    "ControlBarIconsHoverColor": "ffffff",
    "ControlBarLoaderColor": "808080",
    "ControlBarSpreadOptionId": 1,
    "ControlBarTextColor": "ffffff",
    "ControlBarTimeSliderOnAdDraggerColor": "ffffff",
    "ControlBarTimeSliderOnAdProgressColor": "f5c338",
    "ControlBarTimeSliderOnAdRailColor": "808080",
    "ControlBarTimesliderBufferColor": "e2e2e2",
    "ControlBarTimesliderDraggerColor": "F26822",
    "ControlBarTimesliderProgressColor": "F26822",
    "ControlBarTimesliderRailColor": "FFFFFF80",
    "ControlBarVolumeDraggerColor": "ffffff",
    "ControlBarVolumeNotifierColor": "0000004d",
    "ControlBarVolumeProgressColor": "ffffff",
    "ControlBarVolumeRailColor": "9f9f9f",
    "CountDownMessage": "string",
    "CueText": "string",
    "Debug": false,
    "DefaultBandwidthEstimateOption": {
    "Id": 1,
    "Name": "None",
    "Value": "0"
    },
    "DefaultBandwidthEstimateOptionId": 1,
    "DelayLiveVideos": false,
    "DelayLiveVideosTime": 0,
    "Dismiss": "Dismiss",
    "DispAdverisementAbove": false,
    "EnableGravityChange": false,
    "EnableHapticFeedbackOnButtonClick": false,
    "EnableHapticFeedbackOnPinchToZoom": false,
    "EnablePlayBackRateControls": true,
    "FloatDismissible": false,
    "FloatOnMobile": false,
    "FloatOnScroll": false,
    "FloatPositionOption": {
    "Id": 1,
    "Name": "Top right (default)",
    "Value": "TOP_RIGHT"
    },
    "FloatPositionOptionId": 1,
    "FloatRequiresInteraction": false,
    "FloatWidth": "340",
    "FocusOnAutoStart": false,
    "ForceSound": false,
    "FullScreen": "FullScreen",
    "FullScreenButton": true,
    "GeoBlockedDescription": "Unfortunately, the publisher has not made this video available in your country.",
    "GeoBlockedTitle": "Video not available in your country.",
    "GoogleAnalytics": false,
    "Height": 360,
    "HelperButtonImageUrl": "",
    "HighlightCurrentVideo": false,
    "IncludeCompatibilityScript": false,
    "Info": "Info",
    "KeepVisibleWhenControlsHidden": false,
    "Live": "Live",
    "LogoDefaultOpacity": 1,
    "LogoInactiveOpacity": 0.5,
    "LogoOn": false,
    "LogoOnClickUrl": "",
    "LogoPositionOption": {
    "Id": 1,
    "Name": "Top right (default)",
    "Value": "TOP_RIGHT"
    },
    "LogoPositionOptionId": 1,
    "LogoUrl": "",
    "LoopContent": false,
    "MenuAutoplayOffColor": "a7a7a7",
    "MenuAutoplayOnColor": "cc0000",
    "MenuBackroundDefaultColor": "1c1c1cb3",
    "MenuBackroundHoverColor": "00000080",
    "MenuLinksDefaultColor": "ffffff",
    "MenuLinksHoverColor": "F26822",
    "Mute": "Mute",
    "MuteOnStart": true,
    "Name": "Untitled Player test1 update",
    "Next": "Next",
    "NextButton": true,
    "NextVideoBackgroundColor": "2e2e2e",
    "NextVideoCancel": "Cancel",
    "NextVideoCancelBackgroundColor": "FFFFFF",
    "NextVideoCancelTextColor": "000000",
    "NextVideoIconsPlayDefaultColor": "FFFFFF",
    "NextVideoIconsPlayHoverColor": "FFFFFF",
    "NextVideoPlayNowBackgroundColor": "FFFFFF",
    "NextVideoPlayNowTextColor": "000000",
    "NextVideoTextColor": "FFFFFF",
    "NextVideoTsIconsCloseColor": "FFFFFF",
    "NextVideoTsProgressColor": "FFFFFF",
    "NextVideoTsRailColor": "000000",
    "Normal": "Normal",
    "Off": "Off",
    "OnHoverPlay": false,
    "OriginalZoom": "Original Zoom",
    "OutstreamPlayer": false,
    "Pause": "Pause",
    "PauseOtherVideos": true,
    "PauseWhenRelatedIsShown": false,
    "PictureInPicture": "Picture In Picture",
    "PictureInPictureButton": false,
    "Play": "Play",
    "PlayAdsMuted": true,
    "PlayNow": "Play Now",
    "PlaybackErrorDescription": "Unfortunately, this video could not be played at this moment.",
    "PlaybackErrorTitle": "There was a problem playing this video.",
    "PlaybackRate": "Playback Rate",
    "PlayerSizeType": {
    "Id": 1,
    "Name": "Responsive"
    },
    "PlayerSizeTypeId": 1,
    "PlaylistBackgroundColor": "1c1c1cb3",
    "PlaylistCardBackgroundColor": "1c1c1cb3",
    "PlaylistCardDurationBackgroundColor": "1a1a1a80",
    "PlaylistCardDurationTextColor": "FFFFFF",
    "PlaylistCardIconPlayDefaulColor": "FFFFFF",
    "PlaylistCardIconPlayHoverColor": "FFFFFF",
    "PlaylistCardTitleColor": "FFFFFF",
    "PlaylistIconsArrActiveColor": "FFFFFF",
    "PlaylistIconsArrInactiveColor": "666666",
    "PlaylistIconsCloseColor": "FFFFFF",
    "PlaylistTextColor": "FFFFFF",
    "PreloadAds": false,
    "PreloadOption": {
    "Id": 2,
    "Name": "Quick Start (default)",
    "TooltipText": "For the fastest startup time. When the player becomes viewable or if it's the only player on the embedded page, the player will load the media's metadata and up to one segment.",
    "Value": "metadata"
    },
    "PreloadOptionId": 2,
    "PublicId": "ptkzursk",
    "Quality": "Quality",
    "ReadQualities": false,
    "Recommendation": false,
    "ReleaseChannel": {
    "Id": 201,
    "Name": "v2.0",
    "OriginalPath": "xxxxxx/v2.0/pxxxxxx.js",
    "TemplateOriginalPath": "https://host.vpplayer.tech/xxxxxx/v2.0/xxxxxx.js"
    },
    "ReleaseChannelId": 201,
    "Replay": "Replay",
    "ResponsiveSizeOption": {
    "Height": 9,
    "Id": 1,
    "Name": "16:9",
    "Width": 16
    },
    "ResponsiveSizeOptionId": 1,
    "SeekLiveAfterPause": false,
    "Settings": "Settings",
    "SettingsButton": true,
    "Share": "Share Audio",
    "ShareButton": false,
    "Sharing": false,
    "ShowAutoPlay": false,
    "ShowContentDescription": true,
    "ShowContentTitle": true,
    "ShowControls": true,
    "ShowControlsOnVPAID": false,
    "ShowHelperButton": false,
    "ShowLiveIcon": false,
    "ShowPlayerControlsDuringVideoAdvertisement": false,
    "ShowQualities": false,
    "ShowSubtitles": false,
    "SimultaneousAds": "Simultaneous Ads",
    "Skip": "Skip",
    "SkipAmount": 1,
    "SkipCountDown": "string",
    "SkipIn": "SkipIn",
    "SkipIntro": "Skip Intro",
    "SocialNetworkIds": [],
    "StreamInterruptedDescription": "Something went wrong. Try refreshing the page.",
    "StreamInterruptedTitle": "Livestream is interrupted",
    "Subtitles": "Subtitles",
    "Theater": "Theater",
    "TheaterButton": true,
    "TooltipsBackroundColor": "ffffff00",
    "TooltipsTextColor": "ffffff00",
    "UnMute": "Unmute",
    "UpNext": "Up Next",
    "Visit": "Visit",
    "Volume": 0.5,
    "VolumeButton": true,
    "VolumeText": "Volume",
    "Width": 640,
    "ZoomIn": "Zoom in",
    "ZoomOut": "Zoom out"
    },
    "eventTime": "2023-10-19T11:22:49.2850436Z",
    "eventType": "player.updated"
    }

player.deleted

  • Event for when a video player has been deleted.
  • Event payload:
    {
    "data": {
    "Id": "pxxxxxx",
    "Name": "Untitled Player"
    },
    "eventTime": "2023-10-19T11:24:52.0203903Z",
    "eventType": "player.deleted"
    }

player.version.changed

  • Event for when a video player’s version has changed.
  • Event payload:
    {
    "data": {
    "Id": "pxxxxxx",
    "ReleaseChannelId": 201,
    "ReleaseChannelName": "v2.0"
    },
    "eventTime": "2023-10-19T11:22:49.2490786Z",
    "eventType": "player.version.changed"
    }

audio.player.*

audio.player.created

  • Event for when an audio player is created.
  • Event payload:
    {
    "data": {
    "Advertising": false,
    "Airplay": "Airplay",
    "AirplayButton": true,
    "AudioSocialNetworkIds": [],
    "Auto": "Auto",
    "AutoPauseOnCuePointContinueUnMuted": false,
    "AutoPauseOnCuePointOn": false,
    "AutoPauseOnCuePointOnDesktop": false,
    "AutoPauseOnCuePointOnMobile": false,
    "AutoPauseOnCuePointTimeToPause": 0,
    "AutoPauseOnViewableOn": false,
    "AutoPauseOnViewablePercentage": 0.5,
    "AutoPlay": true,
    "AutoStartOnViewableMobile": false,
    "AutoStartOnViewableOn": false,
    "AutoStartOnViewableOnData": false,
    "AutoStartOnViewablePercentage": 0.5,
    "Autoplay": "Autoplay",
    "BackgroundBlur": false,
    "BackgroundBorderColor": "FFFFFF",
    "BackgroundBorderWidth": 0,
    "BackgroundGradient": false,
    "BackgroundPrimaryColor": "011030",
    "BackgroundSecondaryColor": "EA622B",
    "BackgroundUseThumbnail": false,
    "Casting": false,
    "ChromeCast": "ChromeCast",
    "ChromeCastButton": true,
    "CloudHostedPlayerLibrary": "https://host.vpplayer.tech/xxxxxxx/xxxxxx.js",
    "ElementsAuthorColor": "FFFFFF",
    "ElementsDefaultColor": "FFFFFF",
    "ElementsDescriptionColor": "FFFFFF",
    "ElementsDividersColor": "FFFFFF",
    "ElementsDraggerColor": "FFFFFF",
    "ElementsItemColor": "FFFFFF",
    "ElementsItemsProgressColor": "FFFFFF",
    "ElementsListButtonColor": "FFFFFF",
    "ElementsListButtonOn": true,
    "ElementsLogoColor": "",
    "ElementsNextPrevButtonColor": "FFFFFF",
    "ElementsNextPrevButtonOn": true,
    "ElementsPlaybackButtonColor": "FFFFFF",
    "ElementsPlaylistColor": "011030",
    "ElementsPrimaryColor": "FFFFFF",
    "ElementsSecondaryColor": "FFFFFF",
    "ElementsSettingsButtonColor": "FFFFFF",
    "ElementsSettingsButtonOn": true,
    "ElementsSkipButtonColor": "FFFFFF",
    "ElementsSkipButtonOn": true,
    "ElementsSliderProgressBarColor": "EA622B",
    "ElementsSliderRailColor": "FFFFFF",
    "ElementsTimeInfoColor": "FFFFFF",
    "ElementsTitleColor": "FFFFFF",
    "ElementsVolumeButtonColor": "FFFFFF",
    "ElementsVolumeButtonOn": true,
    "EnablePlayBackRateControls": true,
    "FloatDismissible": false,
    "FloatOnMobile": false,
    "FloatOnScroll": false,
    "FloatPositionOptionId": 1,
    "FloatRequiresInteraction": false,
    "FloatWidth": 340,
    "FocusOnAutoStart": false,
    "GradientDirectionOptionId": 1,
    "HighligshtCurrentAudio": false,
    "JumpBackAfterMidrollOn": false,
    "JumpBackAfterMidrollTime": 3,
    "LogoOn": false,
    "LogoOnClickUrl": "",
    "LogoUrl": "",
    "LoopContent": false,
    "MenuBackgroundDefaultColor": "011030",
    "MenuTextDefaultColor": "FFFFFF",
    "MenuToggleDefaultColor": "FFFFFF",
    "MenuToggleOffColor": "CACACA",
    "MenuToggleOnColor": "206ED5",
    "Mute": "Mute",
    "Name": "Untitled Player",
    "Next": "Next",
    "Normal": "Normal",
    "Off": "Off",
    "Pause": "Pause",
    "PauseOtherAudios": true,
    "Play": "Play",
    "PlaybackSpeed": "Speed",
    "PlayerTypeId": 2,
    "Playlist": "Continue Listening",
    "PodcastId": 0,
    "PublicId": "mbjpvhlkt",
    "Quality": "Quality",
    "ReadQualities": false,
    "Recommendation": false,
    "ReleaseChannelId": 1,
    "Replay": "Replay",
    "ResponsiveSize": 100,
    "Settings": "Settings",
    "Share": "Share Audio",
    "ShareButton": false,
    "Sharing": false,
    "ShowAutoPlay": false,
    "ShowContentDescription": true,
    "ShowContentTitle": true,
    "ShowControls": false,
    "ShowHelperButton": false,
    "ShowPodcastTitle": false,
    "ShowQualities": false,
    "SkipAmount": 1,
    "UnMute": "Unmute",
    "Volume": 0.5,
    "VolumeText": "Volume"
    },
    "eventTime": "2023-10-19T11:26:55.0288332Z",
    "eventType": "audio.player.created"
    }

audio.player.updated

  • Event for when an audio player was updated.
  • Event payload:
    {
    "data": {
    "Advertising": false,
    "Airplay": "Airplay",
    "AirplayButton": true,
    "AudioSocialNetworkIds": [],
    "Auto": "Auto",
    "AutoPauseOnCuePointContinueUnMuted": false,
    "AutoPauseOnCuePointOn": false,
    "AutoPauseOnCuePointOnDesktop": false,
    "AutoPauseOnCuePointOnMobile": false,
    "AutoPauseOnCuePointTimeToPause": 0,
    "AutoPauseOnViewableOn": false,
    "AutoPauseOnViewablePercentage": 0.5,
    "AutoPlay": true,
    "AutoStartOnViewableMobile": false,
    "AutoStartOnViewableOn": false,
    "AutoStartOnViewableOnData": false,
    "AutoStartOnViewablePercentage": 0.5,
    "Autoplay": "Autoplay",
    "BackgroundBlur": false,
    "BackgroundBorderColor": "FFFFFF",
    "BackgroundBorderWidth": 0,
    "BackgroundGradient": false,
    "BackgroundPrimaryColor": "011030",
    "BackgroundSecondaryColor": "EA622B",
    "BackgroundUseThumbnail": false,
    "Casting": false,
    "ChromeCast": "Chromecast",
    "ChromeCastButton": true,
    "CloudHostedPlayerLibrary": "https://host.vpplayer.tech/xxxxxx/xxxxx.js",
    "ElementsAuthorColor": "FFFFFF",
    "ElementsDefaultColor": "FFFFFF",
    "ElementsDescriptionColor": "FFFFFF",
    "ElementsDividersColor": "FFFFFF",
    "ElementsDraggerColor": "FFFFFF",
    "ElementsItemColor": "FFFFFF",
    "ElementsItemsProgressColor": "FFFFFF",
    "ElementsListButtonColor": "FFFFFF",
    "ElementsListButtonOn": true,
    "ElementsLogoColor": "",
    "ElementsNextPrevButtonColor": "FFFFFF",
    "ElementsNextPrevButtonOn": true,
    "ElementsPlaybackButtonColor": "FFFFFF",
    "ElementsPlaylistColor": "011030",
    "ElementsPrimaryColor": "FFFFFF",
    "ElementsSecondaryColor": "FFFFFF",
    "ElementsSettingsButtonColor": "FFFFFF",
    "ElementsSettingsButtonOn": true,
    "ElementsSkipButtonColor": "FFFFFF",
    "ElementsSkipButtonOn": true,
    "ElementsSliderProgressBarColor": "EA622B",
    "ElementsSliderRailColor": "FFFFFF",
    "ElementsTimeInfoColor": "FFFFFF",
    "ElementsTitleColor": "FFFFFF",
    "ElementsVolumeButtonColor": "FFFFFF",
    "ElementsVolumeButtonOn": true,
    "EnablePlayBackRateControls": true,
    "FloatDismissible": false,
    "FloatOnMobile": false,
    "FloatOnScroll": false,
    "FloatPositionOption": {
    "Id": 1,
    "Name": "Top Right",
    "Value": "TOP_RIGHT"
    },
    "FloatPositionOptionId": 1,
    "FloatRequiresInteraction": false,
    "FloatWidth": 340,
    "FocusOnAutoStart": false,
    "GradientDirectionOptionId": 1,
    "HighligshtCurrentAudio": false,
    "JumpBackAfterMidrollOn": false,
    "JumpBackAfterMidrollTime": 3,
    "LogoOn": false,
    "LogoOnClickUrl": "",
    "LogoUrl": "",
    "LoopContent": false,
    "MenuBackgroundDefaultColor": "011030",
    "MenuTextDefaultColor": "FFFFFF",
    "MenuToggleDefaultColor": "FFFFFF",
    "MenuToggleOffColor": "CACACA",
    "MenuToggleOnColor": "206ED5",
    "Mute": "Mute",
    "Name": "Untitled Player update",
    "Next": "Next",
    "Normal": "Normal",
    "Off": "Off",
    "Pause": "Pause",
    "PauseOtherAudios": true,
    "Play": "Play",
    "PlaybackSpeed": "Speed",
    "PlayerType": {
    "Id": 2,
    "Name": "Thumbnail Player",
    "Value": "THUMBNAIL_PLAYER"
    },
    "PlayerTypeId": 2,
    "Playlist": "Continue Listening",
    "PodcastId": 0,
    "PublicId": "mbjpvhlkt",
    "Quality": "Quality",
    "ReadQualities": false,
    "Recommendation": false,
    "ReleaseChannel": {
    "Id": 1,
    "Name": "v1.0",
    "OriginalPath": "audio-player/v1.0/vpplayer-audio.js",
    "TemplateOriginalPath": "https://host.vpplayer.tech/xxxxxxxx/v1.0/xxxxxx.js"
    },
    "ReleaseChannelId": 1,
    "Replay": "Replay",
    "ResponsiveSize": 100,
    "Settings": "Settings",
    "Share": "Share Audio",
    "ShareButton": false,
    "Sharing": false,
    "ShowAutoPlay": false,
    "ShowContentDescription": true,
    "ShowContentTitle": true,
    "ShowControls": false,
    "ShowHelperButton": false,
    "ShowPodcastTitle": false,
    "ShowQualities": false,
    "SkipAmount": 1,
    "UnMute": "Unmute",
    "Volume": 0.5,
    "VolumeText": "Volume"
    },
    "eventTime": "2023-10-19T11:28:53.0789602Z",
    "eventType": "audio.player.updated"
    }

audio.player.deleted

  • Event for when an audio player has been deleted.
  • Event payload:
    {
    "data": {
    "Id": "xxxxxx",
    "Name": "Untitled Player update"
    },
    "eventTime": "2023-10-19T11:30:02.5670216Z",
    "eventType": "audio.player.deleted"
    }

audio.player.version.changed

  • Event for when an audio player’s version has changed.
  • Event payload:
    {
    "data": {
    "Id": "xxxxxxx",
    "ReleaseChannelId": 201,
    "ReleaseChannelName": "v2.0"
    },
    "eventTime": "2023-10-19T11:22:49.2490786Z",
    "eventType": "audio.player.version.changed"
    }