Change class VideoCaptureDevice::Name to struct VideoCaptureDeviceDescriptor

media/capture/video/video_capture_device_descriptor.h

+// Copyright 2016 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef MEDIA_CAPTURE_VIDEO_VIDEO_CAPTURE_DEVICE_DESCRIPTOR_H_
+#define MEDIA_CAPTURE_VIDEO_VIDEO_CAPTURE_DEVICE_DESCRIPTOR_H_
+
+#include <list>
+#include <string>
+
+#include "media/capture/capture_export.h"
+
+namespace media {
+
+// A Java counterpart will be generated for this enum.
+// GENERATED_JAVA_ENUM_PACKAGE: org.chromium.media
+enum class VideoCaptureApi {
+  LINUX_V4L2_SINGLE_PLANE,
+  WIN_MEDIA_FOUNDATION,
+  WIN_DIRECT_SHOW,
+  MACOSX_AVFOUNDATION,
+  MACOSX_DECKLINK,
+  ANDROID_API1,
+  ANDROID_API2_LEGACY,
+  ANDROID_API2_FULL,
+  ANDROID_API2_LIMITED,
+  ANDROID_TANGO,
+  UNKNOWN
+};
+
+enum class VideoCaptureTransportType {
+  // For AVFoundation Api, identify devices that are built-in or USB.
+  MACOSX_USB_OR_BUILT_IN,
+  OTHER_TRANSPORT
+};
+
+// Represents information about a capture device as returned by
+// VideoCaptureDeviceFactory::EnumerateDeviceDescriptors().
+// |device_id| represents a unique id of a physical device. Since the same
+// physical device may be accessible through different APIs |capture_api|
+// disambiguates the API.
+struct CAPTURE_EXPORT VideoCaptureDeviceDescriptor {
+ public:
+  VideoCaptureDeviceDescriptor();
+  VideoCaptureDeviceDescriptor(
+      const std::string& display_name,
+      const std::string& device_id,
+      VideoCaptureApi capture_api = VideoCaptureApi::UNKNOWN,
+      VideoCaptureTransportType transport_type =
+          VideoCaptureTransportType::OTHER_TRANSPORT);
+  VideoCaptureDeviceDescriptor(const std::string& display_name,
+                               const std::string& device_id,
+                               const std::string& model_id,
+                               VideoCaptureApi capture_api,
+                               VideoCaptureTransportType transport_type =
+                                   VideoCaptureTransportType::OTHER_TRANSPORT);
+  VideoCaptureDeviceDescriptor(const VideoCaptureDeviceDescriptor& other);
+  ~VideoCaptureDeviceDescriptor();
+
+  // These operators are needed due to storing the name in an STL container.
+  // In the shared build, all methods from the STL container will be exported
+  // so even though they're not used, they're still depended upon.
+  bool operator==(const VideoCaptureDeviceDescriptor& other) const {
+    return (other.device_id == device_id) && (other.capture_api == capture_api);
+  }
+  bool operator<(const VideoCaptureDeviceDescriptor& other) const {
+    if (device_id < other.device_id)
+      return true;
+    return capture_api < other.capture_api;
+  }
+
+  const char* GetCaptureApiTypeString() const;
+  // Friendly name of a device, plus the model identifier in parentheses.
+  std::string GetNameAndModel() const;
+
+  std::string display_name;  // Name that is intended for display in the UI
+  std::string device_id;
+  // A unique hardware identifier of the capture device.
+  // It is of the form "[vid]:[pid]" when a USB device is detected, and empty
+  // otherwise.
+  std::string model_id;
+
+  VideoCaptureApi capture_api;
+  VideoCaptureTransportType transport_type;
+};
+
+using VideoCaptureDeviceDescriptors = std::list<VideoCaptureDeviceDescriptor>;
+
+}  // namespace media
+
+#endif  // MEDIA_CAPTURE_VIDEO_VIDEO_CAPTURE_DEVICE_DESCRIPTOR_H_