1.1 --- a/epoc32/include/mmf/server/devsoundstandardcustominterfaces.h Wed Mar 31 12:27:01 2010 +0100
1.2 +++ b/epoc32/include/mmf/server/devsoundstandardcustominterfaces.h Wed Mar 31 12:33:34 2010 +0100
1.3 @@ -1,9 +1,9 @@
1.4 // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 // All rights reserved.
1.6 // This component and the accompanying materials are made available
1.7 -// 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
1.8 +// under the terms of "Eclipse Public License v1.0"
1.9 // which accompanies this distribution, and is available
1.10 -// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.11 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.12 //
1.13 // Initial Contributors:
1.14 // Nokia Corporation - initial contribution.
1.15 @@ -13,16 +13,19 @@
1.16 // Description:
1.17 //
1.18
1.19 +/**
1.20 + @publishedAll
1.21 + @released
1.22 + @file
1.23 +*/
1.24 +
1.25 #ifndef __DEVSOUNDSTANDARDCUSTOMINTERFACES_H__
1.26 #define __DEVSOUNDSTANDARDCUSTOMINTERFACES_H__
1.27
1.28 #include <e32std.h>
1.29
1.30 -/*****************************************************************************/
1.31 /**
1.32 UID associated with the custom interface MMMFDevSoundCustomInterfaceBitRate.
1.33 -@publishedAll
1.34 -@released
1.35 */
1.36 const TUid KUidCustomInterfaceDevSoundBitRate = {0x101F7DD5};
1.37
1.38 @@ -30,9 +33,6 @@
1.39
1.40 /**
1.41 This class provides an interface to set and retrive the DevSound bit rate.
1.42 -
1.43 -@publishedAll
1.44 -@released
1.45 */
1.46 class MMMFDevSoundCustomInterfaceBitRate
1.47 {
1.48 @@ -67,10 +67,6 @@
1.49 /*****************************************************************************/
1.50 /**
1.51 UID associated with the Custom interface MMMFDevSoundCustomInterfaceFileBlockLength.
1.52 -
1.53 -@publishedPartner
1.54 -@prototype
1.55 -
1.56 */
1.57 const TUid KUidCustomInterfaceDevSoundFileBlockLength = {0x10273806};
1.58
1.59 @@ -80,9 +76,6 @@
1.60 Note also that this interface is just a simple interface to
1.61 set file's block length. No checking is perfomed on the values sent (hence the
1.62 Set methods do not return an error code).
1.63 -
1.64 -@publishedPartner
1.65 -@prototype
1.66 */
1.67 class MMMFDevSoundCustomInterfaceFileBlockLength
1.68 {
1.69 @@ -98,17 +91,11 @@
1.70 /*****************************************************************************/
1.71 /**
1.72 UID associated with the Custom interface MMMFGsmConfig
1.73 -
1.74 -@publishedPartner
1.75 -@prototype
1.76 */
1.77 const TUid KUidGsmConfig = {0x102825FC};
1.78
1.79 /**
1.80 This class provides an interface to set and retrive the GSM conversion format.
1.81 -
1.82 -@publishedPartner
1.83 -@prototype
1.84 */
1.85 class MMMFGsmConfig
1.86 {
1.87 @@ -159,9 +146,6 @@
1.88 /*****************************************************************************/
1.89 /**
1.90 UID associated with the Custom interface MSpeechEncoderConfig
1.91 -
1.92 -@publishedPartner
1.93 -@prototype
1.94 */
1.95 const TUid KUidSpeechEncoderConfig = {0x102825FB};
1.96
1.97 @@ -170,10 +154,6 @@
1.98 This interface is used for querying and configuring the operational modes of speech
1.99 encoders as supported by those specific encoders.
1.100 If a speech encoder does not support a mode provided by the interface, it will return KErrNotSupported.
1.101 -
1.102 -@publishedPartner
1.103 -@prototype
1.104 -
1.105 */
1.106 class MSpeechEncoderConfig
1.107 {
1.108 @@ -207,9 +187,6 @@
1.109 /*****************************************************************************/
1.110 /**
1.111 UID associated with the Custom interface MAacDecoderConfig
1.112 -
1.113 -@publishedPartner
1.114 -@prototype
1.115 */
1.116 const TUid KUidAacDecoderConfig = {0x102825FD};
1.117
1.118 @@ -222,9 +199,6 @@
1.119 The CMMFHwDevice does not contain Output channel configuration at time of writing.
1.120 The HWA decoders to date have been hardcoded for 2ch (left / right) output.
1.121 Additional configuration information may be provided by using extension mechanisms.
1.122 -
1.123 -@publishedPartner
1.124 -@prototype
1.125 */
1.126 class MAacDecoderConfig
1.127 {
1.128 @@ -292,9 +266,6 @@
1.129 /*****************************************************************************/
1.130 /**
1.131 UID associated with the Custom interface MEAacPlusDecoderIntfc
1.132 -
1.133 -@publishedPartner
1.134 -@prototype
1.135 */
1.136 const TUid KUidEAacPlusDecoderIntfc = {0x102825FF};
1.137
1.138 @@ -326,9 +297,6 @@
1.139 ApplyConfig() should fail if it is used during decoding with a KErrInUse (or, as previously stated,
1.140 KErrUnknown if a value without a default is not set). Since the interface proxy is not aware of decoding state,
1.141 this check would have to be done in the adaptation implementation for this interface.
1.142 -
1.143 -@publishedPartner
1.144 -@prototype
1.145 */
1.146 class MEAacPlusDecoderIntfc
1.147 {
1.148 @@ -501,9 +469,6 @@
1.149 /*****************************************************************************/
1.150 /**
1.151 UID associated with the Custom interface MSbcEncoderIntfc
1.152 -
1.153 -@publishedPartner
1.154 -@prototype
1.155 */
1.156 const TUid KUidSbcEncoderIntfc = {0x10282600};
1.157
1.158 @@ -542,9 +507,6 @@
1.159 does not need to be set before ApplyConfig() is called). This check and the parameter values
1.160 returned will be implemented in the interface proxy and will not query the actual encoder. If
1.161 multiple instances of the interface are created, each would have this requirement.
1.162 -
1.163 -@publishedPartner
1.164 -@prototype
1.165 */
1.166 class MSbcEncoderIntfc
1.167 {
1.168 @@ -834,18 +796,12 @@
1.169 /*****************************************************************************/
1.170 /**
1.171 UID associated with the Custom interface MG711DecoderIntfc
1.172 -
1.173 -@publishedPartner
1.174 -@prototype
1.175 */
1.176 const TUid KUidG711DecoderIntfc = {0x10282601};
1.177
1.178 /**
1.179 This class provides an interface to the G711 decoder CMMFHwDevice in order to provide
1.180 additional configuration information.
1.181 -
1.182 -@publishedPartner
1.183 -@prototype
1.184 */
1.185 class MG711DecoderIntfc
1.186 {
1.187 @@ -946,18 +902,12 @@
1.188 /*****************************************************************************/
1.189 /**
1.190 UID associated with the Custom interface MG711EncoderIntfc
1.191 -
1.192 -@publishedPartner
1.193 -@prototype
1.194 */
1.195 const TUid KUidG711EncoderIntfc = {0x10282602};
1.196
1.197 /**
1.198 This class provides an interface to the G711 encoder CMMFHwDevice in order to provide
1.199 additional configuration information.
1.200 -
1.201 -@publishedPartner
1.202 -@prototype
1.203 */
1.204 class MG711EncoderIntfc
1.205 {
1.206 @@ -1012,18 +962,12 @@
1.207 /*****************************************************************************/
1.208 /**
1.209 UID associated with the Custom interface MG729DecoderIntfc
1.210 -
1.211 -@publishedPartner
1.212 -@prototype
1.213 */
1.214 const TUid KUidG729DecoderIntfc = {0x10282603};
1.215
1.216 /**
1.217 This class provides an interface to the G729 decoder CMMFHwDevice in order to provide additional
1.218 configuration information.
1.219 -
1.220 -@publishedPartner
1.221 -@prototype
1.222 */
1.223 class MG729DecoderIntfc
1.224 {
1.225 @@ -1046,18 +990,12 @@
1.226 /*****************************************************************************/
1.227 /**
1.228 UID associated with the Custom interface MG729EncoderIntfc
1.229 -
1.230 -@publishedPartner
1.231 -@prototype
1.232 */
1.233 const TUid KUidG729EncoderIntfc = {0x10282604};
1.234
1.235 /**
1.236 This class provides an interface to the G729 encoder CMMFHwDevice in order to provide
1.237 additional configuration information.
1.238 -
1.239 -@publishedPartner
1.240 -@prototype
1.241 */
1.242 class MG729EncoderIntfc
1.243 {
1.244 @@ -1088,18 +1026,12 @@
1.245 /*****************************************************************************/
1.246 /**
1.247 UID associated with the Custom interface MIlbcDecoderIntfc
1.248 -
1.249 -@publishedPartner
1.250 -@prototype
1.251 */
1.252 const TUid KUidIlbcDecoderIntfc = {0x10282605};
1.253
1.254 /**
1.255 This class provides an interface to the Ilbc decoder CMMFHwDevice in order to provide
1.256 additional configuration information.
1.257 -
1.258 -@publishedPartner
1.259 -@prototype
1.260 */
1.261 class MIlbcDecoderIntfc
1.262 {
1.263 @@ -1161,18 +1093,12 @@
1.264 /*****************************************************************************/
1.265 /**
1.266 UID associated with the Custom interface MIlbcEncoderIntfc
1.267 -
1.268 -@publishedPartner
1.269 -@prototype
1.270 */
1.271 const TUid KUidIlbcEncoderIntfc = {0x10282606};
1.272
1.273 /**
1.274 This class provides an interface to the Ilbc encoder CMMFHwDevice in order to provide
1.275 additional configuration information.
1.276 -
1.277 -@publishedPartner
1.278 -@prototype
1.279 */
1.280 class MIlbcEncoderIntfc
1.281 {
1.282 @@ -1243,9 +1169,6 @@
1.283 /*****************************************************************************/
1.284 /**
1.285 UID associated with the Custom interface MMMFErrorConcealmentIntfc
1.286 -
1.287 -@publishedPartner
1.288 -@prototype
1.289 */
1.290 const TUid KUidErrorConcealmentIntfc = {0x10282607};
1.291
1.292 @@ -1256,9 +1179,6 @@
1.293 audio then this API can be used to indicate that audio data is lost so that video
1.294 playback can continue. It could also be used for an audio-only source to maintain
1.295 synchronization in time if data is lost.
1.296 -
1.297 -@publishedPartner
1.298 -@prototype
1.299 */
1.300 class MMMFErrorConcealmentIntfc
1.301 {
1.302 @@ -1319,9 +1239,6 @@
1.303 /*****************************************************************************/
1.304 /**
1.305 UID associated with the Custom interface MAudioVibraControl
1.306 -
1.307 -@publishedPartner
1.308 -@prototype
1.309 */
1.310 const TUid KUidAudioVibraControl = {0x10282608};
1.311
1.312 @@ -1339,9 +1256,6 @@
1.313 two audio streams are rendered, vibra playback might not be mixed. Vibra playback may be
1.314 prioritized by adaptation to a single controller. The behavior in these cases would be based
1.315 on adaptation implementation. The user is not notified if vibra is not played.
1.316 -
1.317 -@publishedPartner
1.318 -@prototype
1.319 */
1.320 class MAudioVibraControl
1.321 {
1.322 @@ -1364,9 +1278,6 @@
1.323 /*****************************************************************************/
1.324 /**
1.325 UID associated with the Custom interface MMMFSampleBuffering
1.326 -
1.327 -@publishedPartner
1.328 -@prototype
1.329 */
1.330 const TUid KUidSampleBuffering = {0x10282609};
1.331
1.332 @@ -1374,9 +1285,6 @@
1.333 Custom interface class to allow DevSound to support buffering of samples before playback begins.
1.334 This allows playback to be more robust to underflow errors when playback begins at the expense
1.335 of higher latency before playback starts.
1.336 -
1.337 -@publishedPartner
1.338 -@prototype
1.339 */
1.340 class MMMFSampleBuffering
1.341 {
1.342 @@ -1410,9 +1318,6 @@
1.343 /*****************************************************************************/
1.344 /**
1.345 UID associated with the Custom interface MMMFPlaybackStatus.
1.346 -
1.347 -@publishedPartner
1.348 -@prototype
1.349 */
1.350 const TUid KUidPlaybackStatus = {0x10273811};
1.351
1.352 @@ -1420,9 +1325,6 @@
1.353 Custom interface class to enable access to the DevSound implementation to report the number of
1.354 consumed input bytes, number of successfully decoded samples, samples played, system time and
1.355 total samples played.
1.356 -
1.357 -@publishedPartner
1.358 -@prototype
1.359 */
1.360 class MMMFPlaybackStatus
1.361 {
1.362 @@ -1468,17 +1370,11 @@
1.363 /*****************************************************************************/
1.364 /**
1.365 UID associated with the Custom interface MMMFDSPControl
1.366 -
1.367 -@publishedPartner
1.368 -@prototype
1.369 */
1.370 const TUid KUidDSPControl = {0x1028260A};
1.371
1.372 /**
1.373 Custom interface class to allow control of DSP behaviour.
1.374 -
1.375 -@publishedPartner
1.376 -@prototype
1.377 */
1.378 class MMMFDSPControl
1.379 {
1.380 @@ -1512,17 +1408,11 @@
1.381 /*****************************************************************************/
1.382 /**
1.383 UID associated with the Custom interface MMMFUnderflowAutoStopControl
1.384 -
1.385 -@publishedPartner
1.386 -@prototype
1.387 */
1.388 const TUid KUidUnderflowAutoStopControl = {0x1028260B};
1.389
1.390 /**
1.391 Custom interface class to control underflow behaviour.
1.392 -
1.393 -@publishedPartner
1.394 -@prototype
1.395 */
1.396 class MMMFUnderflowAutoStopControl
1.397 {
1.398 @@ -1540,17 +1430,11 @@
1.399 /*****************************************************************************/
1.400 /**
1.401 UID associated with the Custom interface MMMFSetDRMProtected
1.402 -
1.403 -@publishedPartner
1.404 -@prototype
1.405 */
1.406 const TUid KUidSetDRMProtected = {0x1028260C};
1.407
1.408 /**
1.409 This class provides an interface to mark data being played as DRM protected.
1.410 -
1.411 -@publishedPartner
1.412 -@prototype
1.413 */
1.414 class MMMFSetDRMProtected
1.415 {
1.416 @@ -1567,17 +1451,11 @@
1.417 /*****************************************************************************/
1.418 /**
1.419 UID associated with the Custom interface MMMFBufferFramesConfig.
1.420 -
1.421 -@publishedPartner
1.422 -@prototype
1.423 */
1.424 const TUid KUidBufferFramesConfig = {0x1028260D};
1.425
1.426 /**
1.427 This class provides an interface to configure and retrive the buffer frames.
1.428 -
1.429 -@publishedPartner
1.430 -@prototype
1.431 */
1.432 class MMMFBufferFramesConfig
1.433 {
1.434 @@ -1609,17 +1487,11 @@
1.435 /*****************************************************************************/
1.436 /**
1.437 UID associated with the Custom interface MMMFGetTimestamps
1.438 -
1.439 -@publishedPartner
1.440 -@prototype
1.441 */
1.442 const TUid KUidGetTimestamps = {0x1028260E};
1.443
1.444 /**
1.445 This class provides an interface to configure and retrive time stamps.
1.446 -
1.447 -@publishedPartner
1.448 -@prototype
1.449 */
1.450 class MMMFGetTimestamps
1.451 {
1.452 @@ -1658,17 +1530,11 @@
1.453 /*****************************************************************************/
1.454 /**
1.455 UID associated with the Custom interface MMMFAdvancedAACEncodeSettings
1.456 -
1.457 -@publishedPartner
1.458 -@prototype
1.459 */
1.460 const TUid KUidAdvancedAACEncoderSettings = {0x102825FE};
1.461
1.462 /**
1.463 Advanced AAC Encode Bit-rate Configuration
1.464 -
1.465 -@publishedPartner
1.466 -@prototype
1.467 */
1.468 class MMMFAdvancedAACEncodeSettings
1.469 {