// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// which accompanies this distribution, and is available

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

//

#ifndef __MMFBASE_H__

#define __MMFBASE_H__

// Standard EPOC32 includes

#include <e32base.h>

/** 

@publishedAll

@released

The priority for clients accessing a sound output device for audio playback or audio streaming.

This is a value between EMdaPriorityMin and EMdaPriorityMax. The higher value indicates a more 

important request. It is used to resolve conflicts when more than one client tries to access the

same hardware resource simultaneously.

One of these values is passed in the first parameter to CMdaAudioOutputStream::SetPriority().

@see CMdaAudioOutputStream::SetPriority()

*/

enum TMdaPriority

	{

  	/**

	The lowest priority (= – 100). This indicates that the client can be interrupted 

	by any other client.

	*/

    EMdaPriorityMin = -100,

	/**

	Normal priority. This indicates that the client can be interrupted but only by higher priority clients.

	*/

    EMdaPriorityNormal = 0,

	/**

    The highest priority (= 100). This indicates that the client cannot be interrupted by other clients.

	*/

    EMdaPriorityMax = 100

	};

/**

@publishedAll

@released

*/

enum TMdaPriorityPreference

	{

	/**

	*/

	/**

	/**

	*/

	/**

	*/

	};

/**

@publishedAll

@released

Holds the current state of DevSound.

*/

enum TMMFState

{

	/** Idle state.

	*/

	EMMFStateIdle,

	/** The MMF is currently playing.

	*/

	EMMFStatePlaying,

	/** The MMF is playing a tone.

	*/

	EMMFStateTonePlaying,

	/** The MMF is currently recording.

	*/

	EMMFStateRecording,

	/** The MMF is playing and recording.

	*/

	EMMFStatePlayingRecording,

	/** The MMF is converting data.

	*/

	EMMFStateConverting

};

/**

@publishedAll

@released

A class type representing the audio client's priority,

priority preference and state settings.

*/

class TMMFPrioritySettings

	{

public:

	TMMFPrioritySettings();

	/**

	*/

	TInt iPriority;

	/**

	*/

	/**

    The state of the MMF player such as idle, playing, recording and so on. See the TMMFState enum for possible states.

	*/

	TMMFState iState;

private:

	/**

	This member is internal and not intended for use.

	*/

	TInt iReserved1;

	};

/**

@publishedAll

@released

This is a TPckgBuf package of a TMMFPrioritySettings.

*/

typedef TPckgBuf<TMMFPrioritySettings> TMMFPrioritySettingsPckg;

/**

Initializes the object with arbitrary values.

*/

inline TMMFPrioritySettings::TMMFPrioritySettings() : iPriority(EMdaPriorityNormal), iPref(EMdaPriorityPreferenceNone), iState(EMMFStateIdle), iReserved1(0)

	{

	}

#endif