WordPress.org

Make WordPress Core

Changeset 41330


Ignore:
Timestamp:
09/03/2017 04:15:38 PM (4 years ago)
Author:
afercia
Message:

Docs: Update media-audiovideo.js after [41239].

Fixes #41602.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/js/media-audiovideo.js

    r41198 r41330  
    55
    66/**
     7 *
     8 * @summary Defines the wp.media.mixin object.
     9 *
    710 * @mixin
     11 *
     12 * @since 4.2.0
    813 */
    914wp.media.mixin = {
    1015    mejsSettings: baseSettings,
    1116
     17    /**
     18     * @summary Pauses and removes all players.
     19     *
     20     * @since 4.2.0
     21     *
     22     * @return {void}
     23     */
    1224    removeAllPlayers: function() {
    1325        var p;
     
    2234
    2335    /**
     36     * @summary Removes the player.
     37     *
    2438     * Override the MediaElement method for removing a player.
    25      *  MediaElement tries to pull the audio/video tag out of
    26      *  its container and re-add it to the DOM.
     39     * MediaElement tries to pull the audio/video tag out of
     40     * its container and re-add it to the DOM.
     41     *
     42     * @since 4.2.0
     43     *
     44     * @return {void}
    2745     */
    2846    removePlayer: function(t) {
     
    5977
    6078    /**
     79     *
     80     * @summary Removes and resets all players.
     81     *
    6182     * Allows any class that has set 'player' to a MediaElementPlayer
    62      *  instance to remove the player when listening to events.
    63      *
    64      *  Examples: modal closes, shortcode properties are removed, etc.
     83     * instance to remove the player when listening to events.
     84     *
     85     * Examples: modal closes, shortcode properties are removed, etc.
     86     *
     87     * @since 4.2.0
    6588     */
    6689    unsetPlayers : function() {
     
    7699
    77100/**
    78  * Autowire "collection"-type shortcodes
     101 * @summary Shortcode modeling for playlists.
     102 *
     103 * @since 4.2.0
    79104 */
    80105wp.media.playlist = new wp.media.collection({
     
    93118
    94119/**
    95  * Shortcode modeling for audio
    96  *  `edit()` prepares the shortcode for the media modal
    97  *  `shortcode()` builds the new shortcode after update
     120 * @summary Shortcode modeling for audio.
     121 *
     122 * `edit()` prepares the shortcode for the media modal.
     123 * `shortcode()` builds the new shortcode after an update.
    98124 *
    99125 * @namespace
     126 *
     127 * @since 4.2.0
    100128 */
    101129wp.media.audio = {
     
    111139    },
    112140
     141    /**
     142     * @summary Instantiates a new media object with the next matching shortcode.
     143     *
     144     * @since 4.2.0
     145     *
     146     * @param {string} data The text to apply the shortcode on.
     147     * @returns {wp.media} The media object.
     148     */
    113149    edit : function( data ) {
    114150        var frame, shortcode = wp.shortcode.next( 'audio', data ).shortcode;
     
    123159    },
    124160
     161    /**
     162     * @summary Generates an audio shortcode.
     163     *
     164     * @since 4.2.0
     165     *
     166     * @param {Array} model Array with attributes for the shortcode.
     167     * @returns {wp.shortcode} The audio shortcode object.
     168     */
    125169    shortcode : function( model ) {
    126170        var content;
     
    146190
    147191/**
    148  * Shortcode modeling for video
    149  *  `edit()` prepares the shortcode for the media modal
    150  *  `shortcode()` builds the new shortcode after update
     192 * @summary Shortcode modeling for video.
     193 *
     194 *  `edit()` prepares the shortcode for the media modal.
     195 *  `shortcode()` builds the new shortcode after update.
     196 *
     197 * @since 4.2.0
    151198 *
    152199 * @namespace
     
    167214    },
    168215
     216    /**
     217     * @summary Instantiates a new media object with the next matching shortcode.
     218     *
     219     * @since 4.2.0
     220     *
     221     * @param {string} data The text to apply the shortcode on.
     222     * @returns {wp.media} The media object.
     223     */
    169224    edit : function( data ) {
    170225        var frame,
     
    184239    },
    185240
     241    /**
     242     * @summary Generates an video shortcode.
     243     *
     244     * @since 4.2.0
     245     *
     246     * @param {Array} model Array with attributes for the shortcode.
     247     * @returns {wp.shortcode} The video shortcode object.
     248     */
    186249    shortcode : function( model ) {
    187250        var content;
Note: See TracChangeset for help on using the changeset viewer.