The Queueing functions section has been updated to better explain the option of using either argument syntax or object syntax to call any 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 documentation already provided examples for calling the playlist queueing functions using object syntax.)
When called using object syntax, each of the video queueing functions supports an endSeconds property, which accepts a float/integer and specifies the time when the video should stop playing when playVideo() is called.
The getVideoStartBytes method has been deprecated. The method now always returns a value of 0.
The new getClickToPlayButton function creates and returns a video thumbnail that, when clicked, causes the source player to play that video. This function is only available in the Flash (AS3) Player API.
We recommend that you use this function in Flash (AS3) applications to generate video thumbnail images that serve as click-to-play buttons.
The API supports several new functions and one new event that can be used to control the video playback speed. However, note that variable playback speeds are currently only supported in the HTML5 player.
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.The new getVideoLoadedFraction method replaces the now-deprecated getVideoBytesLoaded and getVideoBytesTotal methods. The new method returns the percentage of the video that the player shows as buffered.
The Requirements section has been updated to note the minimum player size. {{ minimum_player_size }}
The Requirements section has been updated to note that the end user must have Flash Player 10.1 or higher installed for the player to display everything correctly.
The definition of the seekTo function has been updated to indicate that if the player is paused when the function is called, the player will remain paused after the function executes.
The AS3 Player API now supports an object syntax for calling queueing functions. Those functions are cueVideoById, loadVideoById, cueVideoByUrl, loadVideoByUrl, cuePlaylist, and loadPlaylist.
The object syntax lets you pass an object as the only argument to a function. The object's properties specify the function arguments that you wish to set.
The cuePlaylist and loadPlaylist functions both support additional functionality when called using the object syntax. Specifically, when using the object syntax, you can use both functions to retrieve either a playlist, a list of search results, or a list of a user's uploaded videos. If you are using the argument syntax, you can only retrieve a playlist.
To support this functionality, the object syntax defines a listType property that can be used to specify whether the player is retrieving a playlist, a list of search results, or a list of a user's uploaded videos. The object's list property then specifies the playlist ID, search query, or username that identifies the desired feed.
To properly reflect this functionality, the Queueing functions for playlists section has been renamed to Queueing functions for lists. Within that section, the cuePlaylist and loadPlaylist functions are each defined twice to explain how to call each function using either the argument syntax or the object syntax.
The definitions of the cueVideoByUrl and loadVideoByUrl functions have been updated in two ways:
The definition of the mediaContentUrl argument for each function has been updated to note that the value must specify the version parameter. As such, the argument's value must be a fully qualified YouTube player URL in the format http://www.youtube.com/v/VIDEO_ID?version=3.
suggestedQuality parameter. This parameter specifies the suggested playback quality for the video.The definition of the getDuration function has been updated to explain that if the currently playing video is a live event, the function will return the elapsed time since the video stream began.
The following API functions have been added to support playlist players:
The cuePlaylist function loads the thumbnail image for the first video in the specified playlist and prepares the player to play the playlist. However, the player does not request the video until your application calls either the playVideo, playVideoAt, or seekTo function.
The loadPlaylist function loads and plays the specified playlist.
The getPlaylist function plays the currently cued playlist. The final player state after this function executes will be playing (1).
The getPlaylistIndex function returns the position in which the current video appears in the playlist. The first video will have a position of 1, the second video will have a position of 2, and so forth.
The nextVideo function instructs the player to load and play the next video in the playlist.
The previousVideo function instructs the player to load and play the previous video in the playlist.
The playVideoAt function instructs the player to load and play a specific video in the playlist.
The setLoop function lets you dynamically instruct the player to continuously play the playlist or, alternately, to sto playing after the playlist has played all of the videos in the playlist.
The setShuffle function instructs YouTube to play the videos in the playlist in random order (or to play them in their designated order.
If you link to the Player Parameters document from this document, the page will now display parameters supported in any version of the player. You can use the pulldown menu in the Overview section of that document to only see parameters supported in the AS3 player (or in the HTML5 or AS2) players.
The definition of the playVideo function has been updated to note that YouTube only counts playbacks that are initiated through a native play button in either the embedded or chromeless player.
If you link to the Player Parameters document from either the link in the Getting started section or from this paragraph, the page will initially only display parameters supported in the AS3 player. You can use the pulldown menu in the Overview section of that document to see parameters supported in other players (HTML5 or AS2) or all parameters.