IToiVideoOutputConfigurationSession Interface Reference


Description

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";

List of all members.

Public Member Functions

void SetDisplayInfo (in IToiVideoOutputConfiguration::TToiVideoOutputId outputId, in IToiVideoOutputConfiguration::TToiVideoModeSequence modes, in IToiVideoOutputConfiguration::TToiAspectRatio aspectRatio) raises (TToiInvalidArgumentException)
void ResetDisplayInfo (in IToiVideoOutputConfiguration::TToiVideoOutputId outputId)
void SetDefaultVideoMode (in IToiVideoOutputConfiguration::TToiVideoOutputId outputId, in IToiVideoOutputConfiguration::TToiVideoMode mode) raises (TToiOperationNotSupportedException, TToiInvalidArgumentException)
void SetColorSpace (in IToiVideoOutputConfiguration::TToiVideoOutputId outputId, in IToiVideoOutputConfiguration::TToiColorSpace colorSpace) raises (TToiOperationNotSupportedException, TToiInvalidArgumentException)
void SetScartMode (in IToiVideoOutputConfiguration::TToiVideoOutputId outputId, in IToiVideoOutputConfiguration::TToiScartMode mode) raises (TToiOperationNotSupportedException, TToiInvalidArgumentException)
void SetScartLoopThroughMode (in IToiVideoOutputConfiguration::TToiVideoOutputId outputId, in IToiVideoOutputConfiguration::TToiValueMode mode) raises (TToiOperationNotSupportedException, TToiInvalidArgumentException)
void SetDviMode (in IToiVideoOutputConfiguration::TToiVideoOutputId outputId, in IToiVideoOutputConfiguration::TToiValueMode mode) raises (TToiOperationNotSupportedException, TToiInvalidArgumentException)
void SetColorSystem (in IToiVideoOutputConfiguration::TToiColorSystem colorSystem) raises (TToiOperationNotSupportedException, TToiInvalidArgumentException)
void Revert () raises (TToiOperationNotSupportedException)
void Clear ()
void Apply () raises (TToiOperationNotSupportedException)
void ReleaseInstance ()
void GetDisplayInfo (in TToiVideoOutputId outputId, out TToiDisplayInfo info) raises (TToiInvalidArgumentException)
void GetColorSystems (out TToiColorSystemSequence colorSystems)
void GetColorSystem (out TToiColorSystem colorSystem)
void GetVideoOutputs (out TToiVideoOutputIdSequence identifiers)
void GetVideoOutputInfo (in TToiVideoOutputId outputId, out TToiVideoOutputInfo info) raises (TToiOperationNotSupportedException, TToiInvalidArgumentException)
void GetVideoOutputCapabilityInfo (in TToiVideoOutputId outputId, out TToiVideoOutputCapabilityInfo info) raises (TToiOperationNotSupportedException, TToiInvalidArgumentException)
void RegisterObserver (in IToiApplicationService::TToiApplicationId applicationId, in string address) raises (TToiInvalidArgumentException)
void ReleaseObserver (in string address) raises (TToiInvalidArgumentException)

Public Types

