epoc32/include/mmf/server/sounddevice.inl
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
williamr@2
     2
// SoundDevice.inl
williamr@2
     3
williamr@2
     4
// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     5
// All rights reserved.
williamr@2
     6
// This component and the accompanying materials are made available
williamr@4
     7
// under the terms of "Eclipse Public License v1.0"
williamr@2
     8
// which accompanies this distribution, and is available
williamr@4
     9
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
    10
//
williamr@2
    11
// Initial Contributors:
williamr@2
    12
// Nokia Corporation - initial contribution.
williamr@2
    13
//
williamr@2
    14
// Contributors:
williamr@2
    15
//
williamr@2
    16
// Description:
williamr@2
    17
//
williamr@2
    18
williamr@2
    19
#ifndef SOUNDDEVICE_INL
williamr@2
    20
#define SOUNDDEVICE_INL
williamr@2
    21
williamr@2
    22
#include <mmf/server/mmfdevsoundcustominterfacesupport.h>
williamr@4
    23
williamr@4
    24
#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
    25
#include <mmf/server/mmfdevsoundcustominterfaceobserver.h>
williamr@4
    26
#include <mmf/server/mmfdevsoundcustominterfacesupportclasses.h>
williamr@4
    27
#endif
williamr@4
    28
williamr@2
    29
#include <mmf/common/mmfstandardcustomcommands.h>
williamr@2
    30
williamr@4
    31
#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
    32
#include <mmf/common/mmfstandardcustomcommandsenums.h>
williamr@4
    33
#include <mmf/common/mmfstandardcustomcommandsimpl.h>
williamr@4
    34
#endif
williamr@4
    35
williamr@4
    36
williamr@2
    37
inline TInt CMMFDevSound::RegisterAsClient(TUid aEventType, const TDesC8& aNotificationRegistrationData)
williamr@2
    38
	{
williamr@2
    39
	MAutoPauseResumeSupport* support = 
williamr@2
    40
				static_cast<MAutoPauseResumeSupport*>(CustomInterface(KMmfUidDevSoundAudioResourceCustomInterface));
williamr@2
    41
	if (support==NULL)
williamr@2
    42
		{
williamr@2
    43
		return KErrNotSupported;
williamr@2
    44
		}
williamr@2
    45
	if(aEventType != KMMFEventCategoryAudioResourceAvailable)
williamr@2
    46
		{
williamr@2
    47
		return KErrNotSupported;
williamr@2
    48
		}
williamr@2
    49
	else
williamr@2
    50
		{ 
williamr@2
    51
		return support->RegisterAsClient(aEventType, aNotificationRegistrationData);	
williamr@2
    52
		}
williamr@2
    53
	}
williamr@2
    54
williamr@2
    55
inline TInt CMMFDevSound::CancelRegisterAsClient(TUid aEventType)
williamr@2
    56
	{
williamr@2
    57
	MAutoPauseResumeSupport* support = 
williamr@2
    58
			static_cast<MAutoPauseResumeSupport*>(CustomInterface(KMmfUidDevSoundAudioResourceCustomInterface));
williamr@2
    59
	if (support==NULL)
williamr@2
    60
		{
williamr@2
    61
		return KErrNotSupported;
williamr@2
    62
		}
williamr@2
    63
	if(aEventType != KMMFEventCategoryAudioResourceAvailable)
williamr@2
    64
		{
williamr@2
    65
		return KErrNotSupported;
williamr@2
    66
		}
williamr@2
    67
	else
williamr@2
    68
		{
williamr@2
    69
		return support->CancelRegisterAsClient(aEventType);
williamr@2
    70
		}
williamr@2
    71
	}
williamr@2
    72
williamr@2
    73
inline TInt CMMFDevSound::GetResourceNotificationData(TUid aEventType,TDes8& aNotificationData)
williamr@2
    74
	{
williamr@2
    75
	MAutoPauseResumeSupport* support = 
williamr@2
    76
			static_cast<MAutoPauseResumeSupport*>(CustomInterface(KMmfUidDevSoundAudioResourceCustomInterface));
williamr@2
    77
	if (support==NULL)
williamr@2
    78
		{
williamr@2
    79
		return KErrNotSupported;
williamr@2
    80
		}
williamr@2
    81
	if(aEventType != KMMFEventCategoryAudioResourceAvailable)
williamr@2
    82
		{
williamr@2
    83
		return KErrNotSupported;
williamr@2
    84
		}
williamr@2
    85
	else
williamr@2
    86
		{
williamr@2
    87
		return support->GetResourceNotificationData(aEventType, aNotificationData);
williamr@2
    88
		}
williamr@2
    89
	}
williamr@2
    90
williamr@2
    91
inline TInt CMMFDevSound::WillResumePlay()
williamr@2
    92
	{
williamr@2
    93
	MAutoPauseResumeSupport* support = 
williamr@2
    94
			static_cast<MAutoPauseResumeSupport*>(CustomInterface(KMmfUidDevSoundAudioResourceCustomInterface));
williamr@2
    95
	if (support==NULL)
williamr@2
    96
		{
williamr@2
    97
		return KErrNotSupported;
williamr@2
    98
		}
williamr@2
    99
	return support->WillResumePlay();
williamr@2
   100
	}
williamr@2
   101
williamr@2
   102
