Skip to Content
Menu

youtubeReady()

Create each Youtube video’s data object.

JavaScript February 7, 2021

Usage

This function runs automatically, so it is not called manually. Is this incorrect?

Examples

Automatically play a video when a Bootstrap modal opens.

JavaScript
jQuery(document).on('show.bs.modal', function(e){
    vidID = jQuery(e.target).find('iframe').attr('id');
    players.youtube[vidID].playVideo();
});
Was this page helpful? Yes No


    A feedback message is required to submit this form.


    Please check that you have entered a valid email address.

    Enter your email address if you would like a response.

    Thank you for your feedback!

    Source File

    Located in /assets/js/modules/video.js on line 324.

    No Hooks

    This function does not have any filters or actions available. Request one?
    JavaScript
    nebula.youtubeReady = function(e){
        if ( typeof videoProgress === 'undefined' ){
            let videoProgress = {};
        }
    
        nebula.videos = nebula.videos || {}; //Always make sure this is defined
    
        let id = nebula.getYoutubeID(e.target);
        if ( id ){
            if ( !nebula.videos.hasOwnProperty(id) ){ //If the video object doesn't use the Youtube video ID, make a new one by duplicating from the Iframe ID
                nebula.videos[id] = nebula.videos[jQuery(e.target.getIframe()).attr('id')];
            }
    
            nebula.videos[id].title = nebula.getYoutubeTitle(e.target) ?? 'Unkown';
            nebula.videos[id].duration = e.target.getDuration(); //The total duration of the video. Unit: Seconds
            nebula.videos[id].current = e.target.getCurrentTime(); //The current position of the video. Units: Seconds
            nebula.videos[id].percent = e.target.getCurrentTime()/e.target.getDuration(); //The percent of the current position. Multiply by 100 for actual percent.
        }
    };
    

    Override

    To override or disable this JavaScript function, simply redeclare it with the exact same function name.

    JavaScript
    nebula.youtubeReady = function(){
        //Write your own code here, leave it blank, or return false.
    }