WIwistia
Customizations

Update Playback Customizations

Changed on

Applies a partial update to a video's playback customizations. Only the fields supplied are changed; sending a field as null deletes it (reverting to the default).

Requires api token with one of the following permissions

Read, update & delete anything

Tokens with the "Act with a team member's permissions" permission (all:delegate_to_contact_permissions scope) can also be used. Requests made with such a token are authorized using the permissions of the contact assigned to the token.

An expiring access token created with the all:delegate_to_contact_permissions scope and an authorization granting the edit permission on this media can also be used.

put/medias/{mediaId}/customizations/playback

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/medias/{mediaId}/customizations/playback
  • Auth
    HTTP bearer

Path parameters

mediaIdstring required

The hashed ID of the video to be customized.

Headers

X-Wistia-API-Versionstring required

Request body

autoPlayboolean

If set to true, the video will play as soon as it’s ready. Note that autoplay might not work on some devices and browsers.

silentAutoPlaystring

Determines how videos handle autoplay in contexts where normal autoplay might be blocked. Options are "true", "allow", and "false".

mutedboolean

If set to true, the video will start in a muted state.

volumenumber

Sets the volume of the video.

controlsVisibleOnLoadboolean

If set to true, controls like the big play button, playbar, volume, etc. will be visible as soon as the video is embedded.

playButtonboolean

Indicates if the play button is visible.

smallPlayButtonboolean

If set to true, the small play button control is shown.

playbarboolean

If set to true, the playbar will be available. If set to false, it will be hidden.

volumeControlboolean

When set to true, a volume control is available over the video.

fullscreenButtonboolean

If set to true, the fullscreen button will be available as a video control.

settingsControlboolean

If set to true, the settings control will be available.

playbackRateControlboolean

If set to false, the playback speed controls in the settings menu will be hidden.

qualityControlboolean

If set to false, the video quality selector in the settings menu will be hidden.

qualityMininteger

Specifies the minimum quality the video will play at.

qualityMaxinteger

Specifies the maximum quality the video will play at.

videoQualitystring

Sets the default video quality the video will play at.

hlsboolean

If set to true, HLS adaptive bitrate streaming is enabled.

endVideoBehaviorstring

Determines what happens when the video ends. Options are "default" (stays on the last frame), "reset" (shows thumbnail and controls), and "loop" (plays again from the start).

playsinlineboolean

If set to false, videos will play within the native mobile player.

playlistLoopboolean

If set to true and this video has a playlist, it will loop back to the first video after the last one has finished.

playlistLinksboolean

Enables the use of specially crafted links on the page to associate with a video, turning them into a playlist.

playPauseNotifierboolean

If set to false, animations for the Pause and Play symbols will be removed.

playSuspendedOffScreenboolean

If set to false for a muted autoplay video, the video won’t pause when out of view.

resumablestring

Determines if the video should resume from where the viewer left off. Options are "true", "false", and "auto".

preloadstring

Sets the video’s preload property. Possible values are metadata, auto, none, true, and false.

timestring

Sets the starting time of the video.

keyMomentsboolean

If set to false, the key moments feature will be disabled.

fullscreenOnRotateToLandscapeboolean

If set to false, the video will not automatically go to fullscreen mode on mobile when rotated to landscape.

fakeFullScreenboolean

If set to true, the video will try to play in a pseudo-fullscreen mode on certain mobile devices.

wmodestring

If set to transparent, the background behind the player will be transparent instead of black.

bpbTimestring

Controls when the big play button appears, expressed as a string.

sphericalboolean

If set to true, the video is rendered as a spherical (360-degree) video.

clickForSoundboolean

If set to true, viewers can click to enable sound on a muted video.

seoboolean

If set to true, the video’s metadata will be injected into the page’s markup for SEO.

doNotTrackboolean

If set to true, data for each viewing session will not be tracked.

copyLinkAndThumbnailEnabledboolean

If set to false, the option to “Copy Link and Thumbnail” will be removed when right-clicking on the video.

emailstring

Associate a specific email address with this video’s viewing sessions.

googleAnalyticsstring

Google Analytics tracking configuration to associate with this video’s viewing sessions.

Example request

{
  "videoFoam": true
}

Response

Playback customization update successful

autoPlaystring
silentAutoPlaystring
mutedstring
volumestring
controlsVisibleOnLoadstring
playButtonstring
smallPlayButtonstring
playbarstring
volumeControlstring
fullscreenButtonstring
settingsControlstring
playbackRateControlstring
qualityControlstring
qualityMinstring
qualityMaxstring
videoQualitystring
hlsstring
endVideoBehaviorstring
playsinlinestring
playlistLoopstring
playlistLinksstring
playPauseNotifierstring
playSuspendedOffScreenstring
resumablestring
preloadstring
timestring
keyMomentsstring
fullscreenOnRotateToLandscapestring
fakeFullScreenstring
wmodestring
bpbTimestring
sphericalstring
seostring
doNotTrackstring
copyLinkAndThumbnailEnabledstring
emailstring
googleAnalyticsstring

Changes