IControlInterface.cs 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. // -----------------------------------------
  2. // SoundScribe (TM) and related software.
  3. //
  4. // Copyright (C) 2007-2011 Vannatech
  5. // http://www.vannatech.com
  6. // All rights reserved.
  7. //
  8. // This source code is subject to the MIT License.
  9. // http://www.opensource.org/licenses/mit-license.php
  10. //
  11. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  12. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  13. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  14. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  15. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  16. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  17. // THE SOFTWARE.
  18. // -----------------------------------------
  19. using System;
  20. using System.Runtime.InteropServices;
  21. namespace Vannatech.CoreAudio.Interfaces
  22. {
  23. /// <summary>
  24. /// Represents a control interface on a part (connector or subunit) in a device topology.
  25. /// </summary>
  26. /// <remarks>
  27. /// MSDN Reference: http://msdn.microsoft.com/en-us/library/dd371098.aspx
  28. /// </remarks>
  29. public partial interface IControlInterface
  30. {
  31. /// <summary>
  32. /// Gets the friendly name for the audio function that the control interface encapsulates.
  33. /// </summary>
  34. /// <param name="name">Receives a string that contains the friendly name.</param>
  35. /// <returns>An HRESULT code indicating whether the operation succeeded of failed.</returns>
  36. [PreserveSig]
  37. int GetName(
  38. [Out] [MarshalAs(UnmanagedType.LPWStr)] out string name);
  39. /// <summary>
  40. /// Gets the interface ID of the function-specific control interface of the part.
  41. /// </summary>
  42. /// <param name="interfaceId">Receives the interface ID of the function-specific control interface of the part.</param>
  43. /// <returns>An HRESULT code indicating whether the operation succeeded of failed.</returns>
  44. [PreserveSig]
  45. int GetIID(
  46. [Out] out Guid interfaceId);
  47. }
  48. }