1/*
2 * libjingle
3 * Copyright 2004--2010, Google Inc.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 *  1. Redistributions of source code must retain the above copyright notice,
9 *     this list of conditions and the following disclaimer.
10 *  2. Redistributions in binary form must reproduce the above copyright notice,
11 *     this list of conditions and the following disclaimer in the documentation
12 *     and/or other materials provided with the distribution.
13 *  3. The name of the author may not be used to endorse or promote products
14 *     derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
19 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28#ifndef TALK_SOUND_SOUNDDEVICELOCATOR_H_
29#define TALK_SOUND_SOUNDDEVICELOCATOR_H_
30
31#include <string>
32
33#include "talk/base/constructormagic.h"
34
35namespace cricket {
36
37// A simple container for holding the name of a device and any additional id
38// information needed to locate and open it. Implementations of
39// SoundSystemInterface must subclass this to add any id information that they
40// need.
41class SoundDeviceLocator {
42 public:
43  virtual ~SoundDeviceLocator() {}
44
45  // Human-readable name for the device.
46  const std::string &name() const { return name_; }
47
48  // Name sound system uses to locate this device.
49  const std::string &device_name() const { return device_name_; }
50
51  // Makes a duplicate of this locator.
52  virtual SoundDeviceLocator *Copy() const = 0;
53
54 protected:
55  SoundDeviceLocator(const std::string &name,
56                     const std::string &device_name)
57      : name_(name), device_name_(device_name) {}
58
59  explicit SoundDeviceLocator(const SoundDeviceLocator &that)
60      : name_(that.name_), device_name_(that.device_name_) {}
61
62  std::string name_;
63  std::string device_name_;
64
65 private:
66  DISALLOW_ASSIGN(SoundDeviceLocator);
67};
68
69}  // namespace cricket
70
71#endif  // TALK_SOUND_SOUNDDEVICELOCATOR_H_
72