WistiaPlayerOptions class

Constructors

WistiaPlayerOptions({bool forceHD = false, bool autoPlay = true, bool controlsVisibleOnLoad = true, bool copyLinkAndThumbnailEnabled = false, bool doNotTrack = false, String? email, EndVideoBehavior endVideoBehavior = EndVideoBehavior.wsDefault, bool fakeFullScreen = false, FitStrategy fitStrategy = FitStrategy.contain, bool fullscreenButton = true, bool fullscreenOnRotateToLandscape = true, bool googleAnalytics = false, dynamic playbackRateControl = true, bool playbar = true, bool playButton = false, String? playerColor, String? playlistLinks, bool playlistLoop = false, bool playsinline = true, bool playSuspendedOffScreen = true, Preload preload = Preload.auto, bool qualityControl = true, int qualityMax = 1080, int qualityMin = 720, dynamic resumable = true, bool seo = false, bool settingsControl = true, dynamic silentAutoPlay = 'allow', bool smallPlayButton = false, String? stillUrl, dynamic time, String? thumbnailAltText, dynamic videoFoam, int volume = 1, bool volumeControl = true, String wmode = 'transparent'})
const

Properties

autoPlay → bool
If set to true, the video will play as soon as it’s ready.
final
controlsVisibleOnLoad → bool
If set to true, controls like the big play button, playbar, volume, etc. will be visible as soon as the video is embedded. Default is true.
final
copyLinkAndThumbnailEnabled → bool
If set to false, once your video is embedded on a webpage, the option to “Copy Link and Thumbnail” when you right click on your video will be removed.
final
doNotTrack → bool
final
email → String?
final
endVideoBehavior → EndVideoBehavior
final
fakeFullScreen → bool
final
fitStrategy → FitStrategy
final
forceHD → bool
final
fullscreenButton → bool
final
fullscreenOnRotateToLandscape → bool
final
getEndVideoBehavior → dynamic
no setter
googleAnalytics → bool
final
hashCode → int
The hash code for this object.
no setterinherited
playbackRateControl → dynamic
final
playbar → bool
final
playButton → bool
final
playerColor → String?
Changes the base color of the player. Expects a hexadecimal rgb string like “ff0000” (red), “000000” (black), “ffffff” (white), or “0000ff” (blue).
final
The playlistLinks option lets you associate specially crafted links on your page with a video, turning them into a playlist. For information about how this works, check out the Embed Links documentation. https://wistia.com/support/developers/embed-links#special-playlist-options
final
playlistLoop → bool
When set to true and this video has a playlist, it will loop back to the first video and replay it once the last video has finished.
final
playsinline → bool
When set to false, your videos will play within the native mobile player instead of our own. This can be helpful if, for example, you would prefer that your mobile viewers start the video in fullscreen mode upon pressing play.
final
playSuspendedOffScreen → bool
When a video is set to autoPlay=muted, it will pause playback when the video is out of view. For example, if the video is at the top of a page and you scroll down past it, the video will pause until you scroll back up to see the video again. To prevent a muted autoplay video from pausing when out of view, you can set this to playSuspendedOffScreen=false.
final
preload → Preload
This sets the video’s preload property. Possible values are metadata, auto, none, true, and false.
final
qualityControl → bool
If set to false, the video quality selector in the settings menu will be hidden.
final
qualityMax → int
Setting a qualityMax allows you to specify the maximum quality the video will play at. Wistia will still run bandwidth checks to test for speed, and play the highest quality version at or below the set maximum. Accepted values: 224, 360, 540, 720, 1080, 3840. Keep in mind, viewers will still be able to manually select a quality outside set maximum (using the option on the player) unless qualityControl is set to false.
final
qualityMin → int
Setting a qualityMin allows you to specify the minimum quality the video will play at. Wistia will still run bandwidth checks to test for speed, and play the highest quality version at or above the set minimum. Accepted values: 224, 360, 540, 720, 1080, 3840. Keep in mind, viewers will still be able to manually select a quality outside set minimum (using the option on the player) unless qualityControl is set to false.
final
resumable → dynamic
The resumable feature causes videos to pick up where the viewer left off next time they load the page where your video is embedded. Possible values for the resumable embed option are true, false, and auto. Defaults to auto. If auto, the resumable feature will only be enabled if the video is 5 minutes or longer, is not autoplay, and is not set to loop at the end. Setting resumable to true will enable resumable regardless of those factors, and false disables resumable no matter what.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
seo → bool
If set to true, the video’s metadata will be injected into the page’s on-page markup. Set it to false if you don’t want SEO metadata injection. For more information about how this works, check out the video SEO page. https://wistia.com/product/video-seo
final
settingsControl → bool
If set to true, the settings control will be available. This will allow viewers to control the quality and playback speed of the video. See qualityControl and playbackRateControl if you want control of what is available in the settings control.
final
silentAutoPlay → dynamic
This option allows videos to autoplay in a muted state in contexts where normal autoplay is blocked or not supported (e.g. iOS, Safari 11+, Chrome 66+).
final
smallPlayButton → bool
If set to true, the small play button control will be available.
final
stillUrl → String?
Overrides the thumbnail image that appears before the video plays. Expects an absolute URL to an image. For best results, the image should match the exact aspect ratio of the video.
final
thumbnailAltText → String?
Set the Thumbnail Alt Text for your media. Changing the Alt Text via this method will set new Alt Text or override the Alt Text set in the customization menu.
final
time → dynamic
Set the time at which the video should start. Expects an integer value in seconds or string values like "5m45s". This is equivalent to running video.time(t) immediately after initialization.
final
videoFoam → dynamic
When set to true, the video will monitor the width of its parent element. When that width changes, the video will match that width and modify its height to maintain the correct aspect ratio. You can set maximum or minimum widths and heights that videoFoam will honor.
final
volume → int
Set the volume of the video. Expects an integer value between 0 and 1. This is equivalent to running video.volume(v) immediately after initialization.
final
volumeControl → bool
When set to true, a volume control is available over the video. NOTE: On mobile devices where we use the native volume controls, this option has no effect.
final
wmode → String
When set to transparent, the background behind the video player will be transparent - allowing the page color to show through - instead of black. This applies e.g. if there’s an aspect ratio discrepancy between the dimensions of the video and its container; this option is not connected to Alpha Transparency.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited