youtube_iframe_interop library

Classes

AutoHide
Whether to auto-hide video controls.
ClosedCaptionsLoadPolicy
Whether to use user-preferred or forced caption loading.
Controls
Allowed progress bar colors. How video controls are shown.
Events
Handlers for events fired by the player.
FullscreenButton
Whether to display the full-screen button.
IPlaylistSettings
Settings to load or queue a playlist.
IvLoadPolicy
Whether to show video annotations.
JsApi
Whether the JavaScript API should be enabled.
KeyboardControls
Whether to allow keyboard controls.
ModestBranding
Comma separated list of video IDs to play after the URL path's video.
OnErrorEvent
Event for a player error.
OnPlaybackQualityChangeEvent
Event for playback quality change.
OnPlaybackRateChangeEvent
Event for playback rate change.
OnStateChangeEvent
Event for player state change.
Player
Creates and controls a YouTube player in an
PlayerError
Known causes for player errors.
PlayerEvent
Base interface for events triggered by a player.
PlayerOptions
YouTube player options.
PlayerState
Type definitions for YouTube Project: https://developers.google.com/youtube/ Definitions by: Ian Obermiller ianobermiller.com, Josh Goldberg github.com/JoshuaKGoldberg Eliot Fallon github.com/eliotfallon213 Terry Mun github.com/terrymun Paul Hobbel github.com/paulhobbel Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped TypeScript Version: 2.1 @see https://developers.google.com/youtube/iframe_api_reference @see https://developers.google.com/youtube/player_parameters State of a video player.
PlayerVars
Allowed suggested player video qualities. Default video quality chosen by YouTube. Player height is 240px, and player dimensions are at least 320px by 240px for 4:3 aspect ratio. Player height is 360px, and player dimensions are 640px by 360px (for 16:9 aspect ratio) or 480px by 360px (for 4:3 aspect ratio). Player height is 480px, and player dimensions are 853px by 480px (for 16:9 aspect ratio) or 640px by 480px (for 4:3 aspect ratio). Player height is 720px, and player dimensions are 1280px by 720px (for 16:9 aspect ratio) or 960px by 720px (for 4:3 aspect ratio). Player height is 1080px, and player dimensions are 1920px by 1080px (for 16:9 aspect ratio) or 1440px by 1080px (for 4:3 aspect ratio). Player height is greater than 1080px, which means that the player's aspect ratio is greater than 1920px by 1080px. Player parameters.
PlaysInline
Whether to playback video inline or full-screen in an HTML5 player on iOS
RelatedVideos
Whether to show related videos after the video finishes.
ShowInfo
Whether to show video information before playing.
VideoByIdSettings
Settings to play or queue a video by ID.
VideoByMediaContentUrlSettings
Settings to play or queue a video by media content URL.
VideoOrPlaylistSettings
Settings to load, play, or queue a video or playlist.
YTAutoPlay
Whether to autoplay the video.
YTLoop
Which type of content loads in the player. The requested video should be shown in the player. A search area should be shown in the player. The user's uploads should load in the player. Whether a single video should be looped.

Properties

onYouTubeIframeAPIReady Function
no getter

Typedefs

PlayerEventHandler<TEvent extends PlayerEvent> = void Function(TEvent event)
Handles a player event.