Classes

• _global_
• bc
• bc.config
• bc.context
• bc.core
• bc.core.mode
• bc.device
• bc.device.codes
• bc.device.externalscreen
• bc.device.mediaUpload
• bc.device.mediaUpload.errors
• bc.device.mediaUpload.events
• bc.device.modalEmail
• bc.metrics
• bc.plugins.audioPlayer
• bc.plugins.audioPlayer.errors
• bc.plugins.audioPlayer.events
• bc.plugins.googleAnalytics
• bc.templates
• bc.ui
• bc.ui.orientation
• bc.ui.transitions
• bc.utils
• Events

Namespace bc.device.externalscreen

Defined in: device.js.

   $( "#close" ).bind( "tap", function() {
      bc.device.externalscreen.closeExternalScreen();
   });

Parameters:

successCallback

The function that is called if the webview is displayed

errorCallback

The function that is called if an error occurs. The errorCallback function is passed an object that contains a property named errorCode, which maps to one of the codes defined in bc.device.codes, and a property named errorMessage, which provides additional information about this error.

   $( "#display" ).bind( "tap", function() {
      bc.device.externalscreen.openExternalWebview( "test.html" );
   });

Parameters:

uri

The URI string specified in the manifest

successCallback

The function that is called if the webview is displayed

errorCallback

The function that is called if an error occurs. The errorCallback function is passed an object that contains a property named errorCode, which maps to one of the codes defined in bc.device.codes, and a property named errorMessage, which provides additional information about this error.

    $(bc).bind( "externalscreenconnected", function() {
      // start playing back a video
      bc.device.externalscreen.playVideo( "http://someurl.com/a.m4v" );
    });

    // register a tap handler for the user hitting the pause button.  Typically, this pause button would be displayed on the iOS device
    $("#pauseButton").bind( "tap", function() {
      bc.device.externalscreen.pauseVideo( pauseSuccessHandler );        
    });

    function pauseSuccessHandler() {
      // now that pause was called successfully we update the pause button control on the iPad to show the play action
    }

Parameters:

successCallback

The function that is called if the video is successfully paused.

errorCallback

The function that is called if an error occurs. The errorCallback function is passed an object that contains a property named errorCode, which maps to one of the codes defined in bc.device.codes, and a property named errorMessage, which provides additional information about this error.

    $(bc).bind( "externalscreenconnected", function() {
      bc.device.externalscreen.playVideo( "http://someurl.com/a.m4v", successHandler, errorHandler);
    });

    $(bc).bind( "externalscreenvideoplaying", function() {
      // update UI on iPad to give them controls to pause/stop video playing on Apple TV
    });

Parameters:

videoURL

The URL to a video to playback. The URL must be in a format that can playback on an iOS device. It is strongly recommended that this be an HLS encoded video. This parameter is passed as a String.

successCallback

The function that is called if the URL is successfully passed to the video player. Note: this does not mean that playback has begun. It only means that the URL has been registered with the video player. You can listen for the "externalscreenvideoplaying" event to be fired on the bc object.

errorCallback

The function that is called if an error occurs. The errorCallback function is passed an object that contains a property named errorCode, which maps to one of the codes defined in bc.device.codes, and a property named errorMessage, which provides additional information about this error.

options

An options object. We look for the timecode which if not 0, will play the video at the given time. Support for this depends on encoding of the video, as explained here

   $( "#postmessage" ).bind( "tap", function() {
      bc.device.externalscreen.postMessage("Bonzai!", successCallback, errorCallback);
   });

Parameters:

successCallback

The function that is called if the webview is displayed

errorCallback

The function that is called if an error occurs. The errorCallback function is passed an object that contains a property named errorCode, which maps to one of the codes defined in bc.device.codes, and a property named errorMessage, which provides additional information about this error.

errorCallback

   $( "#skip" ).bind( "tap", function() {
     //Jump to minute 5
      bc.device.externalscreen.seekVideo( 600 );
   });

Parameters:

timecode

The timecode that you would like to seek to. Could be forward or backward from the current timecode. This parameter is passed as a Number. This timecode represents the 'seconds' that you want to seek to. For example, if you wanted to seek to the three minute mark then you would call bc.device.externalscreen.seekVideo( 180, successHandler, errorHandler)

successCallback

The function that is called if the video is successfully seeked into.

errorCallback

The function that is called if an error occurs. The errorCallback function is passed an object that contains a property named errorCode, which maps to one of the codes defined in bc.device.codes, and a property named errorMessage, which provides additional information about this error.

    $(bc).bind( "externalscreenconnected", function() {
      // start playing back a video
      bc.device.externalscreen.playVideo( "http://someurl.com/a.m4v", successHandler, errorHandler);
    });

    // register a tap handler for the user hitting the stop button.  Typically, this stop button would be displayed on the iOS device
    $("#stopButton").bind( "tap", function() {
      bc.device.externalscreen.stopVideo( stopSuccessHandler, stopErrorHandler );        
    });

    function stopSuccessHandler() {
      // now that stop was called successfully we let the user pick from a new set of videos to playback
    }