LiveEventInput.xml

<Type Name="LiveEventInput" FullName="Microsoft.Azure.Management.Media.Models.LiveEventInput">
  <TypeSignature Language="C#" Value="public class LiveEventInput" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit LiveEventInput extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.Media.Models.LiveEventInput" />
  <TypeSignature Language="VB.NET" Value="Public Class LiveEventInput" />
  <TypeSignature Language="F#" Value="type LiveEventInput = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
    <AssemblyVersion>3.0.4.0</AssemblyVersion>
    <AssemblyVersion>3.0.5.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
    <AssemblyVersion>5.0.0.0</AssemblyVersion>
    <AssemblyVersion>6.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            The live event input.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public LiveEventInput ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Media.Models.LiveEventInput.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>
            Initializes a new instance of the LiveEventInput class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public LiveEventInput (Microsoft.Azure.Management.Media.Models.LiveEventInputProtocol streamingProtocol, Microsoft.Azure.Management.Media.Models.LiveEventInputAccessControl accessControl = default, string keyFrameIntervalDuration = default, string accessToken = default, System.Collections.Generic.IList&lt;Microsoft.Azure.Management.Media.Models.LiveEventEndpoint&gt; endpoints = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Azure.Management.Media.Models.LiveEventInputProtocol streamingProtocol, class Microsoft.Azure.Management.Media.Models.LiveEventInputAccessControl accessControl, string keyFrameIntervalDuration, string accessToken, class System.Collections.Generic.IList`1&lt;class Microsoft.Azure.Management.Media.Models.LiveEventEndpoint&gt; endpoints) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Media.Models.LiveEventInput.#ctor(Microsoft.Azure.Management.Media.Models.LiveEventInputProtocol,Microsoft.Azure.Management.Media.Models.LiveEventInputAccessControl,System.String,System.String,System.Collections.Generic.IList{Microsoft.Azure.Management.Media.Models.LiveEventEndpoint})" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (streamingProtocol As LiveEventInputProtocol, Optional accessControl As LiveEventInputAccessControl = Nothing, Optional keyFrameIntervalDuration As String = Nothing, Optional accessToken As String = Nothing, Optional endpoints As IList(Of LiveEventEndpoint) = Nothing)" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.Management.Media.Models.LiveEventInput : Microsoft.Azure.Management.Media.Models.LiveEventInputProtocol * Microsoft.Azure.Management.Media.Models.LiveEventInputAccessControl * string * string * System.Collections.Generic.IList&lt;Microsoft.Azure.Management.Media.Models.LiveEventEndpoint&gt; -&gt; Microsoft.Azure.Management.Media.Models.LiveEventInput" Usage="new Microsoft.Azure.Management.Media.Models.LiveEventInput (streamingProtocol, accessControl, keyFrameIntervalDuration, accessToken, endpoints)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="streamingProtocol" Type="Microsoft.Azure.Management.Media.Models.LiveEventInputProtocol" />
        <Parameter Name="accessControl" Type="Microsoft.Azure.Management.Media.Models.LiveEventInputAccessControl" />
        <Parameter Name="keyFrameIntervalDuration" Type="System.String" />
        <Parameter Name="accessToken" Type="System.String" />
        <Parameter Name="endpoints" Type="System.Collections.Generic.IList&lt;Microsoft.Azure.Management.Media.Models.LiveEventEndpoint&gt;" />
      </Parameters>
      <Docs>
        <param name="streamingProtocol">The input protocol for the live
            event. This is specified at creation time and cannot be updated.
            Possible values include: 'FragmentedMP4', 'RTMP'</param>
        <param name="accessControl">Access control for live event
            input.</param>
        <param name="keyFrameIntervalDuration">ISO 8601 time duration of
            the key frame interval duration of the input. This value sets the
            EXT-X-TARGETDURATION property in the HLS output. For example, use
            PT2S to indicate 2 seconds. Leave the value empty for encoding live
            events.</param>
        <param name="accessToken">A UUID in string form to uniquely
            identify the stream. This can be specified at creation time but
            cannot be updated. If omitted, the service will generate a unique
            value.</param>
        <param name="endpoints">The input endpoints for the live
            event.</param>
        <summary>
            Initializes a new instance of the LiveEventInput class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AccessControl">
      <MemberSignature Language="C#" Value="public Microsoft.Azure.Management.Media.Models.LiveEventInputAccessControl AccessControl { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Management.Media.Models.LiveEventInputAccessControl AccessControl" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Media.Models.LiveEventInput.AccessControl" />
      <MemberSignature Language="VB.NET" Value="Public Property AccessControl As LiveEventInputAccessControl" />
      <MemberSignature Language="F#" Value="member this.AccessControl : Microsoft.Azure.Management.Media.Models.LiveEventInputAccessControl with get, set" Usage="Microsoft.Azure.Management.Media.Models.LiveEventInput.AccessControl" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="accessControl")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="accessControl")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Management.Media.Models.LiveEventInputAccessControl</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets access control for live event input.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AccessToken">
      <MemberSignature Language="C#" Value="public string AccessToken { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string AccessToken" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Media.Models.LiveEventInput.AccessToken" />
      <MemberSignature Language="VB.NET" Value="Public Property AccessToken As String" />
      <MemberSignature Language="F#" Value="member this.AccessToken : string with get, set" Usage="Microsoft.Azure.Management.Media.Models.LiveEventInput.AccessToken" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="accessToken")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="accessToken")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets a UUID in string form to uniquely identify the stream.
            This can be specified at creation time but cannot be updated. If
            omitted, the service will generate a unique value.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Endpoints">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;Microsoft.Azure.Management.Media.Models.LiveEventEndpoint&gt; Endpoints { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;class Microsoft.Azure.Management.Media.Models.LiveEventEndpoint&gt; Endpoints" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Media.Models.LiveEventInput.Endpoints" />
      <MemberSignature Language="VB.NET" Value="Public Property Endpoints As IList(Of LiveEventEndpoint)" />
      <MemberSignature Language="F#" Value="member this.Endpoints : System.Collections.Generic.IList&lt;Microsoft.Azure.Management.Media.Models.LiveEventEndpoint&gt; with get, set" Usage="Microsoft.Azure.Management.Media.Models.LiveEventInput.Endpoints" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="endpoints")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="endpoints")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;Microsoft.Azure.Management.Media.Models.LiveEventEndpoint&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the input endpoints for the live event.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="KeyFrameIntervalDuration">
      <MemberSignature Language="C#" Value="public string KeyFrameIntervalDuration { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string KeyFrameIntervalDuration" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Media.Models.LiveEventInput.KeyFrameIntervalDuration" />
      <MemberSignature Language="VB.NET" Value="Public Property KeyFrameIntervalDuration As String" />
      <MemberSignature Language="F#" Value="member this.KeyFrameIntervalDuration : string with get, set" Usage="Microsoft.Azure.Management.Media.Models.LiveEventInput.KeyFrameIntervalDuration" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="keyFrameIntervalDuration")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="keyFrameIntervalDuration")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets ISO 8601 time duration of the key frame interval
            duration of the input. This value sets the EXT-X-TARGETDURATION
            property in the HLS output. For example, use PT2S to indicate 2
            seconds. Leave the value empty for encoding live events.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="StreamingProtocol">
      <MemberSignature Language="C#" Value="public Microsoft.Azure.Management.Media.Models.LiveEventInputProtocol StreamingProtocol { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Management.Media.Models.LiveEventInputProtocol StreamingProtocol" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Media.Models.LiveEventInput.StreamingProtocol" />
      <MemberSignature Language="VB.NET" Value="Public Property StreamingProtocol As LiveEventInputProtocol" />
      <MemberSignature Language="F#" Value="member this.StreamingProtocol : Microsoft.Azure.Management.Media.Models.LiveEventInputProtocol with get, set" Usage="Microsoft.Azure.Management.Media.Models.LiveEventInput.StreamingProtocol" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="streamingProtocol")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="streamingProtocol")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Management.Media.Models.LiveEventInputProtocol</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the input protocol for the live event. This is
            specified at creation time and cannot be updated. Possible values
            include: 'FragmentedMP4', 'RTMP'
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Validate">
      <MemberSignature Language="C#" Value="public virtual void Validate ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Media.Models.LiveEventInput.Validate" />
      <MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
      <MemberSignature Language="F#" Value="abstract member Validate : unit -&gt; unit&#xA;override this.Validate : unit -&gt; unit" Usage="liveEventInput.Validate " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Management.Media</AssemblyName>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Validate the object.
            </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:Microsoft.Rest.ValidationException">
            Thrown if validation fails
            </exception>
      </Docs>
    </Member>
  </Members>
</Type>