Red5 Pro HTML5 SecondScreen SDK Red5 Pro HTML5 SecondScreen SDK

  • API Docs for Version: 0.4.2

    • APIs

    Show:

    SecondScreenHost Class

    Defined in: src/secondscreen-host.js:110
    Module: secondscreen-host

    SecondScreenHost global entry object, accessible on the browser through window.secondscreenHost.noConflict().

    Copyright (c) 2013 Infrared5

    https://github.com/infrared5/red5pro-host-html-sdk

    Methods

    allDevices

    () Function

    Defined in src/secondscreen-host.js:260

    Returns proxy to Device API on all devices.

    see device.Device

    Returns:

    Function:

    Proxy on full Device API

    getDeviceById

    (
    • id
    )
    device.Device

    Defined in src/secondscreen-host.js:247

    Returns associated Device with id if connected. Returns undefined if Device not found.

    see device.Device

    Parameters:

    • id String

      Associated unique identifier for connected Device

    Returns:

    device.Device:

    getVisibility

    () Boolean

    Defined in src/secondscreen-host.js:289

    Returns visibility of this Host instance on the registry.

    Returns:

    Boolean:

    setLogLevel

    (
    • level
    )

    Defined in src/secondscreen-host.js:338

    Define the log level for printing messages from the Host to the console.

    Parameters:

    • level Int

      Enumeration value from

    setVisibility

    (
    • value
    )

    Defined in src/secondscreen-host.js:273

    Sets visibility/accessibility of this Host instance on the registry. If set to false, the Host is not considered registered and available to connect to from a Client device.

    Parameters:

    • value Boolean

      Flag of visibility.

    start

    (
    • config
    • forceFlash
    )

    Defined in src/secondscreen-host.js:160

    Starts a SecondScreen Host session. Attempts to register host on target registryUrl defined in configuration.

    Parameters:

    • config Object

      Configuration for host.

    • forceFlash Boolean

      Flag to force flash fallback usage. Otherwise, determined on browser capabilities.

    Example:

    var host = window.secondscreenHost.noConflict();
host.start({
  name: "SDK Examples",
  registryUrl: "ws://54.82.36.3:6262/secondscreen",
  appId: "secondscreen",
  controlMode: host.ControlModes.HTML,
  controlsUrl: "scheme/basic-scheme.html"
});

    stop

    ()

    Defined in src/secondscreen-host.js:217

    Stops a SecondScreen Host session. Unregisters host from remote/local registry and shuts down all connections.

    Example:

    var host = window.secondscreenHost.noConflict();
host.start({
  name: "SDK Examples",
  registryUrl: "ws://54.82.36.3:6262/live",
  appId: "secondscreen",
  controlMode: host.ControlModes.HTML,
  controlsUrl: "scheme/basic-scheme.html"
});
...
host.stop();

    versionStr

    () String

    Defined in src/secondscreen-host.js:329

    Returns the current version in prety print String

    Returns:

    String:

    Properties

    ControlModes

    Dictionary

    Defined in src/secondscreen-host.js:386

    Enumeration of enum.ControlMode

    DPadControls

    Dictionary

    Defined in src/secondscreen-host.js:407

    Enumeration of enum.DPADControls event position data

    ErrorTypes

    Dictionary

    Defined in src/secondscreen-host.js:372

    Enumeration of enum.ErrorType

    EventTypes

    Dictionary

    Defined in src/secondscreen-host.js:379

    Enumeration of bridge.EventBridge event notification types.

    LogLevels

    Dictionary

    Defined in src/secondscreen-host.js:393

    Enumeration of LogLevels

    SlotColors

    Array

    Defined in src/secondscreen-host.js:400

    List of designated Slot Colors in registry.