IToiVideoOutputService Interface Reference


Description

The Video Output Service is used to get and set video output configurations. It is also used to setup adaptive video mode rule sets. Adaptive video mode rule sets are mainly used to handle automatic aspect ratio conversion upon changes in the currently displayed video content. Adaptive video mode rule sets are defined at build time.

The Video Output service is also used to create instances of configuration sessions to modify the current video mode settings.

import "IToiVideoOutputService.idl";

List of all members.

Public Member Functions

void GetVideoConfiguration (out string address)
void CreateVideoConfigurationSession (in IToiApplicationService::TToiApplicationId applicationId, out string address) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)
void SetVideoSafeMode () raises (TToiInvalidPreconditionException)
void LoadAdaptiveRuleSets (in TToiAdaptiveRuleSetNameSequence adaptiveRuleSets) raises (TToiNotEnoughResourcesException, TToiInvalidArgumentException)
void GetAvailableAdaptiveRuleSetNames (out TToiAdaptiveRuleSetNameSequence adaptiveRuleSets)
void GetLoadedAdaptiveRuleSetNames (out TToiAdaptiveRuleSetNameSequence adaptiveRuleSets)
void RegisterObserver (in IToiApplicationService::TToiApplicationId applicationId, in string address) raises (TToiInvalidArgumentException)
void ReleaseObserver (in string address) raises (TToiInvalidArgumentException)

Classes

struct  TToiAdaptiveTransition

Public Types

typedef sequence
< TToiAdaptiveTransition
TToiAdaptiveTransitionSequence
typedef sequence< string > TToiAdaptiveRuleSetNameSequence

Member Typedef Documentation

Sequence of adaptive video ruleset names.

Sequence of adaptive state transitions.


Member Function Documentation

void IToiVideoOutputService::CreateVideoConfigurationSession ( in IToiApplicationService::TToiApplicationId  applicationId,
out string  address 
) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)

This method creates a session that makes it possible to change the video output configuration.

Parameters:
applicationId Identifier of the calling application.
Return values:
address Address to an IToiVideoOutputConfigurationSession interface.
Exceptions:
TToiInvalidArgumentException Raised if the specified application identifier is invalid.
TToiInvalidPreconditionException Raised if another session is active.
void IToiVideoOutputService::GetAvailableAdaptiveRuleSetNames ( out TToiAdaptiveRuleSetNameSequence  adaptiveRuleSets  ) 

Get a sequence of rule set names based on the available adaptive video rule sets that can be loaded.

Return values:
adaptiveRuleSets A sequence of rule sets names.
void IToiVideoOutputService::GetLoadedAdaptiveRuleSetNames ( out TToiAdaptiveRuleSetNameSequence  adaptiveRuleSets  ) 

Get a sequence of rule set names based on the adaptive video rule sets that have been loaded.

Return values:
adaptiveRuleSets A sequence of rule sets names.
void IToiVideoOutputService::GetVideoConfiguration ( out string  address  ) 

This method returns an address to the current video output configuration.

Return values:
address Address to an IToiVideoOutputConfiguration interface.
void IToiVideoOutputService::LoadAdaptiveRuleSets ( in TToiAdaptiveRuleSetNameSequence  adaptiveRuleSets  )  raises (TToiNotEnoughResourcesException, TToiInvalidArgumentException)

Loads a sequence of adaptive video rule sets based on their names. An empty sequence will unload all currently loaded rule sets. Each rule within a loaded rule set is evaluated in the order it is placed and all rule sets are evaluated in parallel.

Parameters:
adaptiveRuleSets A sequence of rule set names.
Exceptions:
TToiNotEnoughResourcesException Raised if necessary resource can not be allocated.
TToiInvalidArgumentException Raised if the ruleset is unavailable.
void IToiVideoOutputService::RegisterObserver ( in IToiApplicationService::TToiApplicationId  applicationId,
in string  address 
) raises (TToiInvalidArgumentException)

Register an observer of type IToiVideoOutputObserver. The observer will receive events sent by this IToiVideoOutputService instance.

Parameters:
applicationId The identifier of the observing application.
address The address where the IToiVideoOutputService can find an IToiVideoOutputObserver 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:
IToiVideoOutputObserver
void IToiVideoOutputService::ReleaseObserver ( in string  address  )  raises (TToiInvalidArgumentException)

Release an observer previously registered with RegisterObserver.

Parameters:
address The address where the IToiVideoOutputService can find the registered IToiVideoOutputObserver interface.
Exceptions:
TToiInvalidArgumentException Raised if the specified address is invalid.
See also:
IToiVideoOutputObserver
void IToiVideoOutputService::SetVideoSafeMode (  )  raises (TToiInvalidPreconditionException)

Sets the video outputs into a safe mode configuration.

Exceptions:
TToiInvalidPreconditionException Raised if a configuration session is active.