Zeke Chin | b3fb71c | 2016-02-18 15:44:07 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016 The WebRTC Project Authors. All rights reserved. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license |
| 5 | * that can be found in the LICENSE file in the root of the source |
| 6 | * tree. An additional intellectual property rights grant can be found |
| 7 | * in the file PATENTS. All contributing project authors may |
| 8 | * be found in the AUTHORS file in the root of the source tree. |
| 9 | */ |
| 10 | |
Anders Carlsson | 7bca8ca | 2018-08-30 09:30:29 +0200 | [diff] [blame] | 11 | #import "RTCAudioSession.h" |
Zeke Chin | b3fb71c | 2016-02-18 15:44:07 -0800 | [diff] [blame] | 12 | |
| 13 | NS_ASSUME_NONNULL_BEGIN |
| 14 | |
Mirko Bonadei | a81e9c8 | 2020-05-04 16:14:32 +0200 | [diff] [blame^] | 15 | @class RTC_OBJC_TYPE(RTCAudioSessionConfiguration); |
Tze Kwang Chin | 307a092 | 2016-03-21 13:57:40 -0700 | [diff] [blame] | 16 | |
Mirko Bonadei | a81e9c8 | 2020-05-04 16:14:32 +0200 | [diff] [blame^] | 17 | @interface RTC_OBJC_TYPE (RTCAudioSession) |
| 18 | () |
Zeke Chin | b3fb71c | 2016-02-18 15:44:07 -0800 | [diff] [blame] | 19 | |
Mirko Bonadei | a81e9c8 | 2020-05-04 16:14:32 +0200 | [diff] [blame^] | 20 | /** Number of times setActive:YES has succeeded without a balanced call to |
| 21 | * setActive:NO. |
| 22 | */ |
| 23 | @property(nonatomic, readonly) int activationCount; |
Tze Kwang Chin | 307a092 | 2016-03-21 13:57:40 -0700 | [diff] [blame] | 24 | |
| 25 | /** The number of times |beginWebRTCSession| was called without a balanced call |
| 26 | * to |endWebRTCSession|. |
| 27 | */ |
| 28 | @property(nonatomic, readonly) int webRTCSessionCount; |
| 29 | |
tkchin | d251196 | 2016-05-06 18:54:15 -0700 | [diff] [blame] | 30 | /** Convenience BOOL that checks useManualAudio and isAudioEnebled. */ |
| 31 | @property(readonly) BOOL canPlayOrRecord; |
Zeke Chin | b3fb71c | 2016-02-18 15:44:07 -0800 | [diff] [blame] | 32 | |
tkchin | 93dd634 | 2016-07-27 10:17:14 -0700 | [diff] [blame] | 33 | /** Tracks whether we have been sent an interruption event that hasn't been matched by either an |
| 34 | * interrupted end event or a foreground event. |
| 35 | */ |
| 36 | @property(nonatomic, assign) BOOL isInterrupted; |
| 37 | |
tkchin | 9f987d3 | 2016-03-12 20:06:28 -0800 | [diff] [blame] | 38 | - (BOOL)checkLock:(NSError **)outError; |
| 39 | |
tkchin | e54467f | 2016-03-15 16:54:03 -0700 | [diff] [blame] | 40 | /** Adds the delegate to the list of delegates, and places it at the front of |
| 41 | * the list. This delegate will be notified before other delegates of |
| 42 | * audio events. |
| 43 | */ |
Mirko Bonadei | a81e9c8 | 2020-05-04 16:14:32 +0200 | [diff] [blame^] | 44 | - (void)pushDelegate:(id<RTC_OBJC_TYPE(RTCAudioSessionDelegate)>)delegate; |
tkchin | e54467f | 2016-03-15 16:54:03 -0700 | [diff] [blame] | 45 | |
Tze Kwang Chin | 307a092 | 2016-03-21 13:57:40 -0700 | [diff] [blame] | 46 | /** Signals RTCAudioSession that a WebRTC session is about to begin and |
| 47 | * audio configuration is needed. Will configure the audio session for WebRTC |
| 48 | * if not already configured and if configuration is not delayed. |
| 49 | * Successful calls must be balanced by a call to endWebRTCSession. |
| 50 | */ |
| 51 | - (BOOL)beginWebRTCSession:(NSError **)outError; |
| 52 | |
| 53 | /** Signals RTCAudioSession that a WebRTC session is about to end and audio |
| 54 | * unconfiguration is needed. Will unconfigure the audio session for WebRTC |
| 55 | * if this is the last unmatched call and if configuration is not delayed. |
| 56 | */ |
| 57 | - (BOOL)endWebRTCSession:(NSError **)outError; |
| 58 | |
tkchin | d251196 | 2016-05-06 18:54:15 -0700 | [diff] [blame] | 59 | /** Configure the audio session for WebRTC. This call will fail if the session |
| 60 | * is already configured. On other failures, we will attempt to restore the |
| 61 | * previously used audio session configuration. |
| 62 | * |lockForConfiguration| must be called first. |
| 63 | * Successful calls to configureWebRTCSession must be matched by calls to |
| 64 | * |unconfigureWebRTCSession|. |
| 65 | */ |
| 66 | - (BOOL)configureWebRTCSession:(NSError **)outError; |
| 67 | |
| 68 | /** Unconfigures the session for WebRTC. This will attempt to restore the |
| 69 | * audio session to the settings used before |configureWebRTCSession| was |
| 70 | * called. |
| 71 | * |lockForConfiguration| must be called first. |
| 72 | */ |
| 73 | - (BOOL)unconfigureWebRTCSession:(NSError **)outError; |
| 74 | |
Tze Kwang Chin | 307a092 | 2016-03-21 13:57:40 -0700 | [diff] [blame] | 75 | /** Returns a configuration error with the given description. */ |
| 76 | - (NSError *)configurationErrorWithDescription:(NSString *)description; |
| 77 | |
tkchin | e54467f | 2016-03-15 16:54:03 -0700 | [diff] [blame] | 78 | // Properties and methods for tests. |
tkchin | e54467f | 2016-03-15 16:54:03 -0700 | [diff] [blame] | 79 | - (void)notifyDidBeginInterruption; |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 80 | - (void)notifyDidEndInterruptionWithShouldResumeSession:(BOOL)shouldResumeSession; |
tkchin | e54467f | 2016-03-15 16:54:03 -0700 | [diff] [blame] | 81 | - (void)notifyDidChangeRouteWithReason:(AVAudioSessionRouteChangeReason)reason |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 82 | previousRoute:(AVAudioSessionRouteDescription *)previousRoute; |
tkchin | e54467f | 2016-03-15 16:54:03 -0700 | [diff] [blame] | 83 | - (void)notifyMediaServicesWereLost; |
| 84 | - (void)notifyMediaServicesWereReset; |
tkchin | d251196 | 2016-05-06 18:54:15 -0700 | [diff] [blame] | 85 | - (void)notifyDidChangeCanPlayOrRecord:(BOOL)canPlayOrRecord; |
| 86 | - (void)notifyDidStartPlayOrRecord; |
| 87 | - (void)notifyDidStopPlayOrRecord; |
Anders Carlsson | 121ea32 | 2017-06-26 15:34:47 +0200 | [diff] [blame] | 88 | - (void)notifyDidDetectPlayoutGlitch:(int64_t)totalNumberOfGlitches; |
tkchin | e54467f | 2016-03-15 16:54:03 -0700 | [diff] [blame] | 89 | |
Zeke Chin | b3fb71c | 2016-02-18 15:44:07 -0800 | [diff] [blame] | 90 | @end |
| 91 | |
| 92 | NS_ASSUME_NONNULL_END |