1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/mm/mm_plat/restricted_audio_output_api/inc/RestrictedAudioOutput.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,179 @@
1.4 +/*
1.5 +* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description: Class handling restricted audio output
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +
1.23 +#ifndef RESTRICTEDAUDIOOUTPUT_H
1.24 +#define RESTRICTEDAUDIOOUTPUT_H
1.25 +
1.26 +#include <e32base.h>
1.27 +
1.28 +class CRestrictedAudioOutputImpl;
1.29 +
1.30 +/**
1.31 + * CRestrictedAudioOutput class documentation.
1.32 + *
1.33 + * Use this class to control audio routing to enforce DRM restrictions.
1.34 + *
1.35 + * Instance of this class should be associated with an audio stream.
1.36 + * (Currently supported for DevSound API instance). Once associated, it is
1.37 + * valid and should be used only until the DevSound instance exist. Instance of
1.38 + * this class should be deleted before deleting the DevSound instance.
1.39 + *
1.40 + * The output restrictions specified via Commit() will be applied to audio devices
1.41 + * when DevSound instance enters playing state.
1.42 + *
1.43 + * @lib RestrictedAudioOutput.lib
1.44 + *
1.45 + * @since S60 5.0
1.46 + */
1.47 +class CRestrictedAudioOutput : public CBase
1.48 + {
1.49 +public:
1.50 + enum TAllowedOutputPreference
1.51 + {
1.52 + EAllowAllAudio,
1.53 + EAllowAudioAnalog,
1.54 + EAllowAudioFMTransmitter,
1.55 + EAllowAudioBtHFPHSP,
1.56 + EAllowAudioBtA2DP,
1.57 + EAllowAudioUplink,
1.58 + EAllowAudioUsb,
1.59 + EAllowAudioRecording,
1.60 + EAllowVisualization,
1.61 + /**
1.62 + * RIM CR 417-7642: HDMI with HDCP to Resctricted Audio Output API
1.63 + * Adding new ENUMs to CRestrictedAudioOutput::TAllowedOutputPreference for HDMI and HDCP
1.64 + * EAllowAudioHDMI and EAllowAudioHdmiHdcpRequired
1.65 + */
1.66 + EAllowAudioHDMI,
1.67 + EAllowAudioHdmiHdcpRequired
1.68 + };
1.69 +
1.70 +
1.71 + /**
1.72 + * Destructor
1.73 + *
1.74 + */
1.75 + IMPORT_C virtual ~CRestrictedAudioOutput();
1.76 +
1.77 + /**
1.78 + * Appends an allowed output to the existing list.
1.79 + *
1.80 + * @param aOutput to be appended.
1.81 + * @return KErrNone if successful. KErrAlreadyExists if aOutput is already
1.82 + * appended before. KErrIncompleteInitialization if ConstructL is not called
1.83 + * by the deriving class. Otherwise any systemwide error code.
1.84 + */
1.85 + IMPORT_C TInt AppendAllowedOutput( TAllowedOutputPreference aOutput );
1.86 +
1.87 + /**
1.88 + * Removes an allowed output from the existing list.
1.89 + *
1.90 + * @param The position within the array from where the object is to be
1.91 + * removed. The position is relative to zero, i.e. zero implies that an
1.92 + * object at the beginning of the array is to be removed.
1.93 + *
1.94 + * @return KErrNone if successful. KErrNotFound if aOutput is not in the
1.95 + * the list. KErrIncompleteInitialization if ConstructL is not called
1.96 + * by the deriving class. Otherwise any systemwide error code.
1.97 + */
1.98 + IMPORT_C TInt RemoveAllowedOutput( TAllowedOutputPreference aOutput );
1.99 +
1.100 + /**
1.101 + * Gets a reference to an allowed output located at a specified position
1.102 + * within the list.
1.103 + *
1.104 + * @param The position within the array from where the object is to be
1.105 + * removed. The position is relative to zero, i.e. zero implies that an
1.106 + * object at the beginning of the array is to be removed.
1.107 + *
1.108 + * @param The position within the array from where the object is to be
1.109 + * removed. The position is relative to zero, i.e. zero implies that an
1.110 + * object at the beginning of the array is to be removed.
1.111 + *
1.112 + * @param A const reference to the object at position anIndex within the
1.113 + * list.
1.114 + *
1.115 + * @return KErrNone if successful. KErrNotFound if index is not in the
1.116 + * the list. KErrIncompleteInitialization if ConstructL is not called
1.117 + * by the deriving class. Otherwise any systemwide error code.
1.118 + */
1.119 + IMPORT_C TInt GetAllowedOutput( TInt aIndex, TAllowedOutputPreference& aOutput );
1.120 +
1.121 + /**
1.122 + * Gets the number of objects in the array.
1.123 + *
1.124 + * @param On successful return will contain the number of objects in
1.125 + * the list.
1.126 + *
1.127 + * @return KErrIncompleteInitialization if ConstructL is not called
1.128 + * by the deriving class. Otherwise a system wide error code.
1.129 + */
1.130 + IMPORT_C TInt GetAllowedOutputCount( TInt& aSize );
1.131 +
1.132 + /**
1.133 + * Empties the list, so that it is ready to be reused.
1.134 + *
1.135 + *
1.136 + * @return KErrNone if successful. KErrIncompleteInitialization if ConstructL
1.137 + * is not called by the deriving class.
1.138 + */
1.139 + IMPORT_C TInt Reset();
1.140 +
1.141 + /**
1.142 + * Applies settings cached locally and commits.
1.143 + *
1.144 + * This function can only be called when the DevSound instance is in Idle OR
1.145 + * Stopped state.
1.146 + *
1.147 + * Output preference will take into effect when DevSound instance goes to
1.148 + * Playing state.
1.149 + *
1.150 + * If the client commits an empty list, all other active audio output in
1.151 + * the system will be muted.
1.152 + *
1.153 + * @return KErrNone if successful. KErrInUse if DevSound instance is not in
1.154 + * idle/stopped state.
1.155 + */
1.156 + virtual TInt Commit() = 0;
1.157 +
1.158 +protected:
1.159 +
1.160 + /**
1.161 + * Constructor
1.162 + *
1.163 + */
1.164 + IMPORT_C CRestrictedAudioOutput();
1.165 +
1.166 + /**
1.167 + * Second phase constructor. The derived class should call this during
1.168 + * construction.
1.169 + *
1.170 + */
1.171 + IMPORT_C void ConstructL();
1.172 +
1.173 +
1.174 +
1.175 +private:
1.176 + CRestrictedAudioOutputImpl* iImpl;
1.177 +
1.178 + };
1.179 +
1.180 +#endif // RESTRICTEDAUDIOOUTPUT_H
1.181 +
1.182 +// End of file