ToiVideoOutputService Interface Reference

---

Description

Service:

This is a service and can be accessed through toi.videoOutputService

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 "ToiVideoOutputService.idl";

Inheritance diagram for ToiVideoOutputService:

List of all members.

Public Member Functions
ToiVideoOutputConfiguration	getVideoConfiguration ()
ToiVideoOutputConfigurationSession	createVideoConfigurationSession () raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)
void	setVideoSafeMode () raises (TToiInvalidPreconditionException)
void	loadAdaptiveRuleSets (in TToiAdaptiveRuleSetNameSequence adaptiveRuleSets) raises (TToiNotEnoughResourcesException, TToiInvalidArgumentException)
TToiAdaptiveRuleSetNameSequence	getAvailableAdaptiveRuleSetNames ()
TToiAdaptiveRuleSetNameSequence	getLoadedAdaptiveRuleSetNames ()
void	setAdaptiveTrigger (in string name, in string value) raises (TToiInvalidArgumentException)
TToiAdaptiveTriggerSequence	getAdaptiveTriggers ()
Public Attributes
const string	TRIGGER_NO_VALUE = ""
Events
const long	ON_ADAPTIVE_RULE_CHANGED = 3200
Public Types
typedef sequence < ToiVideoOutputServiceAdaptiveTransition >	TToiAdaptiveTransitionSequence
typedef sequence< string >	TToiAdaptiveRuleSetNameSequence
typedef sequence < ToiVideoOutputServiceAdaptiveTrigger >	TToiAdaptiveTriggerSequence

---

Member Typedef Documentation

typedef sequence< string > ToiVideoOutputService::TToiAdaptiveRuleSetNameSequence

Sequence of adaptive video ruleset names.

typedef sequence< ToiVideoOutputServiceAdaptiveTransition > ToiVideoOutputService::TToiAdaptiveTransitionSequence

Sequence of adaptive state transitions.

typedef sequence< ToiVideoOutputServiceAdaptiveTrigger > ToiVideoOutputService::TToiAdaptiveTriggerSequence

Technical Preview:

This typedef is a TECHNICAL PREVIEW, it may change. Sequence of adaptive trigger information.

---

Member Function Documentation

ToiVideoOutputConfigurationSession ToiVideoOutputService::createVideoConfigurationSession

(

)

raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)

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

Return values:

IToiVideoOutputConfigurationSession

ToiVideoOutputConfigurationSession interface.

Exceptions:

TToiInvalidArgumentException	Raised if the specified application identifier is invalid.
TToiInvalidPreconditionException	Raised if another session is active.

TToiAdaptiveTriggerSequence ToiVideoOutputService::getAdaptiveTriggers

(

)

Technical Preview:

This method is a TECHNICAL PREVIEW, it may change. Get the list of information about the active Adaptive triggers, which are the triggers that have any values other than the ToiVideoOutputService::TRIGGER_NO_VALUE.

Return values:

triggers

List of the active triggers.

TToiAdaptiveRuleSetNameSequence ToiVideoOutputService::getAvailableAdaptiveRuleSetNames

(

)

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.

TToiAdaptiveRuleSetNameSequence ToiVideoOutputService::getLoadedAdaptiveRuleSetNames

(

)

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.

ToiVideoOutputConfiguration ToiVideoOutputService::getVideoConfiguration

(

)

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

Return values:

IToiVideoOutputConfiguration
address	Address to an ToiVideoOutputConfiguration interface.

void ToiVideoOutputService::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 ToiVideoOutputService::setAdaptiveTrigger	(	in string	name,
		in string	value
	)		raises (TToiInvalidArgumentException)

Technical Preview:

This method is a TECHNICAL PREVIEW, it may change. Sets the value of the given adaptive trigger. Setting the value to ToiVideoOutputService::TRIGGER_NO_VALUE will deactivate the trigger.

Parameters:

name	The name of the adaptive trigger to set.
value	The value to set. It can be any application defined value, plus the predefined ToiVideoOutputService::TRIGGER_NO_VALUE.

Exceptions:

TToiInvalidArgumentException

Raised if the trigger name is empty.

void ToiVideoOutputService::setVideoSafeMode

(

)

raises (TToiInvalidPreconditionException)

Sets the video outputs into a safe mode configuration.

Exceptions:

TToiInvalidPreconditionException

Raised if a configuration session is active.

---

Member Data Documentation

const long ToiVideoOutputService::ON_ADAPTIVE_RULE_CHANGED = 3200

This is an Event identifier for ToiVideoOutputAdaptiveRuleChangedEvent.

This constant can also be accessed from toi.consts.ToiVideoOutputService.ON_ADAPTIVE_RULE_CHANGED.

const string ToiVideoOutputService::TRIGGER_NO_VALUE = ""

Technical Preview:

This const is a TECHNICAL PREVIEW, it may change. Define a trigger with no value to deactivate the trigger.

This constant can also be accessed from toi.consts.ToiVideoOutputService.TRIGGER_NO_VALUE.