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