To create a videoinput object, first load the brightsign/videoinput
module using the require()
method. Then create an instance of the videoinput class.
Code Block |
---|
|
var VideoInputClass = require("@brightsign/videoinput");
var vi = new VideoInputClass(); |
Use this interface to retrieve and modify video input data.
A VideoInputEvent
is raised when the hotplug status of the HDMI® input changes. It has one type property:
Code Block |
---|
|
VideoInputConfig defaultConfig() |
Immediately returns a VideoInputConfig interface containing default EDID-reporting values for the HDMI input.
Code Block |
---|
|
Promise <VideoInputConfig> getConfig() |
Returns a VideoInputConfig interface containing the current EDID-reporting configuration for the HDMI input.
Code Block |
---|
|
Promise <Status> applyConfig(VideoInputConfig config) |
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.
Code Block |
---|
|
Promise <HdmiInputStatus> getStatus() |
Returns the current status of the HDMI input.
Code Block |
---|
|
Promise <void> 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.
This interface contains configuration data related to the video input.
[enableAc3
bool] enableAc3: A flag specifying whether AC-3 is supported
[enableEac3
bool] enableEac3: A flag specifying whether E-AC-3 is supported
[enableTrueHdMlp
bool] enableTrueHdMlp: A flag specifying whether TrueHD MLP is supported
[enableDts
bool] enableDts: A flag specifying whether DTS is supported
[enableDtsHd
bool] enableDtsHd: A flag specifying whether DTS-HD is supported
[maxSampleRate
int] maxSampleRate: The maximum supported PCM audio sampling rate in Hz (e.g. the default sampling rate is 48000)
[maxChannelCount
int] maxChannelCount: 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] maxHdcpVersion: 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.
[String] 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] disableHdcpRepeater: 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] disableYuvColor: 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.
This interface is returned by the applyConfig()
method.
This interface contains information about the video source connected to the HDMI input:
[devicePresent
bool] devicePresent: A flag indicating whether an HDMI input source is present (true
) or not (false
)
[width
int] width: The width of the source video
[height
int] height: The height of the source video
[interlaced
bool] interlaced: A flag indicating whether the video source is interlaced
[frameRate
float] frameRate: The framerate of the source video
[pixelClock
float] pixelClock: The pixel-clock rate of the source video (in MHz)
[String] colorSpace
colorSpace
string: The color space of the source video, which can be one of the following: "RGB"
, "YCbCr420"
, "YCbCr422"
, "YCbCr444"
[String] audioType
audioType
string: The audio encoding of the source video, which can be either "PCM"
or "Compressed"
[audioSamplingRate
int] audioSamplingRate: The audio sampling rate of the source video (in Hz)
Code Block |
---|
|
var VideoInputClass = require("@brightsign/videoinput");
var vi = new VideoInputClass();
var inputConfig = {};
inputConfig.enableAc3 = true;
vi.applyConfig(inputConfig).then(
function(data) {
if (data.rebootRequired === true) {
system.reboot();
} else {
console.log("Reboot not required.")
}
})
.catch(
function(data) {
console.log(JSON.stringify(data));
});
vi.getConfig().then(
function(data) {
console.log("***Current Config***");
console.log(JSON.stringify(data));
})
.catch(
function(data) {
console.log(JSON.stringify(data));
});
|