mobilemessaging/audiomsg/inc/audiomessagebeep.h
changeset 0 72b543305e3a
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mobilemessaging/audiomsg/inc/audiomessagebeep.h	Thu Dec 17 08:44:11 2009 +0200
@@ -0,0 +1,147 @@
+/*
+* Copyright (c) 2005-2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:   Class that handles playback of tones in AudioMessage application
+*
+*/
+
+
+
+#ifndef AUDIOMESSAGEBEEP_H
+#define AUDIOMESSAGEBEEP_H
+
+#include <mdaaudiotoneplayer.h>
+
+class CAknKeySoundSystem;
+class CAknSoundInfo;
+
+/**
+ *  Class that handles playback of tones in audiomessage application
+ *
+ *  @lib audiomessage.exe
+ *  @since S60 v3.1
+ */
+NONSHARABLE_CLASS( CAudioMessageBeep )
+	: public CBase, public MMdaAudioToneObserver
+    {
+
+private:
+	enum TVRTonePlayerState
+		{
+		EVRToneIdle,
+		EVRTonePreparing,
+		EVRTonePlaying
+		};
+
+public:
+
+    /**
+     * Factory function to create this object
+     *
+     * @param aApp   Reference to application instance
+     */
+    static CAudioMessageBeep* NewL();
+
+    /**
+     * Destructor
+     */
+    virtual ~CAudioMessageBeep();
+
+    /**
+     * Prepares a tone for playback. This does not guarantee
+     * that preparing is ready after completion.
+     *
+     * @since S60 v3.0
+     * @param aToneId Predefined id of the tone to be prepared
+     */
+    void PrepareToneL( TInt aToneId );
+
+    /**
+     * Non-leaving method that calls PrepareToneL and ignores all leaves
+     *
+     * @since S60 v3.0
+     * @param aToneId Predefined id of the tone to be prepared
+     */
+    void PrepareTone( TInt aToneId );
+
+    /**
+     * Starts playback of tone. Playback starts immediately if the tone
+     * specified has been already been prepared. Otherwise the tone
+     * is first prepared.
+     *
+     * @since S60 v3.0
+     * @param aToneId Predefined id of the tone to be played
+     */
+    void PlayTone( TInt aToneId );
+
+// from base class MMdaAudioToneObserver
+
+    /**
+     * From MMdaAudioToneObserver.
+     * Defines required client behaviour when an attempt to configure the
+	 * audio tone player utility has completed, successfully or otherwise.
+     *
+	 * @param     aError KErrNone if successful. One of the system
+	 *            wide error codes if the attempt failed. The possible
+	 *            values depend on the EPOC platform.
+     */
+    void MatoPrepareComplete(TInt aError);
+
+    /**
+     * From MMdaAudioToneObserver.
+	 * Defines required client behaviour when the tone playing operation has
+	 * completed, successfully or otherwise.
+     *
+	 * @param     aError KErrNone if successful. One of the system
+	 *            wide error codes if the attempt failed. The possible
+	 *            values depend on the EPOC platform.
+     */
+    void MatoPlayComplete(TInt aError);
+
+private:
+
+    CAudioMessageBeep();
+    void ConstructL();
+
+private: // data
+
+    /**
+     * Instance of the player class.
+     * Own.
+     */
+     CMdaAudioToneUtility* iPlayer;
+
+	/**
+	 * Pointer to sound system utility that retrieves the sound data.
+	 * Not owned.
+	 */
+	 CAknKeySoundSystem* iSoundSystem;
+
+	/**
+	 * The id of the tone that is currently prepared
+	 */
+	 TInt iPreparedTone;
+
+	/**
+	 * The id of the tone that is in queue
+	 */
+	 TInt iQueuedTone;	
+	 
+	/**
+	 * Is a tone currently in preparation?
+	 */
+     TVRTonePlayerState iState;
+
+    };
+
+#endif // CAudioMessageBeep_H