inline TInt CMMFDevSound::EmptyBuffers()
williamr@2
   103
	{
williamr@2
   104
	MMMFDevSoundEmptyBuffers* emptybuffers = 
williamr@2
   105
			static_cast<MMMFDevSoundEmptyBuffers*>(CustomInterface(KMmfUidDevSoundEmptyBuffersCustomInterface));
williamr@2
   106
	if (emptybuffers == NULL)
williamr@2
   107
		{
williamr@2
   108
		return KErrNotSupported;
williamr@2
   109
		}
williamr@2
   110
	return emptybuffers->EmptyBuffers();
williamr@2
   111
	}
williamr@2
   112
williamr@2
   113
inline TInt CMMFDevSound::CancelInitialize()
williamr@2
   114
	{
williamr@2
   115
	MMMFDevSoundCancelInitialize* cancelInitialize = 
williamr@2
   116
			static_cast<MMMFDevSoundCancelInitialize*>(CustomInterface(KMmfUidDevSoundCancelInitializeCustomInterface));
williamr@2
   117
	if (cancelInitialize == NULL)
williamr@2
   118
		{
williamr@2
   119
		return KErrNotSupported;
williamr@2
   120
		}
williamr@2
   121
	return cancelInitialize->CancelInitialize();
williamr@2
   122
	}
williamr@2
   123
williamr@2
   124
/*
williamr@2
   125
 *  -doxygen comments in header-
williamr@2
   126
 */
williamr@2
   127
inline TInt CMMFDevSound::SetClientThreadInfo(TThreadId aTid)
williamr@2
   128
	{
williamr@2
   129
	MAudioClientThreadInfo* threadInfo = 
williamr@2
   130
			static_cast<MAudioClientThreadInfo*>(CustomInterface(KMmfUidDevSoundAudioClientThreadInfoCustomInterface));
williamr@2
   131
	if (threadInfo)
williamr@2
   132
		{
williamr@2
   133
		return threadInfo->SetClientThreadInfo(aTid);
williamr@2
   134
		}
williamr@2
   135
	else
williamr@2
   136
		{
williamr@2
   137
		return KErrNotSupported;
williamr@2
   138
		}
williamr@2
   139
	}
williamr@2
   140
williamr@2
   141
inline TInt CMMFDevSound::GetTimePlayed(TTimeIntervalMicroSeconds& aTime)
williamr@2
   142
	{
williamr@2
   143
	MMMFDevSoundTimePlayed* timePlayed = 
williamr@2
   144
			static_cast<MMMFDevSoundTimePlayed*>(CustomInterface(KMmfUidDevSoundTimePlayedCustomInterface));
williamr@2
   145
	if (timePlayed == NULL)
williamr@2
   146
		{
williamr@2
   147
		return KErrNotSupported;
williamr@2
   148
		}
williamr@2
   149
	return timePlayed->GetTimePlayed(aTime);
williamr@2
   150
	}
williamr@2
   151
williamr@2
   152
inline TBool CMMFDevSound::IsGetTimePlayedSupported()
williamr@2
   153
	{
williamr@2
   154
	MMMFDevSoundTimePlayed* timePlayed = 
williamr@2
   155
			static_cast<MMMFDevSoundTimePlayed*>(CustomInterface(KMmfUidDevSoundTimePlayedCustomInterface));
williamr@2
   156
	if (timePlayed == NULL)
williamr@2
   157
		{
williamr@2
   158
		return EFalse;
williamr@2
   159
		}
williamr@2
   160
	return ETrue;
williamr@2
   161
	}
williamr@2
   162
williamr@2
   163
inline TBool CMMFDevSound::QueryIgnoresUnderflow()
williamr@2
   164
	{
williamr@2
   165
	MMMFDevSoundQueryIgnoresUnderflow* ignoresUnderflow = 
williamr@2
   166
			static_cast<MMMFDevSoundQueryIgnoresUnderflow*>(CustomInterface(KMmfUidDevSoundQueryIgnoresUnderflowCustomInterface));
williamr@2
   167
	if (ignoresUnderflow == NULL)
williamr@2
   168
		{
williamr@2
   169
		return EFalse;
williamr@2
   170
		}
williamr@2
   171
	return ignoresUnderflow->QueryIgnoresUnderflow();
williamr@2
   172
	}
williamr@2
   173
williamr@2
   174
inline TBool CMMFDevSound::IsResumeSupported()
williamr@2
   175
	{
williamr@2
   176
	MMMFDevSoundTruePause* truePause = 
williamr@2
   177
			static_cast<MMMFDevSoundTruePause*>(CustomInterface(KMmfUidDevSoundTruePauseCustomInterface));
williamr@2
   178
	if (truePause == NULL)
williamr@2
   179
		{
williamr@2
   180
		return EFalse;
williamr@2
   181
		}
williamr@2
   182
	return truePause->IsResumeSupported();
williamr@2
   183
	}
williamr@2
   184
williamr@2
   185
inline TInt CMMFDevSound::Resume()
williamr@2
   186
	{
williamr@2
   187
	MMMFDevSoundTruePause* truePause = 
williamr@2
   188
			static_cast<MMMFDevSoundTruePause*>(CustomInterface(KMmfUidDevSoundTruePauseCustomInterface));
williamr@2
   189
	if (truePause == NULL || EFalse == truePause->IsResumeSupported() )
williamr@2
   190
		{
williamr@2
   191
		return KErrNotSupported;
williamr@2
   192
		}
williamr@2
   193
	return truePause->Resume();
williamr@2
   194
	}
williamr@2
   195
williamr@2
   196
#endif // SOUNDDEVICE_INL