epoc32/include/mmf/server/sounddevice.inl
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
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@2
     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
williamr@2
     8
// which accompanies this distribution, and is available
williamr@2
     9
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.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@2
    23
#include <mmf/common/mmfstandardcustomcommands.h>
williamr@2
    24
williamr@2
    25
inline TInt CMMFDevSound::RegisterAsClient(TUid aEventType, const TDesC8& aNotificationRegistrationData)
williamr@2
    26
	{
williamr@2
    27
	MAutoPauseResumeSupport* support = 
williamr@2
    28
				static_cast<MAutoPauseResumeSupport*>(CustomInterface(KMmfUidDevSoundAudioResourceCustomInterface));
williamr@2
    29
	if (support==NULL)
williamr@2
    30
		{
williamr@2
    31
		return KErrNotSupported;
williamr@2
    32
		}
williamr@2
    33
	if(aEventType != KMMFEventCategoryAudioResourceAvailable)
williamr@2
    34
		{
williamr@2
    35
		return KErrNotSupported;
williamr@2
    36
		}
williamr@2
    37
	else
williamr@2
    38
		{ 
williamr@2
    39
		return support->RegisterAsClient(aEventType, aNotificationRegistrationData);	
williamr@2
    40
		}
williamr@2
    41
	}
williamr@2
    42
williamr@2
    43
inline TInt CMMFDevSound::CancelRegisterAsClient(TUid aEventType)
williamr@2
    44
	{
williamr@2
    45
	MAutoPauseResumeSupport* support = 
williamr@2
    46
			static_cast<MAutoPauseResumeSupport*>(CustomInterface(KMmfUidDevSoundAudioResourceCustomInterface));
williamr@2
    47
	if (support==NULL)
williamr@2
    48
		{
williamr@2
    49
		return KErrNotSupported;
williamr@2
    50
		}
williamr@2
    51
	if(aEventType != KMMFEventCategoryAudioResourceAvailable)
williamr@2
    52
		{
williamr@2
    53
		return KErrNotSupported;
williamr@2
    54
		}
williamr@2
    55
	else
williamr@2
    56
		{
williamr@2
    57
		return support->CancelRegisterAsClient(aEventType);
williamr@2
    58
		}
williamr@2
    59
	}
williamr@2
    60
williamr@2
    61
inline TInt CMMFDevSound::GetResourceNotificationData(TUid aEventType,TDes8& aNotificationData)
williamr@2
    62
	{
williamr@2
    63
	MAutoPauseResumeSupport* support = 
williamr@2
    64
			static_cast<MAutoPauseResumeSupport*>(CustomInterface(KMmfUidDevSoundAudioResourceCustomInterface));
williamr@2
    65
	if (support==NULL)
williamr@2
    66
		{
williamr@2
    67
		return KErrNotSupported;
williamr@2
    68
		}
williamr@2
    69
	if(aEventType != KMMFEventCategoryAudioResourceAvailable)
williamr@2
    70
		{
williamr@2
    71
		return KErrNotSupported;
williamr@2
    72
		}
williamr@2
    73
	else
williamr@2
    74
		{
williamr@2
    75
		return support->GetResourceNotificationData(aEventType, aNotificationData);
williamr@2
    76
		}
williamr@2
    77
	}
williamr@2
    78
williamr@2
    79
inline TInt CMMFDevSound::WillResumePlay()
williamr@2
    80
	{
williamr@2
    81
	MAutoPauseResumeSupport* support = 
williamr@2
    82
			static_cast<MAutoPauseResumeSupport*>(CustomInterface(KMmfUidDevSoundAudioResourceCustomInterface));
williamr@2
    83
	if (support==NULL)
williamr@2
    84
		{
williamr@2
    85
		return KErrNotSupported;
williamr@2
    86
		}
williamr@2
    87
	return support->WillResumePlay();
williamr@2
    88
	}
williamr@2
    89
williamr@2
    90
inline TInt CMMFDevSound::EmptyBuffers()
williamr@2
    91
	{
williamr@2
    92
	MMMFDevSoundEmptyBuffers* emptybuffers = 
williamr@2
    93
			static_cast<MMMFDevSoundEmptyBuffers*>(CustomInterface(KMmfUidDevSoundEmptyBuffersCustomInterface));
williamr@2
    94
	if (emptybuffers == NULL)
williamr@2
    95
		{
williamr@2
    96
		return KErrNotSupported;
williamr@2
    97
		}
williamr@2
    98
	return emptybuffers->EmptyBuffers();
williamr@2
    99
	}
williamr@2
   100
williamr@2
   101
