Method Summary
| getColorSystem ( ) → colorSystem |
Get current color system. |
|
getDisplayCapabilities
(
|
Returns information about the capabilities of a display that is connected to a video output. If no display is connected then the corresponding display information will be empty. |
|
getOutputInfo
(
|
Get information about current settings for a video output. The information is dependent on the currently applied settings for all outputs. |
| getOutputs ( ) → Array.<ToiVideoOutputConfiguration.ToiVideoOutputId> |
Returns available video outputs. |
| getSupportedColorSystems ( ) → Array.<ToiVideoOutputConfiguration.ToiColorSystem> |
Get supported color systems. |
Inherited Methods
|
addEventListener
(
|
This method registers an event listener for a specific event. Multiple listeners can be added for the same event. Events are broadcast to all registered listeners. |
|
removeEventListener
(
|
This method removes an event listener for a specific event. |
Type Definitions
|
Aspect ratio of display. |
|
|
Enumeration of color depths. |
|
|
Enumeration of color levels. |
|
|
Enumeration of video color spaces. |
|
|
Enumeration of video color systems. |
|
|
The display status information. |
|
|
Signal mode on an HDMI output. |
|
|
Enumeration of scan behaviors. |
|
|
Enumerations of SCART video modes. |
|
|
Enumeration of video connection types. |
|
|
Video output identifier. |
|
|
|
|
|
Enumeration of video output types. |
|
Methods
This method registers an event listener for a specific event. Multiple listeners can be added for the same event. Events are broadcast to all registered listeners.
Inherited From:
Parameters:
-
Name Type Description typenumber The event type of the event to subscribe to.
listenerToiEventListener The JavaScript function that will receive events.
Throws:
-
ToiInvalidArgumentException Raised if the event type is not supported by this object or if the listener is not a valid JavaScript function. This exception is also raised if the application calls addEventListener with the same combination of type and listener twice.
Get current color system.
Returns:
-
Type: ToiVideoOutputConfiguration.ToiColorSystem
Current color system.
Returns information about the capabilities of a display that is connected to a video output. If no display is connected then the corresponding display information will be empty.
Parameters:
-
Name Type Description outputIdToiVideoOutputConfiguration.ToiVideoOutputId Video output identifier.
Throws:
-
ToiInvalidArgumentException Raised if outputId is an invalid output.
Returns:
-
Type: ToiVideoOutputConfiguration.ToiDisplayInfo
Information for available displays.
Get information about current settings for a video output. The information is dependent on the currently applied settings for all outputs.
Parameters:
-
Name Type Description outputIdToiVideoOutputConfiguration.ToiVideoOutputId Video output identifier.
Throws:
-
ToiOperationNotSupportedException Raised if outputs can not be listed.
ToiInvalidArgumentException Raised if outputId is an invalid output.
Returns:
-
Type: ToiVideoOutputConfiguration.ToiVideoOutputInfo
The video output information.
Returns available video outputs.
Returns:
-
Type: Array.<ToiVideoOutputConfiguration.ToiVideoOutputId>
List of video output identifiers.
Get supported color systems.
Returns:
-
Type: Array.<ToiVideoOutputConfiguration.ToiColorSystem>
Supported color systems.
This method removes an event listener for a specific event.
Inherited From:
Parameters:
-
Name Type Description typenumber The event type of the event to remove the listener from.
listenerToiEventListener The JavaScript function that was previously added as an event listener.
Throws:
-
ToiInvalidArgumentException Raised if the event type is not supported by this object or if the listener is not a valid JavaScript function. This exception is also raised if the listener has not previously been added.
Members
This is an Event identifier for ToiVideoOutputConfigurationColorSystemChangedEvent.
This event is sent when the color system configuration has changed.
This is an Event identifier for ToiVideoOutputConfigurationConfigurationChangedEvent.
This event is sent when the configuration or allowed configuration of a video output has changed.
This is an Event identifier for ToiVideoOutputConfigurationDisplayCapabilitiesChangedEvent.
This event is sent when the capabilities of a display has changed, for example when a display has been connected or disconnected.
Aspect ratio is 4:3.
Aspect ratio is 16:9 (widescreen).
Aspect ratio is 16:10.
Aspect ratio is not known.
8 bits per channel.
10 bits per channel.
12 bits per channel.
16 bits per channel.
According to CEA-861-E, full (0 to 255*2^(N-8)) range of color data are supported in RGB color space.
According to CEA-861-E, full (0 to 255*2^(N-8)) range of color data are supported in sYCC601/AdobeYCC601 color space. It is here for the sake of completeness as no STB support this yet.
Limited (162^(N-8) to 2352^(N-8) range color.
This mode is similar to NTSC-M except there is no blanking pedestal. It is the analog system broadcast in Japan.
This is the standard 525i60 NTSC system, broadcast in the United States.
This is the standard 625i50 PAL system, broadcast in most European countries. It uses a 4.43 MHz color subcarrier. This value should also be used for PAL D, G, H, I and K systems since the baseband video signal is identical for all of them.
This is a hybrid 525i60 PAL system, broadcast in Brazil. It uses a 3.58 MHz color subcarrier.
This is a 625i50 PAL system with a 3.58 MHz color subcarrier. It is broadcast in some countries in Latin America, such as Paraguay and Uruguay.
This is a 625i50 PAL system with a 3.58 MHz color subcarrier and an increased black level on lines outside the VBI. Also known as PAL Combination N and is broadcast in some countries in Latin America, such as Argentina.
SRGB color space.This is the most common color space for HDMI video.
XVYCC color space. A futuristic color space that is mentioned in the HDMI standard but rarely used. It is here for the sake of completeness as no STB supports this yet.
YCBR420 color space. This is a subsampled version of the above YCBCR modes. The chroma components are sampled at half the luminance component horizontally and vertically thus creating a less accurate but more bandwidth friendly signal.
YCBR422 color space. This is a subsampled version of the above. The chroma components are sampled at half the luminance component horizontally thus creating a less accurate but more bandwidth friendly signal.
YCBR444 color space. This color space represents the full range of the component signal. All components have the same sampling rate so there is no chroma subsampling.
Display is connected and capabilities are known.
Display is connected but capabilities are unknown or invalid.
Display is not connected.
Display status is unknown.
The signal mode will automatically be chosen by probing the connected device.
DVI signal mode. This can be used to force the output into DVI signal mode.
HDMI signal mode. This can be used to force the output into HDMI signal mode.
No data. Gives sink no indication about scan behaviors.
Overscan. Indicates sink that some active pixels and lines at the edges may not be displayed.
Underscan. Indicates sink that all active pixels and lines should be displayed, with or without a border.
Output only composite video on SCART.
Output RGB component video as well as composite video. The composite signal is used for timing only.
Output separate luminance and chrominance signals, i.e. S-video. Note that displays must be manually configured to receive S-video since it is not possible to signal the S-video format in the SCART connector.
Composite connection.
HDMI connection.
SCART connection.
Interlaced scan video mode with 480 active lines and 60Hz vertical frequency.
Progressive scan video mode with 480 active lines and 60Hz vertical frequency.
Interlaced scan video mode with 576 active lines and 50Hz vertical frequency.
Progressive scan video mode with 576 active lines and 50Hz vertical frequency.
Progressive scan video mode with 720 active lines and 50Hz vertical frequency.
Progressive scan video mode with 720 active lines and 60Hz vertical frequency.
Interlaced scan video mode with 1080 active lines and 50Hz vertical frequency.
Interlaced scan video mode with 1080 active lines and 60Hz vertical frequency.
Progressive scan video mode with 1080 active lines and 24Hz vertical frequency.
Progressive scan video mode with 1080 active lines and 25Hz vertical frequency.
Progressive scan video mode with 1080 active lines and 30Hz vertical frequency.
Progressive scan video mode with 1080 active lines and 50Hz vertical frequency.
Progressive scan video mode with 1080 active lines and 60Hz vertical frequency.
Progressive scan video mode with 1080 active lines and 23.976Hz vertical frequency.
Progressive scan video mode with 1080 active lines and 29.970Hz vertical frequency.
Progressive scan video mode with 1080 active lines and 59.940Hz vertical frequency.
Progressive scan video mode with 2160 active lines with 3840 pixels per line and 24Hz vertical frequency.
Progressive scan video mode with 2160 active lines with 4096 pixels per line and 24Hz vertical frequency.
Progressive scan video mode with 2160 active lines and 25Hz vertical frequency.
Progressive scan video mode with 2160 active lines and 30Hz vertical frequency.
Progressive scan video mode with 2160 active lines and 50Hz vertical frequency.
Progressive scan video mode with 2160 active lines with 4096 pixels per line and 50Hz vertical frequency.
Progressive scan video mode with 2160 active lines and 60Hz vertical frequency.
Progressive scan video mode with 2160 active lines with 4096 pixels per line and 60Hz vertical frequency.
Output is in HD.
Output is in SD.
Composite output information.
Struct fields
| Name | Description |
|---|---|
| aspectRatio | The current aspect ratio setting. Type: ToiVideoOutputConfiguration.ToiAspectRatio |
Information about a display. The information is divided into a generic part and an output type specific part. If no display is connected then the corresponding display information will be empty.
Struct fields
| Name | Description |
|---|---|
| hdmi
[optional] |
HDMI display information. This member will only be set if ToiDisplayInfo.Status is DISPLAY_STATUS_CONNECTED. Type: ToiVideoOutputConfiguration.ToiHdmiDisplayInfo |
| outputId | The video output that the display is connected to. Type: ToiVideoOutputConfiguration.ToiVideoOutputId |
| status | Display status information. Type: ToiVideoOutputConfiguration.ToiDisplayStatus |
Information about an HDMI display. The information is collected from the display's EDID.
Struct fields
| Name | Description |
|---|---|
| supportedColorDepths | The color depth values supported by the display. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiColorDepth> (Or a single ToiVideoOutputConfiguration.ToiColorDepth.) |
| supportedColorLevels | The color level values supported by the display. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiColorLevel> (Or a single ToiVideoOutputConfiguration.ToiColorLevel.) |
| supportedColorSpaces | The color space values supported by the display. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiColorSpace> (Or a single ToiVideoOutputConfiguration.ToiColorSpace.) |
| supportedModes | The video modes supported by the display in priority order (most preferred first). Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiVideoMode> (Or a single ToiVideoOutputConfiguration.ToiVideoMode.) |
| supportedScanBehaviors | The scan behavior values supported by the display. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiScanBehavior> (Or a single ToiVideoOutputConfiguration.ToiScanBehavior.) |
HDMI output information.
Struct fields
| Name | Description |
|---|---|
| allowedColorDepths | Allowed color depth values based on the current configuration and restrictions imposed by the display. This is a subset of ConfigurableColorDepths where values not supported by the connected display are removed. The values listed in AllowedColorDepths are the only ones that are guaranteed to work and also the only ones that are, in a normal setup, valid to set with the current output configuration. AllowedColorDepths will be empty if no display is connected to the output. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiColorDepth> (Or a single ToiVideoOutputConfiguration.ToiColorDepth.) |
| allowedColorLevels | Allowed color level values based on the current configuration and restrictions imposed by the display. This is a subset of ConfigurableColorLevels where values not supported by the connected display are removed. The values listed in AllowedColorLevels are the only ones that are guaranteed to work and also the only ones that are, in a normal setup, valid to set with the current output configuration. AllowedColorLevels will be empty if no display is connected to the output. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiColorLevel> (Or a single ToiVideoOutputConfiguration.ToiColorLevel.) |
| allowedColorSpaces | Allowed color spaces based on the current configuration and restrictions imposed by the display. This is a subset of ConfigurableColorSpaces where values not supported by the connected display are removed. The values listed in AllowedColorSpaces are the only ones that are guaranteed to work and also the only ones that are, in a normal setup, valid to set with the current output configuration. AllowedColorSpaces will be empty if no display is connected to the output. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiColorSpace> (Or a single ToiVideoOutputConfiguration.ToiColorSpace.) |
| allowedModes | Allowed modes based on the current configuration and restrictions imposed by the display. This is a subset of ConfigurableModes where modes not supported by the connected display are removed. The modes listed in AllowedModes are the only ones that are guaranteed to work and also the only ones that are, in a normal setup, valid to set with the current output configuration. AllowedModes will be empty if no display is connected to the output. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiVideoMode> (Or a single ToiVideoOutputConfiguration.ToiVideoMode.) |
| allowedScanBehaviors | Allowed scan behavior values based on the current configuration and restrictions imposed by the display. AllowedScanBehaviors will be empty if no display is connected to the output. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiScanBehavior> (Or a single ToiVideoOutputConfiguration.ToiScanBehavior.) |
| allowedSignalModes | Allowed signal modes based on the current configuration. The DVI signaling-mode ToiVideoOutputConfiguration.HDMI_SIGNAL_MODE_DVI can only manage a subset of what HDMI is capable of outputting and is therefore the only mode that can be lacking from AllowedSignalModes. Note: The AllowedSignalModes are not affected by the connected display. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiHdmiSignalMode> (Or a single ToiVideoOutputConfiguration.ToiHdmiSignalMode.) |
| aspectRatio | The current aspect ratio setting. Type: ToiVideoOutputConfiguration.ToiAspectRatio |
| colorDepth | The current color depth setting. Type: ToiVideoOutputConfiguration.ToiColorDepth |
| colorLevel | The current color level setting. Type: ToiVideoOutputConfiguration.ToiColorLevel |
| colorSpace | The current color space setting. Type: ToiVideoOutputConfiguration.ToiColorSpace |
| configurableColorDepths | Configurable color depth values based on the current configuration. This is a a subset of all values that the hardware is capable of outputting (i.e. SupportedColorDepths) when taking into consideration the current output configuration. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiColorDepth> (Or a single ToiVideoOutputConfiguration.ToiColorDepth.) |
| configurableColorLevels | Configurable color level values based on the current configuration. This is a a subset of all values that the hardware is capable of outputting (i.e. SupportedColorLevels) when taking into consideration the current output configuration. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiColorLevel> (Or a single ToiVideoOutputConfiguration.ToiColorLevel.) |
| configurableColorSpaces | Configurable color space values based on the current configuration. This is a subset of all color spaces that the hardware is capable of outputting (i.e. SupportedColorSpaces) when taking into consideration the current output configuration. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiColorSpace> (Or a single ToiVideoOutputConfiguration.ToiColorSpace.) |
| configurableModes | Configurable modes based on the current configuration. This is a a subset of all modes that the hardware is capable of outputting (i.e. SupportedModes) when taking into consideration the current output configuration. For example, ToiVideoOutputConfiguration.VIDEO_MODE_720P60 will not be in the list of available modes if a 50Hz PAL color system (like COLOR_SYSTEM_PAL_B) has previously been configured (with ToiVideoOutputConfigurationSession#configureColorSystem). Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiVideoMode> (Or a single ToiVideoOutputConfiguration.ToiVideoMode.) |
| configurableSignalModes | Configurable signal modes. All the possible signal modes that can be selected if not taking into consideration the current output configuration. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiHdmiSignalMode> (Or a single ToiVideoOutputConfiguration.ToiHdmiSignalMode.) |
| mode | The current video mode setting. Type: ToiVideoOutputConfiguration.ToiVideoMode |
| scanBehavior | The current scan behavior setting. Type: ToiVideoOutputConfiguration.ToiScanBehavior |
| signalMode | The current signal mode setting. Type: ToiVideoOutputConfiguration.ToiHdmiSignalMode |
| supportedColorDepths | Color depth values as supported by the hardware. These are all values that the hardware is capable of outputting. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiColorDepth> (Or a single ToiVideoOutputConfiguration.ToiColorDepth.) |
| supportedColorLevels | Color level values as supported by the hardware. These are all values that the hardware is capable of outputting. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiColorLevel> (Or a single ToiVideoOutputConfiguration.ToiColorLevel.) |
| supportedColorSpaces | Color space values as supported by the hardware. These are all color spaces that the hardware is capable of outputting. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiColorSpace> (Or a single ToiVideoOutputConfiguration.ToiColorSpace.) |
| supportedModes | Video modes as supported by the hardware. These are all modes that the hardware is capable of outputting. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiVideoMode> (Or a single ToiVideoOutputConfiguration.ToiVideoMode.) |
| supportedScanBehaviors | Scan behavior values as supported by the hardware. These are all values that the hardware is capable of outputting. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiScanBehavior> (Or a single ToiVideoOutputConfiguration.ToiScanBehavior.) |
| supportedSignalModes | Signal modes supported by the hardware. All the signal modes that the hardware is capable of outputting. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiHdmiSignalMode> (Or a single ToiVideoOutputConfiguration.ToiHdmiSignalMode.) |
SCART output information.
Struct fields
| Name | Description |
|---|---|
| aspectRatio | The current aspect ratio setting. Type: ToiVideoOutputConfiguration.ToiAspectRatio |
| configurableModes | Configurable SCART modes based on the current configuration. This is a subset of all supported SCART modes that the hardware is capable of outputting (i.e. SupportedModes) when taking into consideration the current output configuration. The modes listed in ConfigurableModes are the only ones that are valid to set with current output configuration. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiScartMode> (Or a single ToiVideoOutputConfiguration.ToiScartMode.) |
| mode | The current SCART mode setting. Type: ToiVideoOutputConfiguration.ToiScartMode |
| supportedModes | SCART modes as supported by the hardware. These are all SCART modes that the hardware is capable of outputting. Note that TOI always provides an Array, even if there is only a single value. Type: Array.<ToiVideoOutputConfiguration.ToiScartMode> (Or a single ToiVideoOutputConfiguration.ToiScartMode.) |
Video output information.
The information is divided into a generic part and an connection type specific part.
Struct fields
| Name | Description |
|---|---|
| composite
[optional] |
Composite output information. This will only be valid if the connection type is ToiVideoOutputConfiguration.VIDEO_CONNECTION_TYPE_COMPOSITE. Type: ToiVideoOutputConfiguration.ToiCompositeOutputInfo |
| connectionType | The type of video connection. Type: ToiVideoOutputConfiguration.ToiVideoConnectionType |
| hdmi
[optional] |
HDMI output information. This will only be valid if the connection type is ToiVideoOutputConfiguration.VIDEO_CONNECTION_TYPE_HDMI. Type: ToiVideoOutputConfiguration.ToiHdmiOutputInfo |
| id | Video output identifier. Type: ToiVideoOutputConfiguration.ToiVideoOutputId |
| isEnabled | Defines whether output is enabled or not. Type: boolean |
| outputType | The type of video output. Type: ToiVideoOutputConfiguration.ToiVideoOutputType |
| scart
[optional] |
SCART output information. This will only be valid if the connection type is ToiVideoOutputConfiguration.VIDEO_CONNECTION_TYPE_SCART. Type: ToiVideoOutputConfiguration.ToiScartOutputInfo |
Events
This is an Event identifier for ToiVideoOutputConfigurationDisplayCapabilitiesChangedEvent.
Value: 3801