Mountain View
Jabber SDK API Documentation

Class: NativeVideoWindow

NativeVideoWindow

Native video window represents, native window in which video is rendered. Depending on the browser and operating system (OS) this window will have different capabilities. On Google Chrome NPAPI support has been dropped so communication between Cisco Web Communicator and CWIC API is being handled through Chromes's extensions. Chrome extension doesn't provide a way to render video from native application directly into browser's web application like NPAPI does. In order to overcome this issue Native Video Window can be docked/undocked to/from a specified HTML element that will act as a docking target in web browser application. This way we simulate behaviour as if native video window is part of a HTML document. There are specific limitations with this approach. Since native window acts as an overlay over specified HTML element, no child HTML elements will be visible.

Constructor

new NativeVideoWindow()

On Mozzila Firefox, Internet Explorer and Safari u can use regular VideoWindow as NPAPI support for these brwosers still exits.
Since:
  • 11.7.0

Methods

(static) dock(htmlElement, DOMWindow)

Dock native video window to an HTML element of the specified DOM window.
Parameters:
Name Type Description
htmlElement HTMLElement HTML element to which native video window will be docked
DOMWindow Window DOM window to which HTML Element belongs. If this parameter isn't specified current DOM window is used.
Since:
  • 11.7.0
Throws:
  • No Capability - Thrown if docking isn't supported.
  • Invalid HTML Element - Thrown if htmlElement parameter is not instance of HTMLElement.

(static) hide(errorHandleropt)

Hide native video window.
Parameters:
Name Type Attributes Description
errorHandler function <optional>
 Called if error has occurred in add-on.
Since:
  • 11.7.0

(static) hideControls(errorHandleropt)

Hides native video window controls.
Parameters:
Name Type Attributes Description
errorHandler function <optional>
 Called if error has occurred in add-on.

(static) setDockTargetColor(red, green, blue)

Set the color of docking target. MAC OS only.
Parameters:
Name Type Description
red Number Value of the red color 0-255
green Number Value of the green color 0-255
blue Number Value of the blue color 0-255
Since:
  • 11.7.0

(static) setTitle(title, errorHandleropt)

Set native video window's title.
Parameters:
Name Type Attributes Description
title String Title that will be set
errorHandler function <optional>
 Called if error has occurred in add-on.
Since:
  • 11.7.0

(static) show(errorHandleropt)

Show native video window.
Parameters:
Name Type Attributes Description
errorHandler function <optional>
 Called if error has occurred in add-on.
Since:
  • 11.7.0

(static) showAlwaysOnTop(isAlwaysOnTop, errorHandleropt)

Set native video window to be shown always on top of Z-order.
Parameters:
Name Type Attributes Description
isAlwaysOnTop Boolean
errorHandler function <optional>
 Called if error has occurred in add-on.
Since:
  • 11.7.0

(static) showControls(errorHandleropt)

Shows native video window controls.
Parameters:
Name Type Attributes Description
errorHandler function <optional>
 Called if error has occurred in add-on.

(static) undock()

Undock native video window from HTML element.
Since:
  • 11.7.0
Throws:
No Capability - Thrown if docking isn't supported.