radioengine/engine/api/mradiordsreceiver.h
branchRCL_3
changeset 19 cce62ebc198e
equal deleted inserted replaced
18:1a6714c53019 19:cce62ebc198e
       
     1 /*
       
     2 * Copyright (c) 2009 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:
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef MRADIORDSRECEIVER_H
       
    19 #define MRADIORDSRECEIVER_H
       
    20 
       
    21 // Forward declarations
       
    22 class CRadioUtility;
       
    23 class MRadioRdsDataObserver;
       
    24 
       
    25 NONSHARABLE_CLASS( MRadioRdsReceiver )
       
    26     {
       
    27 public:
       
    28 
       
    29     /**
       
    30      * Initializes the RDS receiver
       
    31      *
       
    32      * @param aRadioUtility A reference to the radio utility
       
    33      * @param aPubSub       Pointer to Publish&Subscribe object
       
    34      */
       
    35     virtual void InitL( CRadioUtility& aRadioUtility ) = 0;
       
    36 
       
    37     /**
       
    38      * Adds an observer wich will be notified of the new RDS data
       
    39      * If observer already exists, it is not added
       
    40      *
       
    41      * @param aObserver pointer of the observer instance.
       
    42      */
       
    43     virtual void AddObserverL( MRadioRdsDataObserver* aObserver ) = 0;
       
    44 
       
    45     /**
       
    46      * Removes the rds observer.
       
    47      */
       
    48     virtual void RemoveObserver( MRadioRdsDataObserver* aObserver ) = 0;
       
    49 
       
    50     /**
       
    51      * Getter for automatic switching state of alternate frequencies
       
    52      *
       
    53      * @return ETrue if automatic switching is enabled
       
    54      */
       
    55     virtual TBool AutomaticSwitchingEnabled() const = 0;
       
    56 
       
    57     /**
       
    58      * Getter for the programme service name
       
    59      *
       
    60      * @return Programme service name
       
    61      */
       
    62     virtual const TDesC& ProgrammeService() const = 0;
       
    63 
       
    64     /**
       
    65      * Getter for the radio text.
       
    66      *
       
    67      * @return Radio text.
       
    68      */
       
    69     virtual const TDesC& RadioText() const = 0;
       
    70 
       
    71     /**
       
    72      * Getter for the RDS signal availability
       
    73      *
       
    74      * @return ETrue if RDS signal is available, otherwise EFalse
       
    75      */
       
    76     virtual TBool SignalAvailable() const = 0;
       
    77 
       
    78     /**
       
    79      * Setter for automatic switching of alternate frequencies
       
    80      * If this method is overridden, the base implementation should be called
       
    81      *
       
    82      * @param aEnable ETrue, if automatic swithing is to be enabled
       
    83      */
       
    84     virtual void SetAutomaticSwitchingL( TBool aEnable ) = 0;
       
    85 
       
    86     /**
       
    87      * Starts receiving the RDS information
       
    88      */
       
    89     virtual void StartReceiver() = 0;
       
    90 
       
    91     /**
       
    92      * Stops receiving the RDS information
       
    93      */
       
    94     virtual void StopReceiver() = 0;
       
    95 
       
    96     };
       
    97 
       
    98 #endif // MRADIORDSRECEIVER_H