CTvOutConfig Class Reference

class CTvOutConfig : public CBase

Adaptation API for Tv-out settings

Inherits from

Public Member Functions
~CTvOutConfig()
IMPORT_C TUintApiVersion()
TInt AvailableTvConfigListListener(TRequestStatus &)
TInt AvailableTvConfigListListenerCancel()
TInt CopyProtection(TBool)
TBool CopyProtectionStatus()
TInt CopyProtectionStatusCancel()
TInt CopyProtectionStatusListener(TRequestStatus &)
TInt Disable()
TInt Enable()
TBool Enabled()
TInt GetAvailableTvConfigList(RArray< TTvSettings > &, RArray< THdmiDviTimings > &)
TInt GetConfig(TTvSettings &)
TInt GetConfig(THdmiDviTimings &)
TInt GetNumberOfHdmiModes(TUint &)
TInt GetStandByFigure(TStandByFigure &)
TInt GetSupportedHdmiMode(TUint, TSupportedHdmiDviMode &)
TInt GetTvHwCapabilities(TTvSettings::TOutput, THwCapabilities &)
TBool HdmiCableConnected()
TInt HdmiCableListener(TRequestStatus &)
TInt HdmiCableListenerCancel()
IMPORT_C CTvOutConfig *NewL()
TInt OnOffListener(TRequestStatus &)
TInt OnOffListenerCancel()
TInt SetAvailableTvConfigList(const RArray< TTvSettings > &, const RArray< THdmiDviTimings > &)
TInt SetConfig(const TTvSettings &)
TInt SetConfig(const THdmiDviTimings &)
TInt SettingsChangedListener(TRequestStatus &)
TInt SettingsChangedListenerCancel()
TInt StandByFigure(const TStandByFigure &)
TInt StandByFigureMaxSizeInBytes(TUint &)
Protected Member Functions
CTvOutConfig()
voidConstructL()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()

Constructor & Destructor Documentation

CTvOutConfig()

CTvOutConfig()[protected, inline]

~CTvOutConfig()

~CTvOutConfig()[inline, virtual]

Member Functions Documentation

ApiVersion()

IMPORT_C TUintApiVersion()[static]

Gets API version number. Compare this to KTvOutConfigVersion, must match.

AvailableTvConfigListListener(TRequestStatus &)

TInt AvailableTvConfigListListener(TRequestStatus &aListenerRequest)[pure virtual]

Listener for SetAvailableTvConfigList() Check always aListenerRequest.Int(), it is KErrNone when normal operation.

Parameters

TRequestStatus & aListenerRequestWill be completed without errors when SetAvailableTvConfigList is called

AvailableTvConfigListListenerCancel()

TInt AvailableTvConfigListListenerCancel()[pure virtual]

Cancels listener, AvailableTvConfigListListener

ConstructL()

voidConstructL()[protected, pure virtual]

CopyProtection(TBool)

TInt CopyProtection(TBoolaCopyProtectEnabled)[pure virtual]

Enables/disables HDCP/Macrovision on Tv-output. All clients of CTvOutConfig has to disable protection, before protection on output can be disabled. CopyProtectionStatus() will be completed when protection state is changed (not necessarily ever).

ETrue = When client wants to enable protection. Protection is enabled after CopyProtectionStatus() returns ETrue (after listener). If sink does not support e.g. the HDCP, adaptation will try to enable that periodically and will trigger the listener when success and state changes.

EFalse = When client wants to disable protection. If any other CTvOutConfig's client is not called this method with ETrue, output will be unprotected after CopyProtectionStatusListener(). When HDCP is dropped out (CopyProtectionStatusListener()), this method should be called with EFalse (before next try with ETrue), that tells for adaptation that buffer content can be shown on Tv without protection.

Parameters

TBool aCopyProtectEnabledETrue when output is wanted to be protected

CopyProtectionStatus()

TBool CopyProtectionStatus()[pure virtual]
Asks is HDCP/macrovision enabled or not at the moment in Tv-output.
Pre-condition
Tv-out is enabled (Enabled() returns ETrue)