inline TInt CMMFDevSound::CancelInitialize()
williamr@2
   102
	{
williamr@2
   103
	MMMFDevSoundCancelInitialize* cancelInitialize = 
williamr@2
   104
			static_cast<MMMFDevSoundCancelInitialize*>(CustomInterface(KMmfUidDevSoundCancelInitializeCustomInterface));
williamr@2
   105
	if (cancelInitialize == NULL)
williamr@2
   106
		{
williamr@2
   107
		return KErrNotSupported;
williamr@2
   108
		}
williamr@2
   109
	return cancelInitialize->CancelInitialize();
williamr@2
   110
	}
williamr@2
   111
williamr@2
   112
/*
williamr@2
   113
 *  -doxygen comments in header-
williamr@2
   114
 */
williamr@2
   115
inline TInt CMMFDevSound::SetClientThreadInfo(TThreadId aTid)
williamr@2
   116
	{
williamr@2
   117
	MAudioClientThreadInfo* threadInfo = 
williamr@2
   118
			static_cast<MAudioClientThreadInfo*>(CustomInterface(KMmfUidDevSoundAudioClientThreadInfoCustomInterface));
williamr@2
   119
	if (threadInfo)
williamr@2
   120
		{
williamr@2
   121
		return threadInfo->SetClientThreadInfo(aTid);
williamr@2
   122
		}
williamr@2
   123
	else
williamr@2
   124
		{
williamr@2
   125
		return KErrNotSupported;
williamr@2
   126
		}
williamr@2
   127
	}
williamr@2
   128
williamr@2
   129
inline TInt CMMFDevSound::GetTimePlayed(TTimeIntervalMicroSeconds& aTime)
williamr@2
   130
	{
williamr@2
   131
	MMMFDevSoundTimePlayed* timePlayed = 
williamr@2
   132
			static_cast<MMMFDevSoundTimePlayed*>(CustomInterface(KMmfUidDevSoundTimePlayedCustomInterface));
williamr@2
   133
	if (timePlayed == NULL)
williamr@2
   134
		{
williamr@2
   135
		return KErrNotSupported;
williamr@2
   136
		}
williamr@2
   137
	return timePlayed->GetTimePlayed(aTime);
williamr@2
   138
	}
williamr@2
   139
williamr@2
   140
inline TBool CMMFDevSound::IsGetTimePlayedSupported()
williamr@2
   141
	{
williamr@2
   142
	MMMFDevSoundTimePlayed* timePlayed = 
williamr@2
   143
			static_cast<MMMFDevSoundTimePlayed*>(CustomInterface(KMmfUidDevSoundTimePlayedCustomInterface));
williamr@2
   144
	if (timePlayed == NULL)
williamr@2
   145
		{
williamr@2
   146
		return EFalse;
williamr@2
   147
		}
williamr@2
   148
	return ETrue;
williamr@2
   149
	}
williamr@2
   150
williamr@2
   151
inline TBool CMMFDevSound::QueryIgnoresUnderflow()
williamr@2
   152
	{
williamr@2
   153
	MMMFDevSoundQueryIgnoresUnderflow* ignoresUnderflow = 
williamr@2
   154
			static_cast<MMMFDevSoundQueryIgnoresUnderflow*>(CustomInterface(KMmfUidDevSoundQueryIgnoresUnderflowCustomInterface));
williamr@2
   155
	if (ignoresUnderflow == NULL)
williamr@2
   156
		{
williamr@2
   157
		return EFalse;
williamr@2
   158
		}
williamr@2
   159
	return ignoresUnderflow->QueryIgnoresUnderflow();
williamr@2
   160
	}
williamr@2
   161
williamr@2
   162
inline TBool CMMFDevSound::IsResumeSupported()
williamr@2
   163
	{
williamr@2
   164
	MMMFDevSoundTruePause* truePause = 
williamr@2
   165
			static_cast<MMMFDevSoundTruePause*>(CustomInterface(KMmfUidDevSoundTruePauseCustomInterface));
williamr@2
   166
	if (truePause == NULL)
williamr@2
   167
		{
williamr@2
   168
		return EFalse;
williamr@2
   169
		}
williamr@2
   170
	return truePause->IsResumeSupported();
williamr@2
   171
	}
williamr@2
   172
williamr@2
   173
inline TInt CMMFDevSound::Resume()
williamr@2
   174
	{
williamr@2
   175
	MMMFDevSoundTruePause* truePause = 
williamr@2
   176
			static_cast<MMMFDevSoundTruePause*>(CustomInterface(KMmfUidDevSoundTruePauseCustomInterface));
williamr@2
   177
	if (truePause == NULL || EFalse == truePause->IsResumeSupported() )
williamr@2
   178
		{
williamr@2
   179
		return KErrNotSupported;
williamr@2
   180
		}
williamr@2
   181
	return truePause->Resume();
williamr@2
   182
	}
williamr@2
   183
williamr@2
   184
#endif // SOUNDDEVICE_INL