videoinput

The videoinput object allows you to retrieve information about the HDMI^® input and configure EDID settings for it.

videoinput IDL

callback VideoInputEventCallback = void (VideoInputEvent event);
 
interface VideoInputConfiguration {
    VideoInputConfig defaultConfig();
    Promise<VideoInputConfig> getConfig();
    Promise<Status> applyConfig(VideoInputConfig config);
    Promise<HdmiInputStatus> getStatus();
    void addEventListener(String type, VideoOutputEventCallback callback);
    void removeEventListener(String type, VideoOutputEventCallback callback);
};
 
interface VideoInputConfig {
    attribute bool enableAc3;
    attribute bool enableEac3;
    attribute bool enableTrueHdMlp;
    attribute bool enableDts;
    attribute bool enableDtsHd;
    attribute int maxSampleRate;
    attribute int maxChannelCount;
    attribute String lockAudioTo;
    attribute bool disableHdcpRepeater;
    attribute bool disableYuvColor;
};
 
interface Status {
    attribute bool rebootRequired;
};
 
interface HdmiInputStatus {
    attribute bool devicePresent;
    attribute int  width;
    attribute int  height;
    attribute bool interlaced;
    attribute float frameRate;
    attribute float pixelClock;
    attribute String colorSpace;
    attribute String audioType;
    attribute int audioSamplingRate;
};

ON THIS PAGE

Object Creation

To create a videoinput object, first load the brightsign/videoinput module using the require() method. Then create an instance of the videoinput class.

var VideoInputClass = require("@brightsign/videoinput");
var vi = new VideoInputClass();

VideoInputConfiguration

Use this interface to retrieve and modify video input data.

Events

A VideoInputEvent is raised when the hotplug status of the HDMI^® input changes. It has one type property:

type: The event type is hdmiinputchange

Methods

defaultConfig()

VideoInputConfig defaultConfig()

Immediately returns a VideoInputConfig interface containing default EDID-reporting values for the HDMI input.

getConfig()

Returns a VideoInputConfig interface containing the current EDID-reporting configuration for the HDMI input.

applyConfig()

Configures EDID reporting for the HDMI input. By default, the input EDID includes video modes from the display attached to the HDMI output, some video modes supported by the player, and support for PCM audio up to 48kHz; it does not report proprietary media codecs that can be decoded by the device connected to the HDMI output, so you can use this method to announce such support if available at the endpoint. This method returns a promise containing a Status interface that indicates whether a reboot is required for the specified EDID-reporting settings to take effect.

getStatus()

Returns the current status of the HDMI input.

close()

This method shuts down the instance, preventing it from further consuming resources. If it is not called, garbage collection determines when the instance will be destroyed.

VideoInputConfig

This interface contains configuration data related to the video input.

enableAc3 bool: A flag specifying whether AC-3 is supported
enableEac3 bool: A flag specifying whether E-AC-3 is supported
enableTrueHdMlp bool: A flag specifying whether TrueHD MLP is supported
enableDts bool: A flag specifying whether DTS is supported
enableDtsHd bool: A flag specifying whether DTS-HD is supported
maxSampleRate int: The maximum supported PCM audio sampling rate in Hz (e.g. the default sampling rate is 48000)
maxChannelCount int: The number of PCM channels that are advertised over EDID. The default value is 2, which allows for stereo mixdown. Increasing this value to 6 allows the source to send multichannel PCM. If AC-3 or E-AC-3 is enabled on the player, multichannel audio is supported regardless of the m axChannelCount setting.
maxHdcpVersion int: The maximum supported version of HDCP advertised by the HDMI input. The default value is 2, which indicates support for HDCP 2.2. It can also be set to 1, which limits advertised support to HDCP 1.4.
lockAudioTo string: A value specifying whether the audio sample rate clock is locked to the video clock ("video") or audio clock ("audio") of the incoming HDMI signal. The determination can also be left to the system software ("auto").
disableHdcpRepeater bool: Disables the HDCP repeater functionality. If set to true, the source device attached to the HDMI input will see the device as not being HDCP capable and will downgrade the video it sends, or not send it at all.
disableYuvColor bool: Alters the EDID that the player sends to devices attached to the HDMI input. If set to true, it will advertise that it only supports RGB video modes and not YUV modes.

Status

This interface is returned by the applyConfig() method.

rebootRequired bool: A flag indicating whether or not a reboot is required for the change in EDID settings to take effect.

HDMIInputStatus

This interface contains information about the video source connected to the HDMI input:

devicePresent bool: A flag indicating whether an HDMI input source is present (true) or not (false)
width int: The width of the source video
height int: The height of the source video
interlaced bool: A flag indicating whether the video source is interlaced
frameRate float: The framerate of the source video
pixelClock float: The pixel-clock rate of the source video (in MHz)
colorSpace string: The color space of the source video, which can be one of the following: "RGB", "YCbCr420", "YCbCr422", "YCbCr444"
audioType string: The audio encoding of the source video, which can be either "PCM" or "Compressed"
audioSamplingRate int: The audio sampling rate of the source video (in Hz)

Documentation