YouTube iframe API：如何控制已经在HTML中的iframe播放器？

我希望能够控制基于iframe的YouTube播放器。这个播放器将已经在HTML中，但我想通过JavaScript API来控制它们。

我一直在阅读iframe API的文档，其中解释了如何使用API向页面添加新视频，然后用YouTube播放器函数控制它:

var player;
function onYouTubePlayerAPIReady() {
    player = new YT.Player('container', {
        height: '390',
        width: '640',
        videoId: 'u1zgFlCw8Aw',
        events: {
            'onReady': onPlayerReady,
            'onStateChange': onPlayerStateChange
        }
    });
}

该代码创建了一个新的播放器对象并将其分配给'player'，然后将其插入到#containerdiv中。然后我可以对'player'进行操作并调用playVideo(), pauseVideo()等。

但是我想能够操作的iframe播放器已经在页面上。

我可以用旧的嵌入方法很容易地做到这一点，比如:

player = getElementById('whateverID');
player.playVideo();

但是这不适用于新的iframe。我如何分配一个iframe对象已经在页面上，然后使用它的API函数?

小提琴链接:源代码-预览-小版本
更新:这个小函数只会在一个方向上执行代码。如果你想要完整的支持(例如事件监听器/getter)，请看在jQuery中收听Youtube事件

作为一个深入的代码分析的结果，我已经创建了一个函数:function callPlayer请求任何框架YouTube视频的函数调用。请参阅YouTube Api参考以获得可能的函数调用的完整列表。请阅读源代码处的注释以获得解释。

在2012年5月17日，为了照顾玩家的准备状态，代码大小增加了一倍。如果你需要一个不处理玩家准备状态的紧凑函数，请参见http://jsfiddle.net/8R5y6/。

/**
 * @author       Rob W <gwnRob@gmail.com>
 * @website      https://stackoverflow.com/a/7513356/938089
 * @version      20190409
 * @description  Executes function on a framed YouTube video (see website link)
 *               For a full list of possible functions, see:
 *               https://developers.google.com/youtube/js_api_reference
 * @param String frame_id The id of (the div containing) the frame
 * @param String func     Desired function to call, eg. "playVideo"
 *        (Function)      Function to call when the player is ready.
 * @param Array  args     (optional) List of arguments to pass to function func*/
function callPlayer(frame_id, func, args) {
    if (window.jQuery && frame_id instanceof jQuery) frame_id = frame_id.get(0).id;
    var iframe = document.getElementById(frame_id);
    if (iframe && iframe.tagName.toUpperCase() != 'IFRAME') {
        iframe = iframe.getElementsByTagName('iframe')[0];
    }
    // When the player is not ready yet, add the event to a queue
    // Each frame_id is associated with an own queue.
    // Each queue has three possible states:
    //  undefined = uninitialised / array = queue / .ready=true = ready
    if (!callPlayer.queue) callPlayer.queue = {};
    var queue = callPlayer.queue[frame_id],
        domReady = document.readyState == 'complete';
    if (domReady && !iframe) {
        // DOM is ready and iframe does not exist. Log a message
        window.console && console.log('callPlayer: Frame not found; id=' + frame_id);
        if (queue) clearInterval(queue.poller);
    } else if (func === 'listening') {
        // Sending the "listener" message to the frame, to request status updates
        if (iframe && iframe.contentWindow) {
            func = '{"event":"listening","id":' + JSON.stringify(''+frame_id) + '}';
            iframe.contentWindow.postMessage(func, '*');
        }
    } else if ((!queue || !queue.ready) && (
               !domReady ||
               iframe && !iframe.contentWindow ||
               typeof func === 'function')) {
        if (!queue) queue = callPlayer.queue[frame_id] = [];
        queue.push([func, args]);
        if (!('poller' in queue)) {
            // keep polling until the document and frame is ready
            queue.poller = setInterval(function() {
                callPlayer(frame_id, 'listening');
            }, 250);
            // Add a global "message" event listener, to catch status updates:
            messageEvent(1, function runOnceReady(e) {
                if (!iframe) {
                    iframe = document.getElementById(frame_id);
                    if (!iframe) return;
                    if (iframe.tagName.toUpperCase() != 'IFRAME') {
                        iframe = iframe.getElementsByTagName('iframe')[0];
                        if (!iframe) return;
                    }
                }
                if (e.source === iframe.contentWindow) {
                    // Assume that the player is ready if we receive a
                    // message from the iframe
                    clearInterval(queue.poller);
                    queue.ready = true;
                    messageEvent(0, runOnceReady);
                    // .. and release the queue:
                    while (tmp = queue.shift()) {
                        callPlayer(frame_id, tmp[0], tmp[1]);
                    }
                }
            }, false);
        }
    } else if (iframe && iframe.contentWindow) {
        // When a function is supplied, just call it (like "onYouTubePlayerReady")
        if (func.call) return func();
        // Frame exists, send message
        iframe.contentWindow.postMessage(JSON.stringify({
            "event": "command",
            "func": func,
            "args": args || [],
            "id": frame_id
        }), "*");
    }
    /* IE8 does not support addEventListener... */
    function messageEvent(add, listener) {
        var w3 = add ? window.addEventListener : window.removeEventListener;
        w3 ?
            w3('message', listener, !1)
        :
            (add ? window.attachEvent : window.detachEvent)('onmessage', listener);
    }
}

用法:

callPlayer("whateverID", function() {
    // This function runs once the player is ready ("onYouTubePlayerReady")
    callPlayer("whateverID", "playVideo");
});
// When the player is not ready yet, the function will be queued.
// When the iframe cannot be found, a message is logged in the console.
callPlayer("whateverID", "playVideo");

可能的问题(&答案):

Q:它不工作!
A:"不工作"不是一个明确的描述。您得到任何错误消息吗?请出示相关代码

Q: playVideo不播放视频。
A:播放需要用户交互，并且在iframe上存在allow="autoplay"。参见https://developers.google.com/web/updates/2017/09/autoplay-policy-changes和https://developer.mozilla.org/en-US/docs/Web/Media/Autoplay_guide

Q:我已经使用<iframe src="http://www.youtube.com/embed/As2rZGPGKDY" />嵌入了一个YouTube视频，但该函数不执行任何函数!
A:您必须在URL末尾添加?enablejsapi=1: /embed/vid_id?enablejsapi=1。

Q:我得到错误消息"一个无效或非法的字符串被指定"。为什么?
A: API在本地主机(file://)上不能正常工作。在线托管您的(测试)页面，或者使用JSFiddle。示例:参见本答案顶部的链接。

Q:你怎么知道的?
A:我花了一些时间手动解释API的源代码。我得出结论，我必须使用postMessage方法。要知道传递哪些参数，我创建了一个拦截消息的Chrome扩展。扩展的源代码可以在这里下载。

Q:支持哪些浏览器?
A:所有支持JSON和postMessage的浏览器。

IE 8 +
Firefox 3.6+(实际上是3.5，但document.readyState在3.6中实现)
Opera 10.50 +
Safari 4 +

相关答案/实现:使用jQuery淡入框架视频
完整的API支持:jQuery中监听Youtube事件
官方API: https://developers.google.com/youtube/iframe_api_reference

修订历史

2012年5月17日
实现onYouTubePlayerReady: callPlayer('frame_id', function() { ... }) .
当播放器尚未准备好时，函数会自动排队。
2012年7月24日
更新并在支持的浏览器中成功测试(向前看)。
2013年10月10日当函数作为参数传递时，callPlayer强制检查准备情况。这是必要的，因为当callPlayer在插入iframe之后被调用，而文档已经准备好了，它不能确定iframe已经完全准备好了。在Internet Explorer和Firefox中，这种情况会导致过早调用postMessage，而被忽略。
2013年12月12日，建议在URL中添加&origin=*。
2014年3月2日，撤回建议删除&origin=*到URL。
2019年4月9日，修复了YouTube在页面准备好之前加载时导致无限递归的错误。添加关于自动播放的说明。

看起来YouTube已经更新了他们的JS API，所以这是默认可用的!你可以使用现有的YouTube iframe的ID…

<iframe id="player" src="http://www.youtube.com/embed/M7lc1UVf-VE?enablejsapi=1&origin=http://example.com" frameborder="0"></iframe>

…

var player;
function onYouTubeIframeAPIReady() {
  player = new YT.Player('player', {
    events: {
      'onStateChange': onPlayerStateChange
    }
  });
}
function onPlayerStateChange() {
  //...
}

…构造函数将使用现有的iframe，而不是用新的iframe替换它。这也意味着你不必为构造函数指定videoId。

参见加载视频播放器

你可以用更少的代码做到这一点:

function callPlayer(func, args) {
    var i = 0,
        iframes = document.getElementsByTagName('iframe'),
        src = '';
    for (i = 0; i < iframes.length; i += 1) {
        src = iframes[i].getAttribute('src');
        if (src && src.indexOf('youtube.com/embed') !== -1) {
            iframes[i].contentWindow.postMessage(JSON.stringify({
                'event': 'command',
                'func': func,
                'args': args || []
            }), '*');
        }
    }
}

工作的例子:http://jsfiddle.net/kmturley/g6P5H/296/

我自己版本的上面的Kim T的代码，它结合了一些jQuery，并允许针对特定的iframe。

$(function() {
    callPlayer($('#iframe')[0], 'unMute');
});
function callPlayer(iframe, func, args) {
    if ( iframe.src.indexOf('youtube.com/embed') !== -1) {
        iframe.contentWindow.postMessage( JSON.stringify({
            'event': 'command',
            'func': func,
            'args': args || []
        } ), '*');
    }
}

谢谢Rob W的回答。

我一直在Cordova应用程序中使用这个，以避免必须加载API，这样我就可以轻松地控制动态加载的iframe。

我一直希望能够从iframe中提取信息，例如状态(getPlayerState)和时间(getCurrentTime)。

Rob W帮助强调了API是如何使用postMessage工作的，但当然这只向一个方向发送信息，从我们的网页到iframe。访问getter需要我们监听从iframe发回给我们的消息。

我花了一些时间才弄清楚如何调整Rob W的答案来激活和收听iframe返回的消息。我基本上搜索了YouTube iframe内的源代码，直到我找到负责发送和接收消息的代码。

关键是将'event'更改为'listening'，这基本上允许访问所有设计用于返回值的方法。

下面是我的解决方案，请注意，我只在请求getter时才切换到"监听"，您可以调整条件以包含额外的方法。

进一步注意，您可以通过向window.onmessage添加console.log(e)来查看从iframe发送的所有消息。你会注意到，一旦收听被激活，你会收到不断的更新，其中包括视频的当前时间。调用getPlayerState等getter方法将激活这些持续更新，但只会在状态发生变化时发送一条涉及视频状态的消息。

function callPlayer(iframe, func, args) {
    iframe=document.getElementById(iframe);
    var event = "command";
    if(func.indexOf('get')>-1){
        event = "listening";
    }
    if ( iframe&&iframe.src.indexOf('youtube.com/embed') !== -1) {
      iframe.contentWindow.postMessage( JSON.stringify({
          'event': event,
          'func': func,
          'args': args || []
      }), '*');
    }
}
window.onmessage = function(e){
    var data = JSON.parse(e.data);
    data = data.info;
    if(data.currentTime){
        console.log("The current time is "+data.currentTime);
    }
    if(data.playerState){
        console.log("The player state is "+data.playerState);
    }
}

我在上面的例子中遇到了问题，所以相反，我只是在源代码中插入了带有自动播放的JS的iframe，它对我来说很好。我也有可能使用Vimeo或YouTube，所以我需要能够处理这些。

这个解决方案不是惊人的，可以清理，但这对我有效。我也不喜欢jQuery，但是这个项目已经在使用它了，我只是在重构现有的代码，你可以随意清理或转换为普通的JS:)