CopyProtectionStatusCancel()

TInt CopyProtectionStatusCancel()[pure virtual]

Cancels listener, CopyProtectionStatusListener

CopyProtectionStatusListener(TRequestStatus &)

TInt CopyProtectionStatusListener(TRequestStatus &aListenerRequest)[pure virtual]

Listener for status of copy protection (e.g. HDCP). After this, check newest status with CopyProtectionStatus() HDCP may drop off with CopyProtection(EFalse) or when authentication is failed. CopyProtectionStatus()

Parameters

TRequestStatus & aListenerRequestWill be completed without errors when HDCP status in output will change (ESS)

Disable()

TInt Disable()[pure virtual]
Disables Tv-out.
Pre-condition
Enable() is called without errors.

Enable()

TInt Enable()[pure virtual]
Enables Tv-out. Latest SetConfig() settings are used.
Pre-condition
SetConfig() is called without errors.

Enabled()

TBool Enabled()[pure virtual]

Asks is TV-out enabled or not

GetAvailableTvConfigList(RArray< TTvSettings > &, RArray< THdmiDviTimings > &)

TInt GetAvailableTvConfigList(RArray< TTvSettings > &aAnalogConfigs,
RArray< THdmiDviTimings > &aHdmiConfigs
)[pure virtual]

Get list of available Tv-configurations

Parameters

RArray< TTvSettings > & aAnalogConfigsAvailable Analog Tv configurations
RArray< THdmiDviTimings > & aHdmiConfigsAvailable HDMI/DVI Tv configurations

GetConfig(TTvSettings &)

TInt GetConfig(TTvSettings &aTvSettings)[pure virtual]

Use CTvOutConfig::OnOffListener method, when Tv is enabled, then new settings can be read using this method.

If this read fails, try also read overloaded version for THdmiDviTimings reading, and vice versa. Latest set version of GetConfig can only return without error, that is the version what is currently used in HW (TTvSettings/THdmiDviTimings)

Pre-condition
SetConfig is called without errors

Parameters

TTvSettings & aTvSettingsObject which contains wanted setting (e.g. PAL/NTSC/...)

GetConfig(THdmiDviTimings &)

TInt GetConfig(THdmiDviTimings &aTvSettings)[pure virtual]

Parameters

THdmiDviTimings & aTvSettings

GetNumberOfHdmiModes(TUint &)

TInt GetNumberOfHdmiModes(TUint &aNumberOfModes)[pure virtual]

Reads number of supported modes what to be called with GetSupportedHdmiMode. GetSupportedHdmiMode

Parameters

TUint & aNumberOfModesMethod fills these for caller

GetStandByFigure(TStandByFigure &)

TInt GetStandByFigure(TStandByFigure &aStandByFigure)[pure virtual]
Gets user defined figure to show on tv. Deprecated since TB10.2. CTvOutConfig::StandByFigureMaxSizeInBytes for getting size of TStandByFigure.iTable.
Pre-condition
StandByFigure() is called without errors.

Parameters

TStandByFigure & aStandByFigureTStandByFigure object.

GetSupportedHdmiMode(TUint, TSupportedHdmiDviMode &)

TInt GetSupportedHdmiMode(TUintaModeNumber,
TSupportedHdmiDviMode &aReadMode
)[pure virtual]

Reads supported modes of HDMI hardware GetNumberOfHdmiModes

Parameters

TUint aModeNumberMode number, begins from 0, up to GetNumberOfHdmiModes.
TSupportedHdmiDviMode & aReadModeMethod fills these for caller

GetTvHwCapabilities(TTvSettings::TOutput, THwCapabilities &)

TInt GetTvHwCapabilities(TTvSettings::TOutputaConnector,
THwCapabilities &aReadCapabilities
)[pure virtual]

Reads capabilities of own HDMI hardware.

Parameters

TTvSettings::TOutput aConnectorCapabilities to be fetched for this connector type
THwCapabilities & aReadCapabilitiesMethod fills these for caller

HdmiCableConnected()

