devicesrv_plat/accessory_policy_usb_audio_api/inc/accpolinputcontrol.h
changeset 0 4e1aa6a622a0
equal deleted inserted replaced
-1:000000000000 0:4e1aa6a622a0
       
     1 /*
       
     2 * Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Definition for input control object.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef ACCPOLINPUTCONTROL_H
       
    20 #define ACCPOLINPUTCONTROL_H
       
    21 
       
    22 #include <accpolaudiocontrolbase.h>
       
    23 
       
    24 /**
       
    25  *  Class definition for input control objects.
       
    26  *
       
    27  *  @accpolaudiodevicetopology.lib
       
    28  */
       
    29 NONSHARABLE_CLASS ( CAccPolInputControl ) : public CAccPolAudioControlBase
       
    30     {
       
    31 
       
    32 public:
       
    33 
       
    34     /**
       
    35      * Destructor.
       
    36      */
       
    37     virtual ~CAccPolInputControl();
       
    38 
       
    39     /**
       
    40      * Two-phased constructor.
       
    41      */
       
    42     IMPORT_C static CAccPolInputControl* NewL( CAccPolObjectCon* aObject = NULL );
       
    43 
       
    44     /**
       
    45      * Two-phased constructor.
       
    46      */
       
    47     IMPORT_C static CAccPolInputControl* NewLC( CAccPolObjectCon* aObject = NULL );
       
    48 
       
    49     /**
       
    50      * Two-phased constructor.
       
    51      */
       
    52     IMPORT_C static CAccPolInputControl* NewL( const TUint8 aUnitId );
       
    53 
       
    54     /**
       
    55      * Two-phased constructor.
       
    56      */
       
    57     IMPORT_C static CAccPolInputControl* NewLC( const TUint8 aUnitId );
       
    58 
       
    59     /**
       
    60      * Assign operator for input control class.
       
    61      *
       
    62      * @param CAccPolInputControl, Const reference to object to be copied.
       
    63      * @return CAccPolInputControl, Reference to object pointer.
       
    64      */
       
    65     IMPORT_C CAccPolInputControl& operator= ( const CAccPolInputControl& );
       
    66 
       
    67     /**
       
    68      * Returns input source unit Id.
       
    69      *
       
    70      * @return TUint8, Audio unit Id.
       
    71      */
       
    72     IMPORT_C TUint8 Input() const;
       
    73 
       
    74     /**
       
    75      * Set input source unit Id.
       
    76      *
       
    77      @ param aUnitId, Audio unit Id.
       
    78      * @return void.
       
    79      */
       
    80     IMPORT_C void SetInput( const TUint8 aUnitId );
       
    81 
       
    82     /**
       
    83      * Duplicates the object data.
       
    84      *
       
    85      * @return CAccPolObjectBase*, Pointer to duplicated object.
       
    86      */
       
    87     CAccPolObjectBase* DuplicateLC( CAccPolObjectCon* aObject = NULL );
       
    88 
       
    89     /**
       
    90      * Externalize object.
       
    91      *
       
    92      * @param aStream, Write stream object.
       
    93      * @return void.
       
    94      */
       
    95     void ExternalizeL( RWriteStream& aStream ) const;
       
    96 
       
    97     /**
       
    98      * Internalize object.
       
    99      *
       
   100      * @param aStream, Read stream object.
       
   101      * @return void.
       
   102      */
       
   103     void InternalizeL( RReadStream& aStream );
       
   104 
       
   105 private:
       
   106 
       
   107     /**
       
   108      * C++ default constructor.
       
   109      */
       
   110     CAccPolInputControl( CAccPolObjectCon* aObject = NULL );
       
   111 
       
   112     /**
       
   113      * C++ constructor.
       
   114      */
       
   115     CAccPolInputControl( const TUint8 aSourceId );
       
   116 
       
   117     /**
       
   118      * By default Symbian 2nd phase constructor is private.
       
   119      */
       
   120     void ConstructL();
       
   121 
       
   122 private:
       
   123 
       
   124     /**
       
   125      * Input source unit Id.
       
   126      */
       
   127     TUint8 iUnitId;
       
   128 
       
   129     };
       
   130 
       
   131 #endif // ACCPOLINPUTCONTROL_H