<!-- HTML -->
<div class="iframe" data-player="viemo" data-src="$PageComponentVideo.VideoId"></div>

<!-- jQuery -->
$(".btnVideoPlay").on("click", function (e) {
        var iframe = $(this).parents(".video-play").siblings(".iframe");
        iframe.show();
        if (iframe.data("player") === "youtube") {
            autoPlayVideo(iframe, iframe.data("src"), "100%", "100%");
        } else {
            autoPlayVideo(iframe, iframe.data("src"), "100%", "100%", true);
        }
    });
    function autoPlayVideo(iframe, vcode, width, height, isVimeo) {
        if (isVimeo) {
            iframe.html(
                '<iframe width="' +
                    width +
                    '" height="' +
                    height +
                    '" src="https://player.vimeo.com/video/' +
                    vcode +
                    '?color=ff9933&portrait=0&autoplay=1" frameborder="0" allowfullscreen wmode="Opaque"></iframe>'
            );
        } else {
            iframe.html(
                '<iframe width="' +
                    width +
                    '" height="' +
                    height +
                    '" src="https://www.youtube.com/embed/' +
                    vcode +
                    '?autoplay=1&loop=1&rel=0&wmode=transparent" frameborder="0" allowfullscreen wmode="Opaque"></iframe>'
            );
        }
    }

一个快速的解决方案，如果请求不是问题，并且您希望这种行为用于显示/隐藏视频之类的东西，是删除/添加iframe，或清理和填充src。

const stopPlayerHack = (iframe) => {
    let src = iframe.getAttribute('src');
    iframe.setAttribute('src', '');
    iframe.setAttribute('src', src);
}

iframe将被删除，停止播放，并将在那之后加载。在我的例子中，我已经改进了代码，只在lightbox打开时再次设置src，因此只有当用户要求查看视频时才会加载。

可能的问题(&答案):

相关内容

最新更新

热门标签：