CTvOutConfig Class Reference
class CTvOutConfig : public CBase |
Adaptation API for Tv-out settings
Constructor & Destructor Documentation
CTvOutConfig()
CTvOutConfig | ( | ) | [protected, inline] |
~CTvOutConfig()
~CTvOutConfig | ( | ) | [inline, virtual] |
Member Functions Documentation
ApiVersion()
IMPORT_C TUint | ApiVersion | ( | ) | [static] |
Gets API version number. Compare this to KTvOutConfigVersion, must match.
AvailableTvConfigListListener(TRequestStatus &)
Parameters
TRequestStatus & aListenerRequest | Will be completed without errors when SetAvailableTvConfigList is called |
AvailableTvConfigListListenerCancel()
TInt
| AvailableTvConfigListListenerCancel | ( | ) | [pure virtual] |
ConstructL()
void | ConstructL | ( | ) | [protected, pure virtual] |
CopyProtection(TBool)
TInt
| CopyProtection | ( | TBool | aCopyProtectEnabled | ) | [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 aCopyProtectEnabled | ETrue 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] |
CopyProtectionStatusListener(TRequestStatus &)
Parameters
TRequestStatus & aListenerRequest | Will 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] |
Enabled()
TBool
| Enabled | ( | ) | [pure virtual] |
Asks is TV-out enabled or not
GetAvailableTvConfigList(RArray< TTvSettings > &, RArray< THdmiDviTimings > &)
Get list of available Tv-configurations
GetConfig(TTvSettings &)
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 & aTvSettings | Object which contains wanted setting (e.g. PAL/NTSC/...) |
GetConfig(THdmiDviTimings &)
GetNumberOfHdmiModes(TUint &)
TInt
| GetNumberOfHdmiModes | ( | TUint & | aNumberOfModes | ) | [pure virtual] |
Parameters
TUint & aNumberOfModes | Method fills these for caller |
GetStandByFigure(TStandByFigure &)
GetSupportedHdmiMode(TUint, TSupportedHdmiDviMode &)
Parameters
TUint aModeNumber | Mode number, begins from 0, up to GetNumberOfHdmiModes. |
TSupportedHdmiDviMode & aReadMode | Method fills these for caller |
GetTvHwCapabilities(TTvSettings::TOutput, THwCapabilities &)
Reads capabilities of own HDMI hardware.
HdmiCableConnected()
TBool
| HdmiCableConnected | ( | ) | [pure virtual] |
Asks is HDMI-cable connected or not
HdmiCableListener(TRequestStatus &)
Adds listener for HDMI connected/disconnected situations. Check always aListenerRequest.Int(), it is KErrNone when normal operation.
Parameters
TRequestStatus & aListenerRequest | Will be completed without errors when HDMI cable connected/disconnected |
HdmiCableListenerCancel()
TInt
| HdmiCableListenerCancel | ( | ) | [pure virtual] |
NewL()
Creates object. Method requires ECapabilityReadDeviceData capability. TvOutConfig.h TvOutConfig.h
OnOffListener(TRequestStatus &)
Adds listener for tv-out enable/disable situations. Check always aListenerRequest.Int(), it is KErrNone when normal operation.
Parameters
TRequestStatus & aListenerRequest | Will be completed without errors when tv-out changing state to on or off. |
OnOffListenerCancel()
TInt
| OnOffListenerCancel | ( | ) | [pure virtual] |
SetAvailableTvConfigList(const RArray< TTvSettings > &, const RArray< THdmiDviTimings > &)
Set list of available Tv-configurations
SetConfig(const TTvSettings &)
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 & aTvSettings | Object which contains wanted setting (e.g. PAL/NTSC/...) |
SetConfig(const THdmiDviTimings &)
SettingsChangedListener(TRequestStatus &)
Adds listener for changed settings Check always aListenerRequest.Int(), it is KErrNone when normal operation.
Parameters
TRequestStatus & aListenerRequest | Will be completed without errors when HDMI cable connected/disconnected |
SettingsChangedListenerCancel()
TInt
| SettingsChangedListenerCancel | ( | ) | [pure virtual] |
StandByFigure(const TStandByFigure &)
Sets user defined figure to show on tv. Deprecated since TB10.2.
- Pre-condition
- SetConfig() is called without errors.
StandByFigureMaxSizeInBytes(TUint &)
TInt
| StandByFigureMaxSizeInBytes | ( | TUint & | aMaxFigureSize | ) | [pure virtual] |
Parameters
TUint & aMaxFigureSize | Max size of standByFigure in bytes |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.