API_REF/Public_API: comparison epoc32/include/mmf/server/devsoundstandardcustominterfaces.h

equal deleted inserted replaced

-:e1b950c65cb4
+:837f303aceeb
 // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
 // All rights reserved.
 // This component and the accompanying materials are made available
-// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
+// under the terms of "Eclipse Public License v1.0"
 // which accompanies this distribution, and is available
-// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+// at the URL "http://www.eclipse.org/legal/epl-v10.html".
 //
 // Initial Contributors:
 // Nokia Corporation - initial contribution.
 //
 // Contributors:
 //
 // Description:
 //
+/**
+@publishedAll
+@released
+@file
+*/
 #ifndef __DEVSOUNDSTANDARDCUSTOMINTERFACES_H__
 #define __DEVSOUNDSTANDARDCUSTOMINTERFACES_H__
 #include <e32std.h>
-/*****************************************************************************/
 /**
 UID associated with the custom interface MMMFDevSoundCustomInterfaceBitRate.
-@publishedAll
-@released
 */
 const TUid KUidCustomInterfaceDevSoundBitRate = {0x101F7DD5};
 /**
 This class provides an interface to set and retrive the DevSound bit rate.
-@publishedAll
-@released
 */
 class MMMFDevSoundCustomInterfaceBitRate
 	{
 public:
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MMMFDevSoundCustomInterfaceFileBlockLength.
-@publishedPartner
-@prototype
 */
 const TUid KUidCustomInterfaceDevSoundFileBlockLength = {0x10273806};
 /**
 Custom interface class for setting the file's block length on the hwdevice.
 Note also that this interface is just a simple interface to
 set file's block length. No checking is perfomed on the values sent (hence the
 Set methods do not return an error code).
-@publishedPartner
-@prototype
 */
 class MMMFDevSoundCustomInterfaceFileBlockLength
 	{
 public:
 	/**
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MMMFGsmConfig
-@publishedPartner
-@prototype
 */
 const TUid KUidGsmConfig = {0x102825FC};
 /**
 This class provides an interface to set and retrive the GSM conversion format.
-@publishedPartner
-@prototype
 */
 class MMMFGsmConfig
 	{
 public:
 	/** The GSM conversion format */
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MSpeechEncoderConfig
-@publishedPartner
-@prototype
 */
 const TUid KUidSpeechEncoderConfig = {0x102825FB};
 /**
 This class provides an interface to those CMMFHwDevices providing speech encoding.
 This interface is used for querying and configuring the operational modes of speech
 encoders as supported by those specific encoders.
 If a speech encoder does not support a mode provided by the interface, it will return KErrNotSupported.
-@publishedPartner
-@prototype
 */
 class MSpeechEncoderConfig
 	{
 public:
 	/**
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MAacDecoderConfig
-@publishedPartner
-@prototype
 */
 const TUid KUidAacDecoderConfig = {0x102825FD};
 /**
 This class provides an interface to the AAC decoder CMMFHwDevice in order
 The sample rate can be configured via the CMMFHwDevice::SetConfig() method.
 An extension mechanism will be provided for further functionality as required.
 The CMMFHwDevice does not contain Output channel configuration at time of writing.
 The HWA decoders to date have been hardcoded for 2ch (left / right) output.
 Additional configuration information may be provided by using extension mechanisms.
-@publishedPartner
-@prototype
 */
 class MAacDecoderConfig
 	{
 public:
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MEAacPlusDecoderIntfc
-@publishedPartner
-@prototype
 */
 const TUid KUidEAacPlusDecoderIntfc = {0x102825FF};
 /**
 This class provides an interface to the eAAC+ decoder hwdevice in order to provide configuration information.
 Calling ApplyConfig() will send these values using a single message to the message handler.
 ApplyConfig() should fail if it is used during decoding with a KErrInUse (or, as previously stated,
 KErrUnknown if a value without a default is not set). Since the interface proxy is not aware of decoding state,
 this check would have to be done in the adaptation implementation for this interface.
-@publishedPartner
-@prototype
 */
 class MEAacPlusDecoderIntfc
 	{
 public:
 	/**
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MSbcEncoderIntfc
-@publishedPartner
-@prototype
 */
 const TUid KUidSbcEncoderIntfc = {0x10282600};
 /**
 This class provides an interface to the SBC encoder hwdevice in order to provide configuration information.
 @note  This constraint is only true for configurations
 where this is supported (e.g. If GetSupportedChannelModes returns KErrNotSupported then SetChannelMode
 does not need to be set before ApplyConfig() is called). This check and the parameter values
 returned will be implemented in the interface proxy and will not query the actual encoder. If
 multiple instances of the interface are created, each would have this requirement.
-@publishedPartner
-@prototype
 */
 class MSbcEncoderIntfc
 	{
 public:
 	/**
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MG711DecoderIntfc
-@publishedPartner
-@prototype
 */
 const TUid KUidG711DecoderIntfc = {0x10282601};
 /**
 This class provides an interface to the G711 decoder CMMFHwDevice in order to provide
 additional configuration information.
-@publishedPartner
-@prototype
 */
 class MG711DecoderIntfc
 	{
 public:
 	/** The Decoder mode */
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MG711EncoderIntfc
-@publishedPartner
-@prototype
 */
 const TUid KUidG711EncoderIntfc = {0x10282602};
 /**
 This class provides an interface to the G711 encoder CMMFHwDevice in order to provide
 additional configuration information.
-@publishedPartner
-@prototype
 */
 class MG711EncoderIntfc
 	{
 public:
 	/** The encoder mode */
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MG729DecoderIntfc
-@publishedPartner
-@prototype
 */
 const TUid KUidG729DecoderIntfc = {0x10282603};
 /**
 This class provides an interface to the G729 decoder CMMFHwDevice in order to provide additional
 configuration information.
-@publishedPartner
-@prototype
 */
 class MG729DecoderIntfc
 	{
 public:
 	/**
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MG729EncoderIntfc
-@publishedPartner
-@prototype
 */
 const TUid KUidG729EncoderIntfc = {0x10282604};
 /**
 This class provides an interface to the G729 encoder CMMFHwDevice in order to provide
 additional configuration information.
-@publishedPartner
-@prototype
 */
 class MG729EncoderIntfc
 	{
 public:
 	/**
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MIlbcDecoderIntfc
-@publishedPartner
-@prototype
 */
 const TUid KUidIlbcDecoderIntfc = {0x10282605};
 /**
 This class provides an interface to the Ilbc decoder CMMFHwDevice in order to provide
 additional configuration information.
-@publishedPartner
-@prototype
 */
 class MIlbcDecoderIntfc
 	{
 public:
 	/** The Ibc decoder mode */
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MIlbcEncoderIntfc
-@publishedPartner
-@prototype
 */
 const TUid KUidIlbcEncoderIntfc = {0x10282606};
 /**
 This class provides an interface to the Ilbc encoder CMMFHwDevice in order to provide
 additional configuration information.
-@publishedPartner
-@prototype
 */
 class MIlbcEncoderIntfc
 	{
 public:
 	/** The Ibc encoder mode*/
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MMMFErrorConcealmentIntfc
-@publishedPartner
-@prototype
 */
 const TUid KUidErrorConcealmentIntfc = {0x10282607};
 /**
 This custom interface can be used to indicate that data has been lost. Typical usage
 would be during streaming. Lost packets of audio data would not get played, but the
 video data may still be available for playback. If video playback is synchronized to
 audio then this API can be used to indicate that audio data is lost so that video
 playback can continue. It could also be used for an audio-only source to maintain
 synchronization in time if data is lost.
-@publishedPartner
-@prototype
 */
 class MMMFErrorConcealmentIntfc
 	{
 public:
 	/**
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MAudioVibraControl
-@publishedPartner
-@prototype
 */
 const TUid KUidAudioVibraControl = {0x10282608};
 /**
 This class provides an interface for controlling vibra. DevSound should interpret the
 resource conflicts, and prioritization by adaptation, it may be possible that an audio stream
 is played, but not the vibra that accompanies that audio. For instance, if audio is mixed and
 two audio streams are rendered, vibra playback might not be mixed. Vibra playback may be
 prioritized by adaptation to a single controller. The behavior in these cases would be based
 on adaptation implementation. The user is not notified if vibra is not played.
-@publishedPartner
-@prototype
 */
 class MAudioVibraControl
 	{
 public:
 	/**
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MMMFSampleBuffering
-@publishedPartner
-@prototype
 */
 const TUid KUidSampleBuffering = {0x10282609};
 /**
 Custom interface class to allow DevSound to support buffering of samples before playback begins.
 This allows playback to be more robust to underflow errors when playback begins at the expense
 of higher latency before playback starts.
-@publishedPartner
-@prototype
 */
 class MMMFSampleBuffering
 	{
 public:
 	/**
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MMMFPlaybackStatus.
-@publishedPartner
-@prototype
 */
 const TUid KUidPlaybackStatus = {0x10273811};
 /**
 Custom interface class to enable access to the DevSound implementation to report the number of
 consumed input bytes, number of successfully decoded samples, samples played, system time and
 total samples played.
-@publishedPartner
-@prototype
 */
 class MMMFPlaybackStatus
 	{
 public:
 	/**  Play back status information */
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MMMFDSPControl
-@publishedPartner
-@prototype
 */
 const TUid KUidDSPControl = {0x1028260A};
 /**
 Custom interface class to allow control of DSP behaviour.
-@publishedPartner
-@prototype
 */
 class MMMFDSPControl
 	{
 public:
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MMMFUnderflowAutoStopControl
-@publishedPartner
-@prototype
 */
 const TUid KUidUnderflowAutoStopControl = {0x1028260B};
 /**
 Custom interface class to control underflow behaviour.
-@publishedPartner
-@prototype
 */
 class MMMFUnderflowAutoStopControl
 	{
 public:
 	/**
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MMMFSetDRMProtected
-@publishedPartner
-@prototype
 */
 const TUid KUidSetDRMProtected = {0x1028260C};
 /**
 This class provides an interface to mark data being played as DRM protected.
-@publishedPartner
-@prototype
 */
 class MMMFSetDRMProtected
 	{
 public:
 	/**
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MMMFBufferFramesConfig.
-@publishedPartner
-@prototype
 */
 const TUid KUidBufferFramesConfig = {0x1028260D};
 /**
 This class provides an interface to configure and retrive the buffer frames.
-@publishedPartner
-@prototype
 */
 class MMMFBufferFramesConfig
 	{
 public:
 	/**
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MMMFGetTimestamps
-@publishedPartner
-@prototype
 */
 const TUid KUidGetTimestamps = {0x1028260E};
 /**
 This class provides an interface to configure and retrive time stamps.
-@publishedPartner
-@prototype
 */
 class MMMFGetTimestamps
 	{
 public:
 	/**
 	};
 /*****************************************************************************/
 /**
 UID associated with the Custom interface MMMFAdvancedAACEncodeSettings
-@publishedPartner
-@prototype
 */
 const TUid KUidAdvancedAACEncoderSettings = {0x102825FE};
 /**
 Advanced AAC Encode Bit-rate Configuration
-@publishedPartner
-@prototype
 */
 class MMMFAdvancedAACEncodeSettings
 	{
 public:
 	/** AAC BItrate mode */

branch	Symbian3
changeset 4	837f303aceeb
parent 2	2fe1408b6811