The IToiVideoOutputConfigurationSession interface allows session based changes of video output settings. If a display is (dis)connected or changed during a session (see IToiVideoOutputConfigurationObserver::OnDisplayChanged() ) while Apply() is not called for outstanding changes, the session must be either cleared or released. A call to Apply() in other cases result in undefined behavior. Releasing the session instance has the benefit of a new revert-point that matches the fall-back settings of the new display.
import "IToiVideoOutputConfigurationSession.idl";
typedef sequence< TToiColorSpace > IToiVideoOutputConfiguration::TToiColorSpaceSequence [inherited] |
Sequence of TToiColorSpace
typedef sequence< TToiColorSystem > IToiVideoOutputConfiguration::TToiColorSystemSequence [inherited] |
Sequence of TToiColorSystem
typedef sequence< TToiScartMode > IToiVideoOutputConfiguration::TToiScartModeSequence [inherited] |
Sequence of TToiScartMode.
typedef sequence< TToiValueMode > IToiVideoOutputConfiguration::TToiValueModeSequence [inherited] |
Sequence of TToiValueMode
typedef sequence< TToiVideoMode > IToiVideoOutputConfiguration::TToiVideoModeSequence [inherited] |
Sequence of TToiVideoMode
typedef unsigned long IToiVideoOutputConfiguration::TToiVideoOutputId [inherited] |
Video output identifier.
typedef sequence< TToiVideoOutputId > IToiVideoOutputConfiguration::TToiVideoOutputIdSequence [inherited] |
List of video output identifiers.
enum IToiVideoOutputConfiguration::TToiActiveFormatDescriptor [inherited] |
Aspect ratio and position of the active area within the video frame.
enum IToiVideoOutputConfiguration::TToiAspectRatio [inherited] |
enum IToiVideoOutputConfiguration::TToiColorSpace [inherited] |
Enumeration of video color spaces.
NO_COLOR_SPACE |
No color space. |
DIGITAL_COLOR_SPACE_SRGB |
SRGB color space.This is the most common color space for HDMI video. |
DIGITAL_COLOR_SPACE_YCBCR_444 |
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. |
DIGITAL_COLOR_SPACE_YCBCR_422 |
YCBR422 color space. This is a subsampled version of the above. The chroma components are sampled at half the luminance component thus creating a less accurate but more bandwidth friendly signal. |
DIGITAL_COLOR_SPACE_XVYCC |
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. |
ANALOG_COLOR_SPACE_YPBPR |
YPBPR color space. Analog color space used for analog compoent video |
enum IToiVideoOutputConfiguration::TToiColorSystem [inherited] |
Enumeration of video color systems.
enum IToiVideoOutputConfiguration::TToiDisplayStatus [inherited] |
The display status information.
enum IToiVideoOutputConfiguration::TToiScartMode [inherited] |
Enumerations of SCART video modes.
enum IToiVideoOutputConfiguration::TToiValueMode [inherited] |
enum IToiVideoOutputConfiguration::TToiVideoConnectionType [inherited] |
Enumeration of video connection types.
enum IToiVideoOutputConfiguration::TToiVideoMode [inherited] |
Enumeration of video modes.
enum IToiVideoOutputConfiguration::TToiVideoOutputType [inherited] |
void IToiVideoOutputConfigurationSession::Apply | ( | ) | raises (TToiOperationNotSupportedException) |
Applies the changes made in the configuration session and makes the changes permanent.
TToiOperationNotSupportedException | Raised if apply cannot be performed. |
void IToiVideoOutputConfigurationSession::Clear | ( | ) |
Clears this configuration session to a clean state.
void IToiVideoOutputConfiguration::GetColorSystem | ( | out TToiColorSystem | colorSystem | ) | [inherited] |
Get current color system.
colorSystem | Current color system. |
void IToiVideoOutputConfiguration::GetColorSystems | ( | out TToiColorSystemSequence | colorSystems | ) | [inherited] |
Get supported color systems.
colorSystems | Supported color systems. |
void IToiVideoOutputConfiguration::GetDisplayInfo | ( | in TToiVideoOutputId | outputId, | |
out TToiDisplayInfo | info | |||
) | raises (TToiInvalidArgumentException) [inherited] |
Returns information about the display connected to a video output. This is primarily used for HDMI outputs that may receive EDID information. It is possible to override capabilities of a display using IToiVideoOutputConfigurationSession::SetDisplayInfo(). If there are no overrides, GetDisplayInfo() returns information from the EDID in the case of HDMI and default values for other outputs. If overrides have been set, these are returned instead.
outputId | Video output identifier. |
info | Information for available displays. |
void IToiVideoOutputConfiguration::GetVideoOutputCapabilityInfo | ( | in TToiVideoOutputId | outputId, | |
out TToiVideoOutputCapabilityInfo | info | |||
) | raises (TToiOperationNotSupportedException, TToiInvalidArgumentException) [inherited] |
Get capability information about a video output.
outputId | Video output identifier. |
info | The video output capability information. |
TToiOperationNotSupportedException | Raised if outputs can not be listed. | |
TToiInvalidArgumentException | Raised if outputId is an invalid output. |
void IToiVideoOutputConfiguration::GetVideoOutputInfo | ( | in TToiVideoOutputId | outputId, | |
out TToiVideoOutputInfo | info | |||
) | raises (TToiOperationNotSupportedException, TToiInvalidArgumentException) [inherited] |
Get information about current settings for a video output.
outputId | Video output identifier. |
info | The video output information. |
TToiOperationNotSupportedException | Raised if outputs can not be listed. | |
TToiInvalidArgumentException | Raised if outputId is an invalid output. |
void IToiVideoOutputConfiguration::GetVideoOutputs | ( | out TToiVideoOutputIdSequence | identifiers | ) | [inherited] |
Returns available video outputs.
identifiers | List of video output identifiers. |
void IToiVideoOutputConfiguration::RegisterObserver | ( | in IToiApplicationService::TToiApplicationId | applicationId, | |
in string | address | |||
) | raises (TToiInvalidArgumentException) [inherited] |
Register an observer of type IToiVideoOutputConfigurationObserver. The observer will receive events sent by this IToiVideoOutputConfiguration instance.
applicationId | The identifier of the observing application. | |
address | The address where the IToiVideoOutputConfiguration can find an IToiVideoOutputConfigurationObserver interface. |
TToiInvalidArgumentException | Raised if the specified address is invalid or if the application has already registered itself as an observer with the same address. |
void IToiVideoOutputConfigurationSession::ReleaseInstance | ( | ) |
This function releases the resources used by this instance and ends the configuration session. If Apply() has not been called, the session configuration is lost. When this function returns all observers has also been released.
void IToiVideoOutputConfiguration::ReleaseObserver | ( | in string | address | ) | raises (TToiInvalidArgumentException) [inherited] |
Release an observer previously registered with RegisterObserver.
address | The address where the IToiVideoOutputConfiguration can find the registered IToiVideoOutputConfigurationObserver interface. |
TToiInvalidArgumentException | Raised if the specified address is invalid. |
void IToiVideoOutputConfigurationSession::ResetDisplayInfo | ( | in IToiVideoOutputConfiguration::TToiVideoOutputId | outputId | ) |
Resets display information that has been overridden using SetDisplayInfo(). The overridden values are reset to values retrieved from the EDID if one is available, otherwise default values.
outputId | Video output identifier. |
void IToiVideoOutputConfigurationSession::Revert | ( | ) | raises (TToiOperationNotSupportedException) |
Reverts a configuration session to the state it had when first being created, even if changes have been applied. The reverted configuration is not applied until Apply() is called.
TToiOperationNotSupportedException | Raised if a revert cannot be performed. |
void IToiVideoOutputConfigurationSession::SetColorSpace | ( | in IToiVideoOutputConfiguration::TToiVideoOutputId | outputId, | |
in IToiVideoOutputConfiguration::TToiColorSpace | colorSpace | |||
) | raises (TToiOperationNotSupportedException, TToiInvalidArgumentException) |
Configures the color space of the video.
outputId | Output identifier. | |
colorSpace | The new color space. |
TToiOperationNotSupportedException | Raised if output can not be set. | |
TToiInvalidArgumentException | Raised if outputId is an invalid output. |
void IToiVideoOutputConfigurationSession::SetColorSystem | ( | in IToiVideoOutputConfiguration::TToiColorSystem | colorSystem | ) | raises (TToiOperationNotSupportedException, TToiInvalidArgumentException) |
Set color system, e.g. NTSC or PAL.
colorSystem | Color system setting. |
TToiOperationNotSupportedException | Raised if color system can not be changed. | |
TToiInvalidArgumentException | Raised if colorSystemSetting not is supported. |
void IToiVideoOutputConfigurationSession::SetDefaultVideoMode | ( | in IToiVideoOutputConfiguration::TToiVideoOutputId | outputId, | |
in IToiVideoOutputConfiguration::TToiVideoMode | mode | |||
) | raises (TToiOperationNotSupportedException, TToiInvalidArgumentException) |
Configures the default video output mode. This will be used when no adaptive video mode rules are applicable.
outputId | Output identifier. | |
mode | The new output mode. |
TToiOperationNotSupportedException | Raised if output can not be set. | |
TToiInvalidArgumentException | Raised if outputId is an invalid output. |
void IToiVideoOutputConfigurationSession::SetDisplayInfo | ( | in IToiVideoOutputConfiguration::TToiVideoOutputId | outputId, | |
in IToiVideoOutputConfiguration::TToiVideoModeSequence | modes, | |||
in IToiVideoOutputConfiguration::TToiAspectRatio | aspectRatio | |||
) | raises (TToiInvalidArgumentException) |
Sets information about the display connected to a video output. This is primarily used to give information about displays that cannot provide this information themselves, but can also be used to override the video output capabilites of a display, e.g. if a TV set supports other settings than the EDID indicates.
outputId | Video output identifier. | |
modes | The supported video modes. | |
aspectRatio | The aspect ratio of the display. |
TToiInvalidArgumentException | Raised if outputId is an invalid output. |
void IToiVideoOutputConfigurationSession::SetDviMode | ( | in IToiVideoOutputConfiguration::TToiVideoOutputId | outputId, | |
in IToiVideoOutputConfiguration::TToiValueMode | mode | |||
) | raises (TToiOperationNotSupportedException, TToiInvalidArgumentException) |
Sets the DVI mode for a video output. Only supported for HDMI outputs.
outputId | Output identifier. | |
mode | The new DVI mode. |
TToiOperationNotSupportedException | Raised if output can not be set. | |
TToiInvalidArgumentException | Raised if outputId is an invalid output. |
void IToiVideoOutputConfigurationSession::SetScartLoopThroughMode | ( | in IToiVideoOutputConfiguration::TToiVideoOutputId | outputId, | |
in IToiVideoOutputConfiguration::TToiValueMode | mode | |||
) | raises (TToiOperationNotSupportedException, TToiInvalidArgumentException) |
Sets the SCART standby loop through mode for a video output. Only supported for SCART outputs.
outputId | Output identifier. | |
mode | The new SCART standby loop through mode. |
TToiOperationNotSupportedException | Raised if output can not be set. | |
TToiInvalidArgumentException | Raised if outputId is an invalid output. |
void IToiVideoOutputConfigurationSession::SetScartMode | ( | in IToiVideoOutputConfiguration::TToiVideoOutputId | outputId, | |
in IToiVideoOutputConfiguration::TToiScartMode | mode | |||
) | raises (TToiOperationNotSupportedException, TToiInvalidArgumentException) |
Sets the SCART mode for a video output. Only supported for SCART outputs.
outputId | Output identifier. | |
mode | The new SCART mode. |
TToiOperationNotSupportedException | Raised if output can not be set. | |
TToiInvalidArgumentException | Raised if outputId is an invalid output. |