enum  TToiColorSystem {
  COLOR_SYSTEM_NTSC_M, COLOR_SYSTEM_NTSC_J, COLOR_SYSTEM_PAL_B, COLOR_SYSTEM_PAL_M,
  COLOR_SYSTEM_PAL_N, COLOR_SYSTEM_PAL_NC
}
enum  TToiVideoMode {
  NO_VIDEO_MODE, VIDEO_MODE_480I60, VIDEO_MODE_576I50, VIDEO_MODE_480P60,
  VIDEO_MODE_576P50, VIDEO_MODE_720P50, VIDEO_MODE_720P60, VIDEO_MODE_1080I50,
  VIDEO_MODE_1080I60, VIDEO_MODE_1080P23976, VIDEO_MODE_1080P24, VIDEO_MODE_1080P25,
  VIDEO_MODE_1080P29970, VIDEO_MODE_1080P30, VIDEO_MODE_1080P50, VIDEO_MODE_1080P59940,
  VIDEO_MODE_1080P60
}
enum  TToiScartMode { NO_SCART_MODE, SCART_MODE_CVBS, SCART_MODE_YC, SCART_MODE_RGB_CVBS }
enum  TToiColorSpace {
  NO_COLOR_SPACE, DIGITAL_COLOR_SPACE_SRGB, DIGITAL_COLOR_SPACE_YCBCR_444, DIGITAL_COLOR_SPACE_YCBCR_422,
  DIGITAL_COLOR_SPACE_XVYCC, ANALOG_COLOR_SPACE_YPBPR
}
enum  TToiValueMode { NO_VALUE_MODE, VALUE_MODE_ENABLED, VALUE_MODE_DISABLED }
enum  TToiVideoConnectionType {
  VIDEO_CONNECTION_TYPE_HDMI, VIDEO_CONNECTION_TYPE_COMPONENT, VIDEO_CONNECTION_TYPE_SCART, VIDEO_CONNECTION_TYPE_COMPOSITE,
  VIDEO_CONNECTION_TYPE_SVIDEO, VIDEO_CONNECTION_TYPE_RF
}
enum  TToiVideoOutputType { VIDEO_OUTPUT_TYPE_HD, VIDEO_OUTPUT_TYPE_SD }
enum  TToiAspectRatio { ASPECT_RATIO_UNKNOWN, ASPECT_RATIO_4_3, ASPECT_RATIO_16_9, ASPECT_RATIO_16_10 }
enum  TToiDisplayStatus { DISPLAY_STATUS_UNKNOWN, DISPLAY_STATUS_CONNECTED, DISPLAY_STATUS_CONNECTED_CAPABILITIES_UNKNOWN, DISPLAY_STATUS_DISCONNECTED }
enum  TToiActiveFormatDescriptor {
  ACTIVE_FORMAT_UNKNOWN, ACTIVE_FORMAT_16_9_TOP, ACTIVE_FORMAT_14_9_TOP, ACTIVE_FORMAT_MORE_THAN_16_9_CENTRE,
  ACTIVE_FORMAT_SAME_AS_CODED, ACTIVE_FORMAT_4_3_CENTRE, ACTIVE_FORMAT_16_9_CENTRE, ACTIVE_FORMAT_14_9_CENTRE,
  ACTIVE_FORMAT_4_3_SHOOT_AND_PROTECT_14_9_CENTRE, ACTIVE_FORMAT_16_9_SHOOT_AND_PROTECT_14_9_CENTRE, ACTIVE_FORMAT_16_9_SHOOT_AND_PROTECT_4_3_CENTRE
}
typedef sequence< TToiColorSystemTToiColorSystemSequence
typedef sequence< TToiVideoModeTToiVideoModeSequence
typedef sequence< TToiScartModeTToiScartModeSequence
typedef sequence< TToiColorSpaceTToiColorSpaceSequence
typedef sequence< TToiValueModeTToiValueModeSequence
typedef unsigned long TToiVideoOutputId
typedef sequence
< TToiVideoOutputId
TToiVideoOutputIdSequence

Member Typedef Documentation

Sequence of TToiColorSpace

typedef unsigned long IToiVideoOutputConfiguration::TToiVideoOutputId [inherited]

Video output identifier.

List of video output identifiers.


Member Enumeration Documentation

Aspect ratio and position of the active area within the video frame.

Enumerator:
ACTIVE_FORMAT_UNKNOWN 

The active format descriptor is not known.

ACTIVE_FORMAT_16_9_TOP 

The active format descriptor is 16:9 top.

ACTIVE_FORMAT_14_9_TOP 

The active format descriptor is 14:9 top.

ACTIVE_FORMAT_MORE_THAN_16_9_CENTRE 

The active format descriptor is > 16:9 centre.

ACTIVE_FORMAT_SAME_AS_CODED 

The active format descriptor is same as coded.

ACTIVE_FORMAT_4_3_CENTRE 

The active format descriptor is 4:3 centre.

ACTIVE_FORMAT_16_9_CENTRE 

The active format descriptor is 16:9 centre.

