Page Comparison

...

[
    GarbageCollected,interface VideoOutputEvent {
    attribute String type;
};
 
callback VideoOutputEventCallback = void (VideoOutputEvent event);
 
[
    constructor(DOMStringString interfaceName)
] interface VideoOutputConfiguration : EventTarget {
    attribute DOMStringString type;
    Promise<Size> getVideoResolution();
    Promise<Size> getGraphicsResolution();
    Promise<Size> getOutputResolution();
    Promise<>Promise<void> adjustGraphicsColor(ColorProperties);
    Promise<EdidIdentity> getEdidIdentity();
    Promise<DOMString>Promise<String> getEdid();
    Promise<>Promise<void> setMultiScreenBezel(int xPercentage, int yPercentage);
    Promise<>Promise<void> setBackgroundColor(int color);
    Promise<>Promise<void> setPowerSaveMode(bool enable);
    Promise<>Promise<bool> set3dModegetPowerSaveMode(int mode);
    Promise<>Promise<void> setSyncDomainset3dMode(DOMStringint domainmode);
	    Promise<bool> isAttached();
    [type == "hdmi"] Promise<OutputStatus> getOutputStatus();
    [type == "hdmi"] Promise<>Promise<void> disableAudio(bool disable);
    [type == "hdmi"] Promise<TxHdcpStatus> getTxHdcpStatus();
    [type == "hdmi"] Promise<>Promise<void> forceHdcpOn(bool);
     EventHandler hotplugeventPromise<void> setSyncDomain(String domain)
    Promise<void> setMpcdi(String filename);
    void addEventListener(String type, VideoOutputEventCallback callback);
    void removeEventListener(String type, VideoOutputEventCallback callback);
};

interface EdidIdentity {
    attribute DOMStringString manufacturer;
    attribute int product;
    attribute int serialNumber;
    attribute int weekOfManufacture;
    attribute int yearOfManufacture;
    attribute DOMStringString monitorName;
    attribute DOMStringString textString;
    attribute DOMStringString serialNumberString;
    attribute bool bt2020RgbSupport;
    attribute bool bt2020YccSupport;
    attribute bool sdrEotfSupport;
    attribute bool hdrEotfSupport;
    attribute bool hdrSt2084Support;
	attribute bool unstable};
} 
interface OutputStatus {
    attribute bool outputPresent;
    attribute bool outputPowered;
    attribute bool unstable;
    attribute DOMStringString audioFormat;
    attribute int audioSampleRate;
    attribute int audioBitsPerSample;
    attribute int audioChannelCount;
    attribute DOMStringString eotf;
};
 
interface Size {
    attribute int width;
    attribute int height;
};
 
interface ColorProperties {
    attribute int constrast;
    attribute int saturation;
    attribute int hue;
    attribute int brightness;
};


interface TxHdcpStatus {
	attribute DOMString state;
};

Object Creation

To create a videooutput object, first load the brightsign/videooutput module using the require() method. Then create an instance of the videooutput class with a string value specifying the video output to configure (currently accepted values are "hdmi" and "vga").

...

Use this interface to perform operations on the video output.

Events

• [EventHandler] hotplugevent: This event VideoOutputEvent:  An event that is raised when the hotplug status of the HDMI output changes.

Methods

getVideoResolution()

Promise<Size> getVideoResolution() 

Returns the current resoultion resolution of the video plane.

getGraphicsResolution()

Promise<Size> getGraphicsResolution() 

Returns the current resoultion resolution of the graphics plane.

getOutputResolution()

...

adjustGraphicsColor()

Promise<> adjustGraphicsColor(ColorProperties) 

...

getEdid()

Promise<DOMString>Promise<String> getEdid()

Returns EDID information from a compatible monitor/television as a hex-encoded string

...

Disables HDMI output and the syncs for VGA output if passed true. The absence of a signal will cause some monitors to go into standby mode.

getPowerSaveMode()

Promise<bool> getPowerSaveMode()

set3dMode()

Promise<> set3dMode(int mode)

...

• 0: Standard mono video (default)
• 1: Side-by-side stereo video
• 2: Top-and-bottom stereo video

...

Promise<> setSyncDomain(DOMString domain)

Enables Genlock synchronization on the specified BSSyncManager/roSyncManager domain. To disable Genlock on the domain, pass an empty string to this method. To reconfigure an active Genlock synchronization, call SetSyncDomain() again using the domain name of the new or edited sync-manager instance.

isAttached()

Promise<bool> isAttached()

Returns true if the HDMI/VGA video connector is attached to an output device (i.e. the display EDID can be read successfully).

...

...

 This method will always return false if setPowerSaveMode(true) has been called on the output.

