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

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 addEventListener (in long type, in ToiEventListener listener) raises (TToiInvalidArgumentException)
void removeEventListener (in long type, in ToiEventListener listener) raises (TToiInvalidArgumentException)

Public Attributes

Events

const long ON_ADAPTIVE_RULE_CHANGED = 3200

Public Types

typedef sequence
< ToiVideoOutputServiceAdaptiveTransition > 		TToiAdaptiveTransitionSequence
typedef sequence< string > TToiAdaptiveRuleSetNameSequence

Member Typedef Documentation

typedef sequence< string > ToiVideoOutputService::TToiAdaptiveRuleSetNameSequence

Sequence of adaptive video ruleset names.

typedef sequence< ToiVideoOutputServiceAdaptiveTransition > ToiVideoOutputService::TToiAdaptiveTransitionSequence

Sequence of adaptive state transitions.

Member Function Documentation

void ToiEventTarget::addEventListener ( in long  type,
in ToiEventListener  listener 
) raises (TToiInvalidArgumentException) [inherited]

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.

Parameters:
type The event type of the event to subscribe to.
listener The JavaScript function that will receive events.
Exceptions:
TInvalidArgumentException 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.
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.
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 ToiEventTarget::removeEventListener ( in long  type,
in ToiEventListener  listener 
) raises (TToiInvalidArgumentException) [inherited]

This method removes an event listener for a specific event.

Parameters:
type The event type of the event to remove the listener from.
listener The JavaScript function that was previously added as an event listener.
Exceptions:
TInvalidArgumentException 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 had not previously been added.
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.