TBool HdmiCableConnected()[pure virtual]

Asks is HDMI-cable connected or not

HdmiCableListener(TRequestStatus &)

TInt HdmiCableListener(TRequestStatus &aListenerRequest)[pure virtual]

Adds listener for HDMI connected/disconnected situations. Check always aListenerRequest.Int(), it is KErrNone when normal operation.

Parameters

TRequestStatus & aListenerRequestWill be completed without errors when HDMI cable connected/disconnected

HdmiCableListenerCancel()

TInt HdmiCableListenerCancel()[pure virtual]

Cancels listener, HdmiCableListener

NewL()

IMPORT_C CTvOutConfig *NewL()[static]

Creates object. Method requires ECapabilityReadDeviceData capability. TvOutConfig.h TvOutConfig.h

OnOffListener(TRequestStatus &)

TInt OnOffListener(TRequestStatus &aListenerRequest)[pure virtual]

Adds listener for tv-out enable/disable situations. Check always aListenerRequest.Int(), it is KErrNone when normal operation.

Parameters

TRequestStatus & aListenerRequestWill be completed without errors when tv-out changing state to on or off.

OnOffListenerCancel()

TInt OnOffListenerCancel()[pure virtual]

Cancels listener, OnOffListener

SetAvailableTvConfigList(const RArray< TTvSettings > &, const RArray< THdmiDviTimings > &)

TInt SetAvailableTvConfigList(const RArray< TTvSettings > &aAnalogConfigs,
const RArray< THdmiDviTimings > &aHdmiConfigs
)[pure virtual]

Set list of available Tv-configurations

Parameters

const RArray< TTvSettings > & aAnalogConfigsAvailable Analog Tv configurations
const RArray< THdmiDviTimings > & aHdmiConfigsAvailable HDMI/DVI Tv configurations

SetConfig(const TTvSettings &)

TInt SetConfig(const TTvSettings &aTvSettings)[pure virtual]

Before Tv-out using, SetConfig must be called (during boot and always when settings or connector are changed). Fill correct values to TTvSettings object and give it by parameter.

Some settings can be changed on the fly (while tv-out enabled, some settings will be in use only after Tv-out Disable()/Enable() sequency. For example, if e.g. overscan is changed on the fly, client gives same early filled struct but only overscan members are different. KErrNone will be returned if change was success, if HW cannot change settings on the fly (without Disable()/Enable()) then KErrNotReady is returned. When KErrNotReady is returned, settings are needed to write with KErrNone after Disable() and before Enable()

If this is called, THdmiDviTimings will not be used anymore and vice versa.

Parameters

const TTvSettings & aTvSettingsObject which contains wanted setting (e.g. PAL/NTSC/...)

SetConfig(const THdmiDviTimings &)

TInt SetConfig(const THdmiDviTimings &aTvSettings)[pure virtual]

Parameters

const THdmiDviTimings & aTvSettings

SettingsChangedListener(TRequestStatus &)

TInt SettingsChangedListener(TRequestStatus &aListenerRequest)[pure virtual]

Adds listener for changed settings Check always aListenerRequest.Int(), it is KErrNone when normal operation.

Parameters

TRequestStatus & aListenerRequestWill be completed without errors when HDMI cable connected/disconnected

SettingsChangedListenerCancel()

TInt SettingsChangedListenerCancel()[pure virtual]

Cancels listener, SettingsChangedListener

StandByFigure(const TStandByFigure &)

TInt StandByFigure(const TStandByFigure &aStandByFigure)[pure virtual]
Sets user defined figure to show on tv. Deprecated since TB10.2.
Pre-condition
SetConfig() is called without errors.

Parameters

const TStandByFigure & aStandByFigureTStandByFigure object.

StandByFigureMaxSizeInBytes(TUint &)

TInt StandByFigureMaxSizeInBytes(TUint &aMaxFigureSize)[pure virtual]

Returns maximum size of TStandByFigure.iTable in bytes. Deprecated since TB10.2.

Parameters

TUint & aMaxFigureSizeMax size of standByFigure in bytes