| class CRestrictedAudioOutput : public CBase |
CRestrictedAudioOutput class documentation.
Use this class to control audio routing to enforce DRM restrictions.
Instance of this class should be associated with an audio stream. (Currently supported for DevSound API instance). Once associated, it is valid and should be used only until the DevSound instance exist. Instance of this class should be deleted before deleting the DevSound instance.
The output restrictions specified via Commit() will be applied to audio devices when DevSound instance enters playing state.
RestrictedAudioOutput.lib
| Public Member Functions | |
|---|---|
| ~CRestrictedAudioOutput () | |
| IMPORT_C TInt | AppendAllowedOutput ( TAllowedOutputPreference ) |
| TInt | Commit () |
| IMPORT_C TInt | GetAllowedOutput ( TInt , TAllowedOutputPreference &) |
| IMPORT_C TInt | GetAllowedOutputCount ( TInt &) |
| IMPORT_C TInt | RemoveAllowedOutput ( TAllowedOutputPreference ) |
| IMPORT_C TInt | Reset () |
| Protected Member Functions | |
|---|---|
| CRestrictedAudioOutput () | |
| IMPORT_C void | ConstructL () |
| Public Member Enumerations | |
|---|---|
| enum |
TAllowedOutputPreference
{
EAllowAllAudio , EAllowAudioAnalog , EAllowAudioFMTransmitter , EAllowAudioBtHFPHSP , EAllowAudioBtA2DP , EAllowAudioUplink , EAllowAudioUsb , EAllowAudioRecording , EAllowVisualization , EAllowAudioHDMI , EAllowAudioHdmiHdcpRequired } |
| Private Attributes | |
|---|---|
| CRestrictedAudioOutputImpl * | iImpl |
| IMPORT_C TInt | AppendAllowedOutput | ( | TAllowedOutputPreference | aOutput | ) |
Appends an allowed output to the existing list.
| TAllowedOutputPreference aOutput | to be appended. |
| TInt | Commit | ( | ) | [pure virtual] |
Applies settings cached locally and commits.
This function can only be called when the DevSound instance is in Idle OR Stopped state.
Output preference will take into effect when DevSound instance goes to Playing state.
If the client commits an empty list, all other active audio output in the system will be muted.
| IMPORT_C void | ConstructL | ( | ) | [protected] |
Second phase constructor. The derived class should call this during construction.
| IMPORT_C TInt | GetAllowedOutput | ( | TInt | aIndex, |
| TAllowedOutputPreference & | aOutput | |||
| ) | ||||
Gets a reference to an allowed output located at a specified position within the list.
| TInt aIndex | |
| TAllowedOutputPreference & aOutput |
| IMPORT_C TInt | GetAllowedOutputCount | ( | TInt & | aSize | ) |
Gets the number of objects in the array.
| TInt & aSize |
| IMPORT_C TInt | RemoveAllowedOutput | ( | TAllowedOutputPreference | aOutput | ) |
Removes an allowed output from the existing list.
| TAllowedOutputPreference aOutput |
| EAllowAllAudio | |
| EAllowAudioAnalog | |
| EAllowAudioFMTransmitter | |
| EAllowAudioBtHFPHSP | |
| EAllowAudioBtA2DP | |
| EAllowAudioUplink | |
| EAllowAudioUsb | |
| EAllowAudioRecording | |
| EAllowVisualization | |
| EAllowAudioHDMI |
RIM CR 417-7642: HDMI with HDCP to Resctricted Audio Output API Adding new ENUMs to CRestrictedAudioOutput::TAllowedOutputPreference for HDMI and HDCP EAllowAudioHDMI and EAllowAudioHdmiHdcpRequired |
| EAllowAudioHdmiHdcpRequired |
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.