Version
menu_open
Wwise SDK 2023.1.4
AkPlatformContext.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Copyright (c) 2024 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 #ifndef __AK_PLATFORM_CONTEXT_IOS_H__
28 #define __AK_PLATFORM_CONTEXT_IOS_H__
29 
31 
32 namespace AK
33 {
34  /// Context specific to the iOS port of Wwise SDK.
36  {
37  public:
38  // Retrieve the latest effective audio session properties
39  // \sa AkPlatformInitSettings::audioSession
40  // \sa AK::SoundEngine::iOS::ChangeAudioSessionProperties
42 
43  // This should be called at Init() time by any sink plug-in requiring an active AVAudioSession to function properly.
44  // If ActivateAudioSession returns a result other than AK_Success, this result should be returned by the calling sink's Init() function.
45  // \sa DeactivateAudioSession
47 
48  // Each call to ActivateAudioSession should be balanced with DeactivateAudioSession when the sink no longer requires the audio session.
49  // Usually this is done in the sink's Term() function.
50  // \sa ActivateAudioSession
51  virtual void DeactivateAudioSession() = 0;
52 
53  // Returns the minimum buffer period, in seconds, required to avoid starvation on the current audio route
54  virtual float GetCurrentRouteMinimumLatency() const = 0;
55 
56  // Request a change in the audio session's output channel count
57  // The request may be denied by the system, in which case AK_UnsupportedChannelConfig will be returned.
58  // Pass 0 to maximize the number of output channels with regards to AVAudioSession::maximumOutputNumberOfChannels
60  };
61 }
62 
63 #endif // __AK_PLATFORM_CONTEXT_IOS_H__
virtual float GetCurrentRouteMinimumLatency() const =0
virtual AKRESULT ActivateAudioSession()=0
Audiokinetic namespace.
AKRESULT
Standard function call result.
Definition: AkTypes.h:131
virtual AkAudioSessionProperties GetAudioSessionProperties()=0
virtual AKRESULT SetPreferredNumberOfOutputChannels(AkUInt32 uNumChannels)=0
virtual void DeactivateAudioSession()=0
uint32_t AkUInt32
Unsigned 32-bit integer.
Context specific to the iOS port of Wwise SDK.

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise