奧運期間在選手村巧遇網球球王Novak Djokovic，他是我很敬佩的運動員之一，很榮幸可以和他合照！
最近正式結束隔離生活，終於能回家放鬆一下，陪陪好久不見的家人~
接下來預計9月初會回到國訓中心，備戰下半季的羽球賽程。奧運結束後又是新的開始，我會持續努力，繼續挑戰自我💪
---
I took a selfie with World No.1 tennis player Novak Djokovic in Olympic village. He is one of my favorite athletes. It's great to meet him!
After the Olympics, I finally have a short vacation to spend some time with my family, miss them so much! I will return to the National training center in September to strive for the following badminton tournaments.
Thanks for your support, I will come back stronger!
player 2 在 YouTube Player API Reference for iframe Embeds - Google ... 的八卦
The IFrame player API lets you embed a YouTube video player on your website and control the player using JavaScript.
Using the API's JavaScript functions, you can queue videos for playback; play, pause, or stop those videos; adjust the player volume; or retrieve information about the video being played. You can also add event listeners that will execute in response to certain player events, such as a player state change.
This guide explains how to use the IFrame API. It identifies the different types of events that the API can send and explains how to write event listeners to respond to those events. It also details the different JavaScript functions that you can call to control the video player as well as the player parameters you can use to further customize the player.
RequirementsThe user's browser must support the HTML5
postMessagefeature. Most modern browsers supportpostMessage.Embedded players must have a viewport that is at least 200px by 200px. If the player displays controls, it must be large enough to fully display the controls without shrinking the viewport below the minimum size. We recommend 16:9 players be at least 480 pixels wide and 270 pixels tall.
Any web page that uses the IFrame API must also implement the following JavaScript function:
onYouTubeIframeAPIReady– The API will call this function when the page has finished downloading the JavaScript for the player API, which enables you to then use the API on your page. Thus, this function might create the player objects that you want to display when the page loads.Getting started
The sample HTML page below creates an embedded player that will load a video, play it for six seconds, and then stop the playback. The numbered comments in the HTML are explained in the list below the example.
The following list provides more details about the sample above:
The
<div>tag in this section identifies the location on the page where the IFrame API will place the video player. The constructor for the player object, which is described in the Loading a video player section, identifies the<div>tag by itsidto ensure that the API places the<iframe>in the proper location. Specifically, the IFrame API will replace the<div>tag with the<iframe>tag.As an alternative, you could also put the
<iframe>element directly on the page. The Loading a video player section explains how to do so.The code in this section loads the IFrame Player API JavaScript code. The example uses DOM modification to download the API code to ensure that the code is retrieved asynchronously. (The
<script>tag'sasyncattribute, which also enables asynchronous downloads, is not yet supported in all modern browsers as discussed in this Stack Overflow answer.The
onYouTubeIframeAPIReadyfunction will execute as soon as the player API code downloads. This portion of the code defines a global variable,player, which refers to the video player you are embedding, and the function then constructs the video player object.The
onPlayerReadyfunction will execute when theonReadyevent fires. In this example, the function indicates that when the video player is ready, it should begin to play.The API will call the
onPlayerStateChangefunction when the player's state changes, which may indicate that the player is playing, paused, finished, and so forth. The function indicates that when the player state is1(playing), the player should play for six seconds and then call thestopVideofunction to stop the video.Loading a video player
After the API's JavaScript code loads, the API will call the
onYouTubeIframeAPIReadyfunction, at which point you can construct aYT.Playerobject to insert a video player on your page. The HTML excerpt below shows theonYouTubeIframeAPIReadyfunction from the example above:The constructor for the video player specifies the following parameters:
The first parameter specifies either the DOM element or the
idof the HTML element where the API will insert the<iframe>tag containing the player.The IFrame API will replace the specified element with the
<iframe>element containing the player. This could affect the layout of your page if the element being replaced has a different display style than the inserted<iframe>element. By default, an<iframe>displays as aninline-blockelement.The second parameter is an object that specifies player options. The object contains the following properties:
width(number) – The width of the video player. The default value is640.height(number) – The height of the video player. The default value is390.videoId(string) – The YouTube video ID that identifies the video that the player will load.playerVars(object) – The object's properties identify player parameters that can be used to customize the player.events(object) – The object's properties identify the events that the API fires and the functions (event listeners) that the API will call when those events occur. In the example, the constructor indicates that theonPlayerReadyfunction will execute when theonReadyevent fires and that theonPlayerStateChangefunction will execute when theonStateChangeevent fires.As mentioned in the Getting started section, instead of writing an empty
<div>element on your page, which the player API's JavaScript code will then replace with an<iframe>element, you could create the<iframe>tag yourself. The first example in the Examples section shows how to do this.Note that if you do write the
<iframe>tag, then when you construct theYT.Playerobject, you do not need to specify values for thewidthandheight, which are specified as attributes of the<iframe>tag, or thevideoIdand player parameters, which are are specified in thesrcURL. As an extra security measure, you should also include theoriginparameter to the URL, specifying the URL scheme (http://orhttps://) and full domain of your host page as the parameter value. Whileoriginis optional, including it protects against malicious third-party JavaScript being injected into your page and hijacking control of your YouTube player.For other examples on constructing video player objects, see Examples.
OperationsTo call the player API methods, you must first get a reference to the player object you wish to control. You obtain the reference by creating a
FunctionsQueueing functionsYT.Playerobject as discussed in the Getting started and Loading a video player sections of this document.Queueing functions allow you to load and play a video, a playlist, or another list of videos. If you are using the object syntax described below to call these functions, then you can also queue or load a list of a user's uploaded videos.
The API supports two different syntaxes for calling the queueing functions.
The argument syntax requires function arguments to be listed in a prescribed order.
The object syntax lets you pass an object as a single parameter and to define object properties for the function arguments that you wish to set. In addition, the API may support additional functionality that the argument syntax does not support.
For example, the
loadVideoByIdfunction can be called in either of the following ways. Note that the object syntax supports theendSecondsproperty, which the argument syntax does not support.Argument syntax
Object syntax
Queueing functions for videos
cueVideoByIdArgument syntax
Object syntax
This function loads the specified video's thumbnail and prepares the player to play the video. The player does not request the FLV until
playVideo()orseekTo()is called.The required
videoIdparameter specifies the YouTube Video ID of the video to be played. In the YouTube Data API, avideoresource'sidproperty specifies the ID.The optional
startSecondsparameter accepts a float/integer and specifies the time from which the video should start playing whenplayVideo()is called. If you specify astartSecondsvalue and then callseekTo(), then the player plays from the time specified in theseekTo()call. When the video is cued and ready to play, the player will broadcast avideo cuedevent (5).The optional
endSecondsparameter, which is only supported in object syntax, accepts a float/integer and specifies the time when the video should stop playing whenplayVideo()is called. If you specify anendSecondsvalue and then callseekTo(), theendSecondsvalue will no longer be in effect.loadVideoByIdArgument syntax
Object syntax
This function loads and plays the specified video.
The required
videoIdparameter specifies the YouTube Video ID of the video to be played. In the YouTube Data API, avideoresource'sidproperty specifies the ID.The optional
startSecondsparameter accepts a float/integer. If it is specified, then the video will start from the closest keyframe to the specified time.The optional
endSecondsparameter accepts a float/integer. If it is specified, then the video will stop playing at the specified time.cueVideoByUrlArgument syntax
Object syntax
This function loads the specified video's thumbnail and prepares the player to play the video. The player does not request the FLV until
playVideo()orseekTo()is called.The required
mediaContentUrlparameter specifies a fully qualified YouTube player URL in the formathttp://www.youtube.com/v/VIDEO_ID?version=3.The optional
startSecondsparameter accepts a float/integer and specifies the time from which the video should start playing whenplayVideo()is called. If you specifystartSecondsand then callseekTo(), then the player plays from the time specified in theseekTo()call. When the video is cued and ready to play, the player will broadcast avideo cuedevent (5).The optional
endSecondsparameter, which is only supported in object syntax, accepts a float/integer and specifies the time when the video should stop playing whenplayVideo()is called. If you specify anendSecondsvalue and then callseekTo(), theendSecondsvalue will no longer be in effect.loadVideoByUrlArgument syntax
Object syntax
This function loads and plays the specified video.
The required
mediaContentUrlparameter specifies a fully qualified YouTube player URL in the formathttp://www.youtube.com/v/VIDEO_ID?version=3.The optional
startSecondsparameter accepts a float/integer and specifies the time from which the video should start playing. IfstartSeconds(number can be a float) is specified, the video will start from the closest keyframe to the specified time.The optional
endSecondsparameter, which is only supported in object syntax, accepts a float/integer and specifies the time when the video should stop playing.Queueing functions for lists
The
cuePlaylistandloadPlaylistfunctions allow you to load and play a playlist. If you are using object syntax to call these functions, you can also queue (or load) a list of a user's uploaded videos.Since the functions work differently depending on whether they are called using the argument syntax or the object syntax, both calling methods are documented below.
cuePlaylistArgument syntax
Queues the specified playlist. When the playlist is cued and ready to play, the player will broadcast a
video cuedevent (5).The required
playlistparameter specifies an array of YouTube video IDs. In the YouTube Data API, thevideoresource'sidproperty identifies that video's ID.The optional
indexparameter specifies the index of the first video in the playlist that will play. The parameter uses a zero-based index, and the default parameter value is0, so the default behavior is to load and play the first video in the playlist.The optional
startSecondsparameter accepts a float/integer and specifies the time from which the first video in the playlist should start playing when theplayVideo()function is called. If you specify astartSecondsvalue and then callseekTo(), then the player plays from the time specified in theseekTo()call. If you cue a playlist and then call theplayVideoAt()function, the player will start playing at the beginning of the specified video.Object syntax
Queues the specified list of videos. The list can be a playlist or a user's uploaded videos feed. The ability to queue a list of search results is deprecated and will no longer be supported as of 15 November 2020.
When the list is cued and ready to play, the player will broadcast a
video cuedevent (5).The optional
listTypeproperty specifies the type of results feed that you are retrieving. Valid values areplaylistanduser_uploads. A deprecated value,search, will no longer be supported as of 15 November 2020. The default value isplaylist.The required
listproperty contains a key that identifies the particular list of videos that YouTube should return.If the
listTypeproperty value isplaylist, then thelistproperty specifies the playlist ID or an array of video IDs. In the YouTube Data API, theplaylistresource'sidproperty identifies a playlist's ID, and thevideoresource'sidproperty specifies a video ID.If the
listTypeproperty value isuser_uploads, then thelistproperty identifies the user whose uploaded videos will be returned.If the
listTypeproperty value issearch, then thelistproperty specifies the search query. Note: This functionality is deprecated and will no longer be supported as of 15 November 2020.The optional
indexproperty specifies the index of the first video in the list that will play. The parameter uses a zero-based index, and the default parameter value is0, so the default behavior is to load and play the first video in the list.The optional
startSecondsproperty accepts a float/integer and specifies the time from which the first video in the list should start playing when theplayVideo()function is called. If you specify astartSecondsvalue and then callseekTo(), then the player plays from the time specified in theseekTo()call. If you cue a list and then call theplayVideoAt()function, the player will start playing at the beginning of the specified video.loadPlaylistArgument syntax
This function loads the specified playlist and plays it.
The required
playlistparameter specifies an array of YouTube video IDs. In the YouTube Data API, thevideoresource'sidproperty specifies a video ID.The optional
indexparameter specifies the index of the first video in the playlist that will play. The parameter uses a zero-based index, and the default parameter value is0, so the default behavior is to load and play the first video in the playlist.The optional
startSecondsparameter accepts a float/integer and specifies the time from which the first video in the playlist should start playing.Object syntax
This function loads the specified list and plays it. The list can be a playlist or a user's uploaded videos feed. The ability to load a list of search results is deprecated and will no longer be supported as of 15 November 2020.
The optional
listTypeproperty specifies the type of results feed that you are retrieving. Valid values areplaylistanduser_uploads. A deprecated value,search, will no longer be supported as of 15 November 2020. The default value isplaylist.The required
listproperty contains a key that identifies the particular list of videos that YouTube should return.If the
listTypeproperty value isplaylist, then thelistproperty specifies a playlist ID or an array of video IDs. In the YouTube Data API, theplaylistresource'sidproperty specifies a playlist's ID, and thevideoresource'sidproperty specifies a video ID.If the
listTypeproperty value isuser_uploads, then thelistproperty identifies the user whose uploaded videos will be returned.If the
listTypeproperty value issearch, then thelistproperty specifies the search query. Note: This functionality is deprecated and will no longer be supported as of 15 November 2020.The optional
indexproperty specifies the index of the first video in the list that will play. The parameter uses a zero-based index, and the default parameter value is0, so the default behavior is to load and play the first video in the list.The optional
startSecondsproperty accepts a float/integer and specifies the time from which the first video in the list should start playing.Playback controls and player settings
Playing a video
player.playVideo():VoidPlays the currently cued/loaded video. The final player state after this function executes will be
playing(1).Note: A playback only counts toward a video's official view count if it is initiated via a native play button in the player.
player.pauseVideo():VoidPauses the currently playing video. The final player state after this function executes will be
paused(2) unless the player is in theended(0) state when the function is called, in which case the player state will not change.player.stopVideo():VoidStops and cancels loading of the current video. This function should be reserved for rare situations when you know that the user will not be watching additional video in the player. If your intent is to pause the video, you should just call the
pauseVideofunction. If you want to change the video that the player is playing, you can call one of the queueing functions without callingstopVideofirst.Important: Unlike the
pauseVideofunction, which leaves the player in thepaused(2) state, thestopVideofunction could put the player into any not-playing state, includingended(0),paused(2),video cued(5) orunstarted(-1).player.seekTo(seconds:Number, allowSeekAhead:Boolean):VoidSeeks to a specified time in the video. If the player is paused when the function is called, it will remain paused. If the function is called from another state (
playing,video cued, etc.), the player will play the video.The
secondsparameter identifies the time to which the player should advance.The player will advance to the closest keyframe before that time unless the player has already downloaded the portion of the video to which the user is seeking.
The
allowSeekAheadparameter determines whether the player will make a new request to the server if thesecondsparameter specifies a time outside of the currently buffered video data.We recommend that you set this parameter to
falsewhile the user drags the mouse along a video progress bar and then set it totruewhen the user releases the mouse. This approach lets a user scroll to different points of a video without requesting new video streams by scrolling past unbuffered points in the video. When the user releases the mouse button, the player advances to the desired point in the video and requests a new video stream if necessary.Controlling playback of 360° videos
Note: The 360° video playback experience has limited support on mobile devices. On unsupported devices, 360° videos appear distorted and there is no supported way to change the viewing perspective at all, including through the API, using orientation sensors, or responding to touch/drag actions on the device's screen.
player.getSphericalProperties():ObjectRetrieves properties that describe the viewer's current perspective, or view, for a video playback. In addition:
This object is only populated for 360° videos, which are also called spherical videos.
If the current video is not a 360° video or if the function is called from a non-supported device, then the function returns an empty object.
On supported mobile devices, if the
enableOrientationSensorproperty is set totrue, then this function returns an object in which thefovproperty contains the correct value and the other properties are set to0.The object contains the following properties:
Properties
yawA number in the range [0, 360) that represents the horizontal angle of the view in degrees, which reflects the extent to which the user turns the view to face further left or right. The neutral position, facing the center of the video in its equirectangular projection, represents 0°, and this value increases as the viewer turns left.
pitchA number in the range [-90, 90] that represents the vertical angle of the view in degrees, which reflects the extent to which the user adjusts the view to look up or down. The neutral position, facing the center of the video in its equirectangular projection, represents 0°, and this value increases as the viewer looks up.
rollA number in the range [-180, 180] that represents the clockwise or counterclockwise rotational angle of the view in degrees. The neutral position, with the horizontal axis in the equirectangular projection being parallel to the horizontal axis of the view, represents 0°. The value increases as the view rotates clockwise and decreases as the view rotates counterclockwise.
Note that the embedded player does not present a user interface for adjusting the roll of the view. The roll can be adjusted in either of these mutually exclusive ways:
Use the orientation sensor in a mobile browser to provide roll for the view. If the orientation sensor is enabled, then the
getSphericalPropertiesfunction always returns0as the value of therollproperty.If the orientation sensor is disabled, set the roll to a nonzero value using this API.
fovA number in the range [30, 120] that represents the field-of-view of the view in degrees as measured along the longer edge of the viewport. The shorter edge is automatically adjusted to be proportional to the aspect ratio of the view.
The default value is 100 degrees. Decreasing the value is like zooming in on the video content, and increasing the value is like zooming out. This value can be adjusted either by using the API or by using the mousewheel when the video is in fullscreen mode.
player.setSphericalProperties(properties:Object):VoidSets the video orientation for playback of a 360° video. (If the current video is not spherical, the method is a no-op regardless of the input.)
The player view responds to calls to this method by updating to reflect the values of any known properties in the
propertiesobject. The view persists values for any other known properties not included in that object.In addition:
If the object contains unknown and/or unexpected properties, the player ignores them.
As noted at the beginning of this section, the 360° video playback experience is not supported on all mobile devices.
By default, on supported mobile devices, this function sets only sets the
fovproperty and does not affect theyaw,pitch, androllproperties for 360° video playbacks. See theenableOrientationSensorproperty below for more detail.The
propertiesobject passed to the function contains the following properties:Properties
yawSee definition above.
pitchSee definition above.
rollSee definition above.
fovSee definition above.
enableOrientationSensorNote: This property affects the 360° viewing experience on supported devices only.A boolean value that indicates whether the IFrame embed should respond to events that signal changes in a supported device's orientation, such as a mobile browser's
DeviceOrientationEvent. The default parameter value istrue.Supported mobile devices
When the value is
true, an embedded player relies only on the device's movement to adjust theyaw,pitch, androllproperties for 360° video playbacks. However, thefovproperty can still be changed via the API, and the API is, in fact, the only way to change thefovproperty on a mobile device. This is the default behavior.When the value is
false, then the device's movement does not affect the 360° viewing experience, and theyaw,pitch,roll, andfovproperties must all be set via the API.Unsupported mobile devices
The
enableOrientationSensorproperty value does not have any effect on the playback experience.Playing a video in a playlist
player.nextVideo():VoidThis function loads and plays the next video in the playlist.
If
player.nextVideo()is called while the last video in the playlist is being watched, and the playlist is set to play continuously (loop), then the player will load and play the first video in the list.If
player.nextVideo()is called while the last video in the playlist is being watched, and the playlist is not set to play continuously, then playback will end.player.previousVideo():VoidThis function loads and plays the previous video in the playlist.
If
player.previousVideo()is called while the first video in the playlist is being watched, and the playlist is set to play continuously (loop), then the player will load and play the last video in the list.If
player.previousVideo()is called while the first video in the playlist is being watched, and the playlist is not set to play continuously, then the player will restart the first playlist video from the beginning.player.playVideoAt(index:Number):VoidThis function loads and plays the specified video in the playlist.
The required
indexparameter specifies the index of the video that you want to play in the playlist. The parameter uses a zero-based index, so a value of0identifies the first video in the list. If you have shuffled the playlist, this function will play the video at the specified position in the shuffled playlist.Changing the player volume
player.mute():VoidMutes the player.
player.unMute():VoidUnmutes the player.
player.isMuted():BooleanReturns
trueif the player is muted,falseif not.player.setVolume(volume:Number):VoidSets the volume. Accepts an integer between
0and100.player.getVolume():NumberReturns the player's current volume, an integer between
0and100. Note thatgetVolume()will return the volume even if the player is muted.Setting the player size
player.setSize(width:Number, height:Number):ObjectSets the size in pixels of the
<iframe>that contains the player.Setting the playback rate
player.getPlaybackRate():NumberThis function retrieves the playback rate of the currently playing video. The default playback rate is
1, which indicates that the video is playing at normal speed. Playback rates may include values like0.25,0.5,1,1.5, and2.player.setPlaybackRate(suggestedRate:Number):VoidThis function sets the suggested playback rate for the current video. If the playback rate changes, it will only change for the video that is already cued or being played. If you set the playback rate for a cued video, that rate will still be in effect when the
playVideofunction is called or the user initiates playback directly through the player controls. In addition, calling functions to cue or load videos or playlists (cueVideoById,loadVideoById, etc.) will reset the playback rate to1.Calling this function does not guarantee that the playback rate will actually change. However, if the playback rate does change, the
onPlaybackRateChangeevent will fire, and your code should respond to the event rather than the fact that it called thesetPlaybackRatefunction.The
getAvailablePlaybackRatesmethod will return the possible playback rates for the currently playing video. However, if you set thesuggestedRateparameter to a non-supported integer or float value, the player will round that value down to the nearest supported value in the direction of1.player.getAvailablePlaybackRates():ArrayThis function returns the set of playback rates in which the current video is available. The default value is
1, which indicates that the video is playing in normal speed.The function returns an array of numbers ordered from slowest to fastest playback speed. Even if the player does not support variable playback speeds, the array should always contain at least one value (
1).Setting playback behavior for playlists
player.setLoop(loopPlaylists:Boolean):VoidThis function indicates whether the video player should continuously play a playlist or if it should stop playing after the last video in the playlist ends. The default behavior is that playlists do not loop.
This setting will persist even if you load or cue a different playlist, which means that if you load a playlist, call the
setLoopfunction with a value oftrue, and then load a second playlist, the second playlist will also loop.The required
loopPlaylistsparameter identifies the looping behavior.If the parameter value is
true, then the video player will continuously play playlists. After playing the last video in a playlist, the video player will go back to the beginning of the playlist and play it again.If the parameter value is
false, then playbacks will end after the video player plays the last video in a playlist.player.setShuffle(shufflePlaylist:Boolean):VoidThis function indicates whether a playlist's videos should be shuffled so that they play back in an order different from the one that the playlist creator designated. If you shuffle a playlist after it has already started playing, the list will be reordered while the video that is playing continues to play. The next video that plays will then be selected based on the reordered list.
This setting will not persist if you load or cue a different playlist, which means that if you load a playlist, call the
setShufflefunction, and then load a second playlist, the second playlist will not be shuffled.The required
shufflePlaylistparameter indicates whether YouTube should shuffle the playlist.If the parameter value is
true, then YouTube will shuffle the playlist order. If you instruct the function to shuffle a playlist that has already been shuffled, YouTube will shuffle the order again.If the parameter value is
false, then YouTube will change the playlist order back to its original order.Playback status
player.getVideoLoadedFraction():FloatReturns a number between
0and1that specifies the percentage of the video that the player shows as buffered. This method returns a more reliable number than the now-deprecatedgetVideoBytesLoadedandgetVideoBytesTotalmethods.player.getPlayerState():NumberReturns the state of the player. Possible values are:
-1– unstarted0– ended1– playing2– paused3– buffering5– video cuedplayer.getCurrentTime():NumberReturns the elapsed time in seconds since the video started playing.
player.getVideoStartBytes():NumberDeprecated as of October 31, 2012. Returns the number of bytes the video file started loading from. (This method now always returns a value of
0.) Example scenario: the user seeks ahead to a point that hasn't loaded yet, and the player makes a new request to play a segment of the video that hasn't loaded yet.player.getVideoBytesLoaded():NumberDeprecated as of July 18, 2012. Instead, use the
getVideoLoadedFractionmethod to determine the percentage of the video that has buffered.This method returns a value between
0and1000that approximates the amount of the video that has been loaded. You could calculate the fraction of the video that has been loaded by dividing thegetVideoBytesLoadedvalue by thegetVideoBytesTotalvalue.player.getVideoBytesTotal():NumberDeprecated as of July 18, 2012. Instead, use the
getVideoLoadedFractionmethod to determine the percentage of the video that has buffered.Returns the size in bytes of the currently loaded/playing video or an approximation of the video's size.
This method always returns a value of
1000. You could calculate the fraction of the video that has been loaded by dividing thegetVideoBytesLoadedvalue by thegetVideoBytesTotalvalue.Retrieving video information
player.getDuration():NumberReturns the duration in seconds of the currently playing video. Note that
getDuration()will return0until the video's metadata is loaded, which normally happens just after the video starts playing.If the currently playing video is a live event, the
getDuration()function will return the elapsed time since the live video stream began. Specifically, this is the amount of time that the video has streamed without being reset or interrupted. In addition, this duration is commonly longer than the actual event time since streaming may begin before the event's start time.player.getVideoUrl():StringReturns the YouTube.com URL for the currently loaded/playing video.
player.getVideoEmbedCode():StringReturns the embed code for the currently loaded/playing video.
Retrieving playlist information
player.getPlaylist():ArrayThis function returns an array of the video IDs in the playlist as they are currently ordered. By default, this function will return video IDs in the order designated by the playlist owner. However, if you have called the
setShufflefunction to shuffle the playlist order, then thegetPlaylist()function's return value will reflect the shuffled order.player.getPlaylistIndex():NumberThis function returns the index of the playlist video that is currently playing.
If you have not shuffled the playlist, the return value will identify the position where the playlist creator placed the video. The return value uses a zero-based index, so a value of
0identifies the first video in the playlist.If you have shuffled the playlist, the return value will identify the video's order within the shuffled playlist.
Adding or removing an event listener
player.addEventListener(event:String, listener:String):VoidAdds a listener function for the specified
event. The Events section below identifies the different events that the player might fire. The listener is a string that specifies the function that will execute when the specified event fires.player.removeEventListener(event:String, listener:String):VoidRemoves a listener function for the specified
event. Thelisteneris a string that identifies the function that will no longer execute when the specified event fires.Accessing and modifying DOM nodes
player.getIframe():ObjectThis method returns the DOM node for the embedded
<iframe>.player.destroy():VoidRemoves the
<iframe>containing the player.Events
The API fires events to notify your application of changes to the embedded player. As noted in the previous section, you can subscribe to events by adding an event listener when constructing the
YT.Playerobject, and you can also use theaddEventListenerfunction.The API will pass an event object as the sole argument to each of those functions. The event object has the following properties:
The event's
targetidentifies the video player that corresponds to the event.The event's
dataspecifies a value relevant to the event. Note that theonReadyandonAutoplayBlockedevents do not specify adataproperty.The following list defines the events that the API fires:
onReadyThis event fires whenever a player has finished loading and is ready to begin receiving API calls. Your application should implement this function if you want to automatically execute certain operations, such as playing the video or displaying information about the video, as soon as the player is ready.
The example below shows a sample function for handling this event. The event object that the API passes to the function has a
targetproperty, which identifies the player. The function retrieves the embed code for the currently loaded video, starts to play the video, and displays the embed code in the page element that has anidvalue ofembed-code.onStateChangeThis event fires whenever the player's state changes.
The
dataproperty of the event object that the API passes to your event listener function will specify an integer that corresponds to the new player state.Possible values are:
-1(unstarted)0(ended)1(playing)2(paused)3(buffering)5(video cued).When the player first loads a video, it will broadcast an
unstarted(-1) event. When a video is cued and ready to play, the player will broadcast avideo cued(5) event. In your code, you can specify the integer values or you can use one of the following namespaced variables:YT.PlayerState.ENDEDYT.PlayerState.PLAYINGYT.PlayerState.PAUSEDYT.PlayerState.BUFFERINGYT.PlayerState.CUEDonPlaybackQualityChangeThis event fires whenever the video playback quality changes. It might signal a change in the viewer's playback
environment. See the YouTube Help Center for more
information about factors that affect playback conditions or that might cause the event to fire.
The
dataproperty value of the event object that the API passes to the event listener function will be a string that identifies the new playback quality.Possible values are:
smallmediumlargehd720hd1080highresonPlaybackRateChangeThis event fires whenever the video playback rate changes. For example, if you call the
setPlaybackRate(suggestedRate)function, this event will fire if the playback rate actually changes. Your application should respond to the event and should not assume that the playback rate will automatically change when thesetPlaybackRate(suggestedRate)function is called. Similarly, your code should not assume that the video playback rate will only change as a result of an explicit call tosetPlaybackRate.The
dataproperty value of the event object that the API passes to the event listener function will be a number that identifies the new playback rate.The
getAvailablePlaybackRatesmethod returns a list of the valid playback rates for the currently cued or playing video.onErrorThis event fires if an error occurs in the player.
The API will pass an
eventobject to the event listener function. That object'sdataproperty will specify an integer that identifies the type of error that occurred.Possible values are:
2– The request contains an invalid parameter value. For example, this error occurs if you specify a video ID that does not have 11 characters, or if the video ID contains invalid characters, such as exclamation points or asterisks.5– The requested content cannot be played in an HTML5 player or another error related to the HTML5 player has occurred.100– The video requested was not found. This error occurs when a video has been removed (for any reason) or has been marked as private.101– The owner of the requested video does not allow it to be played in embedded players.150– This error is the same as101. It's just a101error in disguise!onApiChangeThis event is fired to indicate that the player has loaded (or unloaded) a module with exposed API methods. Your application can listen for this event and then poll the player to determine which options are exposed for the recently loaded module. Your application can then retrieve or update the existing settings for those options.
The following command retrieves an array of module names for which you can set player options:
Currently, the only module that you can set options for is the
captionsmodule, which handles closed captioning in the player. Upon receiving anonApiChangeevent, your application can use the following command to determine which options can be set for thecaptionsmodule:player.getOptions('captions');By polling the player with this command, you can confirm that the options you want to access are, indeed, accessible. The following commands retrieve and update module options:
The table below lists the options that the API supports:
Module
Option
Description
captions
fontSize
This option adjusts the font size of the captions displayed in the player.
Valid values are
-1,0,1,2, and3. The default size is0, and the smallest size is-1. Setting this option to an integer below-1will cause the smallest caption size to display, while setting this option to an integer above3will cause the largest caption size to display.captions
reload
This option reloads the closed caption data for the video that is playing. The value will be
nullif you retrieve the option's value. Set the value totrueto reload the closed caption data.onAutoplayBlockedThis event fires any time the browser blocks autoplay or scripted video playback features,
collectively referred to as "autoplay". This includes playback attempted with any of the
following player APIs:
autoplayparameterloadPlaylistfunctionloadVideoByIdfunctionloadVideoByUrlfunctionplayVideofunctionMost browsers have policies that can block autoplay in desktop, mobile, and other
environments if certain conditions are true. Instances where this policy may be triggered
include unmuted playback without user
interaction, or when a Permissions Policy
to permit autoplay on a cross-origin iframe has not been set.
For complete details, refer to browser-specific policies
(Apple Safari / Webkit,
Google Chrome,
Mozilla Firefox)
and Mozilla's autoplay guide.
Examples
Creating
YT.PlayerobjectsExample 1: Use API with existing <iframe>
In this example, an
<iframe>element on the page already defines the player with which the API will be used. Note that either the player'ssrcURL must set theenablejsapiparameter to1or the<iframe>element'senablejsapiattribute must be set totrue.The
onPlayerReadyfunction changes the color of the border around the player to orange when the player is ready. TheonPlayerStateChangefunction then changes the color of the border around the player based on the current player status. For example, the color is green when the player is playing, red when paused, blue when buffering, and so forth.This example uses the following code:
Example 2: Loud playback
This example creates a 1280px by 720px video player. The event listener for the
onReadyevent then calls thesetVolumefunction to adjust the volume to the highest setting.Example 3: This example sets player parameters to automatically play the video when it loads and to hide the video player's controls. It also adds event listeners for several events that the API broadcasts.
Controlling 360° videos
This example uses the following code:
Android WebView Media Integrity API integration
YouTube has extended the
Android WebView Media Integrity API
to enable embedded media players, including YouTube player embeds in Android applications, to
verify the embedding app's authenticity. With this change, embedding apps automatically send an
attested app ID to YouTube. The data collected through usage of this API is the app metadata (the
package name, version number, and signing certificate) and a device attestation token generated by
Google Play services.
The data is used to verify the application and device integrity. It is encrypted, not shared with
third parties, and deleted following a fixed retention period. App developers can
configure their app identity
in the WebView Media Integrity API. The configuration supports an opt-out option.
Revision history
June 24, 2024
The documentation has been updated to note that YouTube has extended the
Android WebView Media Integrity API
to enable embedded media players, including YouTube player embeds in Android applications, to
verify the embedding app's authenticity. With this change, embedding apps automatically send an
attested app ID to YouTube.
November 20, 2023
The new
onAutoplayBlockedevent API is now available.This event notifies your application if the browser blocks autoplay or scripted playback.
Verification of autoplay success or failure is an
established paradigm
for HTMLMediaElements, and the
onAutoplayBlockedevent now provides similarfunctionality for the IFrame Player API.
April 27, 2021
The Getting Started and Loading a Video Player sections have been updated to include examples of using a
playerVarsobject to customize the player.October 13, 2020
Note: This is a deprecation announcement for the embedded player
functionality that lets you configure the player to load search results. This announcement affects
the IFrame Player API's queueing functions for lists,
cuePlaylistandloadPlaylist.This change will become effective on or after 15 November 2020. After that time, calls to the
cuePlaylistorloadPlaylistfunctions that set thelistTypeproperty to
searchwill generate a4xxresponse code, such as404(Not Found) or410(Gone). This changealso affects the
listproperty for those functions as that property no longersupports the ability to specify a search query.
As an alternative, you can use the YouTube Data API's
search.listmethod to retrieve searchresults and then load selected videos in the player.
October 24, 2019
The documentation has been updated to reflect the fact that the API no longer supports functions for setting or retrieving playback quality.
As explained in this YouTube Help Center article, to give you the best viewing
experience, YouTube adjusts the quality of your video stream based on your viewing conditions.
The changes explained below have been in effect for more than one year. This update merely aligns
the documentation with current functionality:
The
getPlaybackQuality,setPlaybackQuality, andgetAvailableQualityLevelsfunctionsare no longer supported. In particular, calls to
setPlaybackQualitywill be no-op functions, meaning they willnot actually have any impact on the viewer's playback experience.
The queueing functions for videos and playlists --
cueVideoById,loadVideoById, etc. -- no longer support thesuggestedQualityargument.Similarly, if you call those functions using object syntax, the
suggestedQualityfield is no longer supported.If
suggestedQualityis specified, it will be ignored when the request is handled. It will not generate anywarnings or errors.
The
onPlaybackQualityChangeevent is still supported and might signal achange in the viewer's playback environment. See the Help Center article
referenced above for more information about factors that affect playback conditions or that might cause the event to fire.
May 16, 2018
The API now supports features that allow users (or embedders) to control the viewing perspective for 360° videos:
The
getSphericalPropertiesfunction retrieves the current orientation for the video playback. The orientation includes the following data:yaw - represents the horizontal angle of the view in degrees, which reflects the extent to which the user turns the view to face further left or right
pitch - represents the vertical angle of the view in degrees, which reflects the extent to which the user adjusts the view to look up or down
roll - represents the rotational angle (clockwise or counterclockwise) of the view in degrees.
fov - represents the field-of-view of the view in degrees, which reflects the extent to which the user zooms in or out on the video.
The
setSphericalPropertiesfunction modifies the view to match the submitted property values. In addition to the orientation values described above, this function supports a Boolean field that indicates whether the IFrame embed should respond toDeviceOrientationEventson supported mobile devices.This example demonstrates and lets you test these new features.
June 19, 2017
This update contains the following changes:
Documentation for the YouTube Flash Player API and YouTube JavaScript Player API has been removed and redirected to this document. The deprecation announcement for the Flash and JavaScript players was made on January 27, 2015. If you haven't done so already, please migrate your applications to use IFrame embeds and the IFrame Player API.
August 11, 2016
This update contains the following changes:
The newly published YouTube API Services Terms of Service ("the Updated Terms"), discussed in detail on the YouTube Engineering and Developers Blog, provides a rich set of updates to the current Terms of Service. In addition to the Updated Terms, which will go into effect as of February 10, 2017, this update includes several supporting documents to help explain the policies that developers must follow.
The full set of new documents is described in the revision history for the Updated Terms. In addition, future changes to the Updated Terms or to those supporting documents will also be explained in that revision history. You can subscribe to an RSS feed listing changes in that revision history from a link in that document.
June 29, 2016
This update contains the following changes:
The documentation has been corrected to note that the
onApiChangemethod provides access to thecaptionsmodule and not theccmodule.June 24, 2016
The Examples section has been updated to include an example that demonstrates how to use the API with an existing
<iframe>element.January 6, 2016
The
clearVideofunction has been deprecated and removed from the documentation. The function no longer has any effect in the YouTube player.December 18, 2015
European Union (EU) laws require that certain disclosures must be given to and consents obtained from end users in the EU. Therefore, for end users in the European Union, you must comply with the EU User Consent Policy. We have added a notice of this requirement in our YouTube API Terms of Service.
April 28, 2014
This update contains the following changes:
The new removeEventListener function lets you remove a listener for a specified event.
March 25, 2014
This update contains the following changes:
The Requirements section has been updated to note that embedded players must have a viewport that is at least 200px by 200px. If a player displays controls, it must be large enough to fully display the controls without shrinking the viewport below the minimum size. We recommend 16:9 players be at least 480 pixels wide and 270 pixels tall.
July 23, 2013
This update contains the following changes:
The Overview now includes a video of a 2011 Google I/O presentation that discusses the iframe player.
October 31, 2012
This update contains the following changes:
The Queueing functions section has been updated to explain that you can use either argument syntax or object syntax to call all of those functions. Note that the API may support additional functionality in object syntax that the argument syntax does not support.
In addition, the descriptions and examples for each of the video queueing functions have been updated to reflect the newly added support for object syntax. (The API's playlist queueing functions already supported object syntax.)
When called using object syntax, each of the video queueing functions supports an
endSecondsproperty, which accepts a float/integer and specifies the time when the video should stop playing whenplayVideo()is called.The
getVideoStartBytesmethod has been deprecated. The method now always returns a value of0.August 22, 2012
This update contains the following changes:
The example in the Loading a video player section that demonstrates how to manually create the
<iframe>tag has been updated to include a closing</iframe>tag since theonYouTubeIframeAPIReadyfunction is only called if the closing</iframe>element is present.August 6, 2012
This update contains the following changes:
The Operations section has been expanded to list all of the supported API functions rather than linking to the JavaScript Player API Reference for that list.
The API supports several new functions and one new event that can be used to control the video playback speed:
Functions
getAvailablePlaybackRates– Retrieve the supported playback rates for the cued or playing video. Note that variable playback rates are currently only supported in the HTML5 player.getPlaybackRate– Retrieve the playback rate for the cued or playing video.setPlaybackRate– Set the playback rate for the cued or playing video.Events
onPlaybackRateChange– This event fires when the video's playback rate changes.July 19, 2012
This update contains the following changes:
The new
getVideoLoadedFractionmethod replaces the now-deprecatedgetVideoBytesLoadedandgetVideoBytesTotalmethods. The new method returns the percentage of the video that the player shows as buffered.The
onErrorevent may now return an error code of5, which indicates that the requested content cannot be played in an HTML5 player or another error related to the HTML5 player has occurred.The Requirements section has been updated to indicate that any web page using the IFrame API must also implement the
onYouTubeIframeAPIReadyfunction. Previously, the section indicated that the required function was namedonYouTubePlayerAPIReady. Code samples throughout the document have also been updated to use the new name.Note: To ensure that this change does not break existing implementations, both names will work. If, for some reason, your page has an
onYouTubeIframeAPIReadyfunction and anonYouTubePlayerAPIReadyfunction, both functions will be called, and theonYouTubeIframeAPIReadyfunction will be called first.The code sample in the Getting started section has been updated to reflect that the URL for the IFrame Player API code has changed to
http://www.youtube.com/iframe_api. To ensure that this change does not affect existing implementations, the old URL (http://www.youtube.com/player_api) will continue to work.July 16, 2012
This update contains the following changes:
The Operations section now explains that the API supports the
setSize()anddestroy()methods. ThesetSize()method sets the size in pixels of the<iframe>that contains the player and thedestroy()method removes the<iframe>.June 6, 2012
This update contains the following changes:
We have removed the
experimentalstatus from the IFrame Player API.The Loading a video player section has been updated to point out that when inserting the
<iframe>element that will contain the YouTube player, the IFrame API replaces the element specified in the constructor for the YouTube player. This documentation change does not reflect a change in the API and is intended solely to clarify existing behavior.In addition, that section now notes that the insertion of the
<iframe>element could affect the layout of your page if the element being replaced has a different display style than the inserted<iframe>element. By default, an<iframe>displays as aninline-blockelement.March 30, 2012
This update contains the following changes:
The Operations section has been updated to explain that the IFrame API supports a new method,
getIframe(), which returns the DOM node for the IFrame embed.March 26, 2012
This update contains the following changes:
The Requirements section has been updated to note the minimum player size.
... <看更多>