getOutputStatus()

[type == "hdmi"] Promise<OutputStatus> getOutputStatus()

Returns an OutputStatus interface containing information about an attached HDMI display device OutputStatus which describes the current state of the video output and is defined below.

disableAudio()

[type == "hdmi"] Promise<>Promise<void> disableAudio(bool disable)

Disables HDMI audio output if passed true. If passed True, the video will continue to output.

getTxHdcpStatus()

[type == "hdmi"] Promise<TxHdcpStatus> getTxHdcpStatus()

Returns a TxHdcpStatus interface indcating the current HDCP status authentication state of the HDMI video output. 

forceHdcpOn()

[type == "hdmi"] Promise<>Promise<void> forceHdcpOn(bool)

Forces Can be used to force HDCP authentication on the HDMI output if passed true. Passing false to this method will prevent forced authentication attempts with subsequent hotplug events. This method will return false if the player does not support HDCP or if forceHDCPOn() has already been called with the same valuevideo output. Even without HDCP forced on, there can still be HDCP on the output if an HDMI input has requested authentication.

setSyncDomain() 

Anchor
setsyncdomain setsyncdomain

Promise<void> setSyncDomain(String domain)

Passing any string will enable Genlock synchronization. To disable Genlock on the domain, pass an empty string to this method. Genlock synchronization will lock the vertical sync of the video output to the system clock reference. PTP is then used to synchronize the system clock of multiple players (for example, in a video wall).

setMpcdi()

Promise<void> setMpcdi(String filename)

Users that construct an MPCDI file as per the version1a 2D media profile should pass videoOutputHDMI.setMpcdi("SD:/filename.mpcdi") to the BrightSign player to decode the file and apply the warp and blend to the output as per the requirements set in filename.mpcdi (replace "filename" with the name of your actual file). Passing an empty string will turn off the warp and blend, and the image will return to the normal format.

BrightSign Series 4 players implement all levels of the MPCDI 2D media profile (version 1a).

EdidIdentity

This interface contains EDID information about an attached display:

• [DOMStringString] manufacturer
• [int] product
• [int] serialNumber
• [int] weekOfManufacture
• [int] yearOfManufacture
• [DOMStringString] monitorName
• [DOMStringString] textString
• [DOMStringString] serialNumberString
• [bool] bt2020RgbSupport
• [bool] bt2020YccSupport
• [bool] sdrEotfSupport
• [bool] hdrEotfSupport
• [bool] hdrSt2084Support
• [bool] unstable


OutputStatus

This interface contains information about an attached HDMI display device.

• [bool] outputPresent: A flag indicating whether the HDMI output is connected to a display device or not.

• [bool] outputPowered: A flag indicating whether the display device is on (i.e. RX powered) 

  Note
  title Note
  The outputPresent and outputPowered entries will always be false if setPowerSaveMode(true) has been called on the output.

  
  

• [bool] unstable: A flag indicating whether the display signal is unstable or stable
• [DOMStringString] audioFormat: The format of the audio output. A "PCM" value indicates that the player is sending decoded output.
• [int] audioSampleRate: The audio sample rate (in hertz)
• [int] audioBitsPerSample: The number of bits per audio sample
• [int] audioChannelCount: The number of audio channels in the output
• [DOMStringString] eotf: The current electro-optical transfer function (EOTF) used by the display. The following are possible values:
  • "HDR (GAMMA)"
  • "SDR (GAMMA)"
  • "SMPTE 2084 (PQ)"
  • "Future (BBC/NHK)"
  • "unspecified"

...

This interface is returned by the getTxHdcpStatus() method.

• [DOMStringString] state: The HDCP status of the HDMI output, which can be one of the following values:
  • "notRequirednot-required": HDCP is not required by the player. HDCP is required by the player if the video has been decoded locally and needs protection or if the script has called the forceHdcpOn() method. Note that, even if this parameter indicates "notRequired"not-required, HDCP might still be active in passthrough mode if an upstream HDMI source (i.e. a device connected to the HDMI input port on the player) has requested it.
  • "authenticated": HDCP has been enabled and successfully negotiated.
  • "authenticationInProgressauthentication-in-progress": HDCP has been enabled but authentication is incomplete.
  • "authenticationFailedauthentication-failed": HDCP has been requested but could not be negotiated.

Example

var VideoOutputClass = require("@brightsign/videooutput");
var videoOutputHDMI = new VideoOutputClass("hdmi");

videoOutputHDMI.getOutputStatus().then(
        function(data) {
            console.log("\nPrint the HDMI output status");
            console.log(JSON.stringify(data));
        })
    .catch(
        function(data) {
            console.log(JSON.stringify(data));
        })

...