ACTIVE_FORMAT_14_9_CENTRE 

The active format descriptor is 14:9 centre.

ACTIVE_FORMAT_4_3_SHOOT_AND_PROTECT_14_9_CENTRE 

The active format descriptor is 4:3 with shoot and protect 14:9 centre.

ACTIVE_FORMAT_16_9_SHOOT_AND_PROTECT_14_9_CENTRE 

The active format descriptor is 16:9 with shoot and protect 14:9 centre.

ACTIVE_FORMAT_16_9_SHOOT_AND_PROTECT_4_3_CENTRE 

The active format descriptor is 16:9 with shoot and protect 4:3 centre.

Aspect ratio of display.

Enumerator:
ASPECT_RATIO_UNKNOWN 

Aspect ratio is not known.

ASPECT_RATIO_4_3 

Aspect ratio is 4:3.

ASPECT_RATIO_16_9 

Aspect ratio is 16:9 (widescreen).

ASPECT_RATIO_16_10 

Aspect ratio is 16:10

Enumeration of video color spaces.

Enumerator:
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 
Technical Preview:
This enumerator is a TECHNICAL PREVIEW, it may change.

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 
Technical Preview:
This enumerator is a TECHNICAL PREVIEW, it may change.

YPBPR color space. Analog color space used for analog compoent video

Enumeration of video color systems.

Enumerator:
COLOR_SYSTEM_NTSC_M 

This is the standard 525i60 NTSC system, broadcast in the United States.

COLOR_SYSTEM_NTSC_J 

This mode is similar to NTSC-M except there is no blanking pedestal. It is the analog system broadcast in Japan.

COLOR_SYSTEM_PAL_B 

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.

COLOR_SYSTEM_PAL_M 

This is a hybrid 525i60 PAL system, broadcast in Brazil. It uses a 3.58 MHz color subcarrier.

COLOR_SYSTEM_PAL_N 

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.

COLOR_SYSTEM_PAL_NC 

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.

The display status information.

Enumerator:
DISPLAY_STATUS_UNKNOWN 

Display status is unknown.

DISPLAY_STATUS_CONNECTED 

Display is connected and capabilities are known.

DISPLAY_STATUS_CONNECTED_CAPABILITIES_UNKNOWN 

Display is connected but capabilities are unknown or invalid.

DISPLAY_STATUS_DISCONNECTED 

Display is not connected.

Enumerations of SCART video modes.

Enumerator:
NO_SCART_MODE 

Used when setting is not applicable.

SCART_MODE_CVBS 

Output only composite video on SCART.

SCART_MODE_YC 

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.

SCART_MODE_RGB_CVBS 

Output RGB component video as well as composite video. The composite signal is used for timing only.

Generic values for enabling and disabling different features.

Enumerator:
NO_VALUE_MODE 

N/A value

VALUE_MODE_ENABLED 

Value that indicates enabled feature

VALUE_MODE_DISABLED 

Value that indicates disabled feature

Enumeration of video connection types.

Enumerator:
VIDEO_CONNECTION_TYPE_HDMI 

HDMI connection.

VIDEO_CONNECTION_TYPE_COMPONENT 

Component connection.

VIDEO_CONNECTION_TYPE_SCART 

SCART connection.

VIDEO_CONNECTION_TYPE_COMPOSITE 

Composite connection.

VIDEO_CONNECTION_TYPE_SVIDEO 

S-video connection.

VIDEO_CONNECTION_TYPE_RF 

RF connection.

Enumeration of video modes.

Enumerator:
NO_VIDEO_MODE 

This is the value used for turning off an output.

VIDEO_MODE_480I60 

Interlaced scan video mode with 480 active lines and 60Hz vertical frequency.

VIDEO_MODE_576I50 

Interlaced scan video mode with 576 active lines and 50Hz vertical frequency.

VIDEO_MODE_480P60 

Progressive scan video mode with 480 active lines and 60Hz vertical frequency.

VIDEO_MODE_576P50 

Progressive scan video mode with 576 active lines and 50Hz vertical frequency.

VIDEO_MODE_720P50 

