1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 // MediaStreamProvider is used to capture media of the types defined in
6 // MediaStreamType. There is only one MediaStreamProvider instance per media
7 // type and a MediaStreamProvider instance can have only one registered
9 // The MediaStreamManager is expected to be called on Browser::IO thread and
10 // the listener will be called on the same thread.
12 #ifndef CONTENT_BROWSER_RENDERER_HOST_MEDIA_MEDIA_STREAM_PROVIDER_H_
13 #define CONTENT_BROWSER_RENDERER_HOST_MEDIA_MEDIA_STREAM_PROVIDER_H_
18 #include "base/memory/ref_counted.h"
19 #include "content/common/content_export.h"
20 #include "content/common/media/media_stream_options.h"
23 class SingleThreadTaskRunner;
28 enum MediaStreamProviderError {
30 kInvalidMediaStreamType,
38 enum { kInvalidMediaCaptureSessionId = 0xFFFFFFFF };
40 // Callback class used by MediaStreamProvider.
41 class CONTENT_EXPORT MediaStreamProviderListener {
43 // Called by a MediaStreamProvider when a stream has been opened.
44 virtual void Opened(MediaStreamType stream_type, int capture_session_id) = 0;
46 // Called by a MediaStreamProvider when a stream has been closed.
47 virtual void Closed(MediaStreamType stream_type, int capture_session_id) = 0;
49 // Called by a MediaStreamProvider when available devices has been enumerated.
50 virtual void DevicesEnumerated(MediaStreamType stream_type,
51 const StreamDeviceInfoArray& devices) = 0;
54 virtual ~MediaStreamProviderListener() {}
57 // Implemented by a manager class providing captured media.
58 class CONTENT_EXPORT MediaStreamProvider
59 : public base::RefCountedThreadSafe<MediaStreamProvider> {
61 // Registers a listener and a device message loop.
62 virtual void Register(MediaStreamProviderListener* listener,
63 const scoped_refptr<base::SingleThreadTaskRunner>&
64 device_task_runner) = 0;
66 // Unregisters the previously registered listener.
67 virtual void Unregister() = 0;
69 // Enumerates existing capture devices and calls |DevicesEnumerated|.
70 virtual void EnumerateDevices(MediaStreamType stream_type) = 0;
72 // Opens the specified device. The device is not started and it is still
73 // possible for other applications to open the device before the device is
74 // started. |Opened| is called when the device is opened.
75 // kInvalidMediaCaptureSessionId is returned on error.
76 virtual int Open(const StreamDeviceInfo& device) = 0;
78 // Closes the specified device and calls |Closed| when done.
79 virtual void Close(int capture_session_id) = 0;
82 friend class base::RefCountedThreadSafe<MediaStreamProvider>;
83 virtual ~MediaStreamProvider() {}
86 } // namespace content
88 #endif // CONTENT_BROWSER_RENDERER_HOST_MEDIA_MEDIA_STREAM_PROVIDER_H_