OLD | NEW |
1 /* | 1 /* |
2 * Copyright (c) 2015 The WebRTC project authors. All Rights Reserved. | 2 * Copyright (c) 2015 The WebRTC project authors. All Rights Reserved. |
3 * | 3 * |
4 * Use of this source code is governed by a BSD-style license | 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 | 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 | 6 * tree. An additional intellectual property rights grant can be found |
7 * in the file PATENTS. All contributing project authors may | 7 * in the file PATENTS. All contributing project authors may |
8 * be found in the AUTHORS file in the root of the source tree. | 8 * be found in the AUTHORS file in the root of the source tree. |
9 */ | 9 */ |
10 #ifndef WEBRTC_AUDIO_STATE_H_ | 10 #ifndef WEBRTC_AUDIO_STATE_H_ |
11 #define WEBRTC_AUDIO_STATE_H_ | 11 #define WEBRTC_AUDIO_STATE_H_ |
12 | 12 |
13 #include "webrtc/base/refcount.h" | 13 #include "webrtc/base/refcount.h" |
14 #include "webrtc/base/scoped_ref_ptr.h" | 14 #include "webrtc/base/scoped_ref_ptr.h" |
15 | 15 |
16 namespace webrtc { | 16 namespace webrtc { |
17 | 17 |
18 class AudioDeviceModule; | 18 class AudioDeviceModule; |
19 class VoiceEngine; | 19 class VoiceEngine; |
20 | 20 |
| 21 // WORK IN PROGRESS |
| 22 // This class is under development and is not yet intended for for use outside |
| 23 // of WebRtc/Libjingle. Please use the VoiceEngine API instead. |
| 24 |
21 // AudioState holds the state which must be shared between multiple instances of | 25 // AudioState holds the state which must be shared between multiple instances of |
22 // webrtc::Call for audio processing purposes. | 26 // webrtc::Call for audio processing purposes. |
23 class AudioState : public rtc::RefCountInterface { | 27 class AudioState : public rtc::RefCountInterface { |
24 public: | 28 public: |
25 struct Config { | 29 struct Config { |
26 // VoiceEngine used for audio streams and audio/video synchronization. | 30 // VoiceEngine used for audio streams and audio/video synchronization. |
27 // AudioState will tickle the VoE refcount to keep it alive for as long as | 31 // AudioState will tickle the VoE refcount to keep it alive for as long as |
28 // the AudioState itself. | 32 // the AudioState itself. |
29 VoiceEngine* voice_engine = nullptr; | 33 VoiceEngine* voice_engine = nullptr; |
30 | 34 |
31 // The AudioDeviceModule associated with the Calls. | 35 // The AudioDeviceModule associated with the Calls. |
32 AudioDeviceModule* audio_device_module = nullptr; | 36 AudioDeviceModule* audio_device_module = nullptr; |
33 }; | 37 }; |
34 | 38 |
35 // TODO(solenberg): Replace scoped_refptr with shared_ptr once we can use it. | 39 // TODO(solenberg): Replace scoped_refptr with shared_ptr once we can use it. |
36 static rtc::scoped_refptr<AudioState> Create( | 40 static rtc::scoped_refptr<AudioState> Create( |
37 const AudioState::Config& config); | 41 const AudioState::Config& config); |
38 | 42 |
39 virtual ~AudioState() {} | 43 virtual ~AudioState() {} |
40 }; | 44 }; |
41 } // namespace webrtc | 45 } // namespace webrtc |
42 | 46 |
43 #endif // WEBRTC_AUDIO_STATE_H_ | 47 #endif // WEBRTC_AUDIO_STATE_H_ |
OLD | NEW |