Progressive scan video mode with 720 active lines and 50Hz vertical frequency.

VIDEO_MODE_720P60 

Progressive scan video mode with 720 active lines and 60Hz vertical frequency.

VIDEO_MODE_1080I50 

Interlaced scan video mode with 1080 active lines and 50Hz vertical frequency.

VIDEO_MODE_1080I60 

Interlaced scan video mode with 1080 active lines and 60Hz vertical frequency.

VIDEO_MODE_1080P23976 

Progressive scan video mode with 1080 active lines and 23.976Hz vertical frequency.

VIDEO_MODE_1080P24 

Progressive scan video mode with 1080 active lines and 24Hz vertical frequency.

VIDEO_MODE_1080P25 

Progressive scan video mode with 1080 active lines and 25Hz vertical frequency.

VIDEO_MODE_1080P29970 

Progressive scan video mode with 1080 active lines and 29.970Hz vertical frequency.

VIDEO_MODE_1080P30 

Progressive scan video mode with 1080 active lines and 30Hz vertical frequency.

VIDEO_MODE_1080P50 

Progressive scan video mode with 1080 active lines and 50Hz vertical frequency.

VIDEO_MODE_1080P59940 

Progressive scan video mode with 1080 active lines and 59.940Hz vertical frequency.

VIDEO_MODE_1080P60 

Progressive scan video mode with 1080 active lines and 60Hz vertical frequency.

Enumeration of video output types.

Enumerator:
VIDEO_OUTPUT_TYPE_HD 

Output is in HD.

VIDEO_OUTPUT_TYPE_SD 

Output is in SD.


Member Function Documentation

void IToiVideoOutputConfigurationSession::Apply (  )  raises (TToiOperationNotSupportedException)

Applies the changes made in the configuration session and makes the changes permanent.

Exceptions:
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.

Return values:
colorSystem Current color system.
void IToiVideoOutputConfiguration::GetColorSystems ( out TToiColorSystemSequence  colorSystems  )  [inherited]

Get supported color systems.

Return values:
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.

Parameters:
outputId Video output identifier.
Return values:
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.

Parameters:
outputId Video output identifier.
Return values:
info The video output capability information.
Exceptions:
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.

Parameters:
outputId Video output identifier.
Return values:
info The video output information.
Exceptions:
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.

Return values:
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.

Parameters:
applicationId The identifier of the observing application.
address The address where the IToiVideoOutputConfiguration can find an IToiVideoOutputConfigurationObserver interface.
Exceptions:
TToiInvalidArgumentException Raised if the specified address is invalid or if the application has already registered itself as an observer with the same address.
See also:
IToiVideoOutputConfigurationObserver
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.

Parameters:
address The address where the IToiVideoOutputConfiguration can find the registered IToiVideoOutputConfigurationObserver interface.
Exceptions:
TToiInvalidArgumentException Raised if the specified address is invalid.
See also:
IToiVideoOutputConfigurationObserver
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.

Parameters:
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.

Exceptions:
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.

Parameters:
outputId Output identifier.
colorSpace The new color space.
Exceptions:
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.

Parameters:
colorSystem Color system setting.
Exceptions:
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.

Parameters:
outputId Output identifier.
mode The new output mode.
Exceptions:
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.

Parameters:
outputId Video output identifier.
modes The supported video modes.
aspectRatio The aspect ratio of the display.
Exceptions:
TToiInvalidArgumentException Raised if outputId is an invalid output.

Sets the DVI mode for a video output. Only supported for HDMI outputs.

Parameters:
outputId Output identifier.
mode The new DVI mode.
Exceptions:
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.

Parameters:
outputId Output identifier.
mode The new SCART standby loop through mode.
Exceptions:
TToiOperationNotSupportedException Raised if output can not be set.
TToiInvalidArgumentException Raised if outputId is an invalid output.

Sets the SCART mode for a video output. Only supported for SCART outputs.

Parameters:
outputId Output identifier.
mode The new SCART mode.
Exceptions:
TToiOperationNotSupportedException Raised if output can not be set.
TToiInvalidArgumentException Raised if outputId is an invalid output.