IotHubMessageSource.xml

<Type Name="IotHubMessageSource" FullName="Azure.Media.VideoAnalyzer.Edge.Models.IotHubMessageSource">
  <TypeSignature Language="C#" Value="public class IotHubMessageSource : Azure.Media.VideoAnalyzer.Edge.Models.SourceNodeBase" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit IotHubMessageSource extends Azure.Media.VideoAnalyzer.Edge.Models.SourceNodeBase" />
  <TypeSignature Language="DocId" Value="T:Azure.Media.VideoAnalyzer.Edge.Models.IotHubMessageSource" />
  <TypeSignature Language="VB.NET" Value="Public Class IotHubMessageSource&#xA;Inherits SourceNodeBase" />
  <TypeSignature Language="F#" Value="type IotHubMessageSource = class&#xA;    inherit SourceNodeBase" />
  <AssemblyInfo>
    <AssemblyName>Azure.Media.VideoAnalyzer.Edge</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Azure.Media.VideoAnalyzer.Edge.Models.SourceNodeBase</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary> IoT Hub Message source allows for the pipeline to consume messages from the IoT Edge Hub. Messages can be routed from other IoT modules via routes declared in the IoT Edge deployment manifest. </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public IotHubMessageSource (string name);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Media.VideoAnalyzer.Edge.Models.IotHubMessageSource.#ctor(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (name As String)" />
      <MemberSignature Language="F#" Value="new Azure.Media.VideoAnalyzer.Edge.Models.IotHubMessageSource : string -&gt; Azure.Media.VideoAnalyzer.Edge.Models.IotHubMessageSource" Usage="new Azure.Media.VideoAnalyzer.Edge.Models.IotHubMessageSource name" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Media.VideoAnalyzer.Edge</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="name" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="name"> Node name. Must be unique within the topology. </param>
        <summary> Initializes a new instance of IotHubMessageSource. </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="name" /> is null. </exception>
      </Docs>
    </Member>
    <Member MemberName="HubInputName">
      <MemberSignature Language="C#" Value="public string HubInputName { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string HubInputName" />
      <MemberSignature Language="DocId" Value="P:Azure.Media.VideoAnalyzer.Edge.Models.IotHubMessageSource.HubInputName" />
      <MemberSignature Language="VB.NET" Value="Public Property HubInputName As String" />
      <MemberSignature Language="F#" Value="member this.HubInputName : string with get, set" Usage="Azure.Media.VideoAnalyzer.Edge.Models.IotHubMessageSource.HubInputName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Media.VideoAnalyzer.Edge</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Name of the IoT Edge Hub input from which messages will be consumed. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>