VTMultiPassStorage.xml

<Type Name="VTMultiPassStorage" FullName="VideoToolbox.VTMultiPassStorage">
  <TypeSignature Language="C#" Value="public class VTMultiPassStorage : IDisposable, ObjCRuntime.INativeObject" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit VTMultiPassStorage extends System.Object implements class ObjCRuntime.INativeObject, class System.IDisposable" />
  <TypeSignature Language="DocId" Value="T:VideoToolbox.VTMultiPassStorage" />
  <TypeSignature Language="F#" Value="type VTMultiPassStorage = class&#xA;    interface INativeObject&#xA;    interface IDisposable" />
  <AssemblyInfo>
    <AssemblyName>Xamarin.iOS</AssemblyName>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <AssemblyInfo>
    <AssemblyName>Xamarin.Mac</AssemblyName>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>ObjCRuntime.INativeObject</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes>
    <Attribute>
      <AttributeName>ObjCRuntime.TV(10, 2)</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Class that provides a storage for encoding metadata.</summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected internal VTMultiPassStorage (IntPtr handle);" />
      <MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
      <MemberSignature Language="DocId" Value="M:VideoToolbox.VTMultiPassStorage.#ctor(System.IntPtr)" />
      <MemberSignature Language="F#" Value="new VideoToolbox.VTMultiPassStorage : nativeint -&gt; VideoToolbox.VTMultiPassStorage" Usage="new VideoToolbox.VTMultiPassStorage handle" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <AssemblyInfo>
        <AssemblyName>Xamarin.Mac</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="handle" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <param name="handle">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Close">
      <MemberSignature Language="C#" Value="public VideoToolbox.VTStatus Close ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype VideoToolbox.VTStatus Close() cil managed" />
      <MemberSignature Language="DocId" Value="M:VideoToolbox.VTMultiPassStorage.Close" />
      <MemberSignature Language="F#" Value="member this.Close : unit -&gt; VideoToolbox.VTStatus" Usage="vTMultiPassStorage.Close " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <AssemblyInfo>
        <AssemblyName>Xamarin.Mac</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>VideoToolbox.VTStatus</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Create">
      <MemberSignature Language="C#" Value="public static VideoToolbox.VTMultiPassStorage Create (Foundation.NSUrl fileUrl = null, Nullable&lt;CoreMedia.CMTimeRange&gt; timeRange = null, Foundation.NSDictionary options = null);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class VideoToolbox.VTMultiPassStorage Create(class Foundation.NSUrl fileUrl, valuetype System.Nullable`1&lt;valuetype CoreMedia.CMTimeRange&gt; timeRange, class Foundation.NSDictionary options) cil managed" />
      <MemberSignature Language="DocId" Value="M:VideoToolbox.VTMultiPassStorage.Create(Foundation.NSUrl,System.Nullable{CoreMedia.CMTimeRange},Foundation.NSDictionary)" />
      <MemberSignature Language="F#" Value="static member Create : Foundation.NSUrl * Nullable&lt;CoreMedia.CMTimeRange&gt; * Foundation.NSDictionary -&gt; VideoToolbox.VTMultiPassStorage" Usage="VideoToolbox.VTMultiPassStorage.Create (fileUrl, timeRange, options)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <AssemblyInfo>
        <AssemblyName>Xamarin.Mac</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>VideoToolbox.VTMultiPassStorage</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="fileUrl" Type="Foundation.NSUrl" />
        <Parameter Name="timeRange" Type="System.Nullable&lt;CoreMedia.CMTimeRange&gt;" />
        <Parameter Name="options" Type="Foundation.NSDictionary" />
      </Parameters>
      <Docs>
        <param name="fileUrl">To be added.</param>
        <param name="timeRange">To be added.</param>
        <param name="options">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Create">
      <MemberSignature Language="C#" Value="public static VideoToolbox.VTMultiPassStorage Create (VideoToolbox.VTMultiPassStorageCreationOptions options, Foundation.NSUrl fileUrl = null, Nullable&lt;CoreMedia.CMTimeRange&gt; timeRange = null);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class VideoToolbox.VTMultiPassStorage Create(class VideoToolbox.VTMultiPassStorageCreationOptions options, class Foundation.NSUrl fileUrl, valuetype System.Nullable`1&lt;valuetype CoreMedia.CMTimeRange&gt; timeRange) cil managed" />
      <MemberSignature Language="DocId" Value="M:VideoToolbox.VTMultiPassStorage.Create(VideoToolbox.VTMultiPassStorageCreationOptions,Foundation.NSUrl,System.Nullable{CoreMedia.CMTimeRange})" />
      <MemberSignature Language="F#" Value="static member Create : VideoToolbox.VTMultiPassStorageCreationOptions * Foundation.NSUrl * Nullable&lt;CoreMedia.CMTimeRange&gt; -&gt; VideoToolbox.VTMultiPassStorage" Usage="VideoToolbox.VTMultiPassStorage.Create (options, fileUrl, timeRange)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <AssemblyInfo>
        <AssemblyName>Xamarin.Mac</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>VideoToolbox.VTMultiPassStorage</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="options" Type="VideoToolbox.VTMultiPassStorageCreationOptions" />
        <Parameter Name="fileUrl" Type="Foundation.NSUrl" />
        <Parameter Name="timeRange" Type="System.Nullable&lt;CoreMedia.CMTimeRange&gt;" />
      </Parameters>
      <Docs>
        <param name="options">To be added.</param>
        <param name="fileUrl">To be added.</param>
        <param name="timeRange">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="public void Dispose ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
      <MemberSignature Language="DocId" Value="M:VideoToolbox.VTMultiPassStorage.Dispose" />
      <MemberSignature Language="F#" Value="abstract member Dispose : unit -&gt; unit&#xA;override this.Dispose : unit -&gt; unit" Usage="vTMultiPassStorage.Dispose " />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <AssemblyInfo>
        <AssemblyName>Xamarin.Mac</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Releases the resources used by the VTMultiPassStorage object.</summary>
        <remarks>
          <para>The Dispose method releases the resources used by the VTMultiPassStorage class.</para>
          <para>Calling the Dispose method when the application is finished using the VTMultiPassStorage ensures that all external resources used by this managed object are released as soon as possible.  Once developers have invoked the Dispose method, the object is no longer useful and developers should no longer make any calls to it.  For more information on releasing resources see ``Cleaning up Unmananaged Resources'' at https://msdn.microsoft.com/en-us/library/498928w2.aspx</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Dispose">
      <MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
      <MemberSignature Language="DocId" Value="M:VideoToolbox.VTMultiPassStorage.Dispose(System.Boolean)" />
      <MemberSignature Language="F#" Value="abstract member Dispose : bool -&gt; unit&#xA;override this.Dispose : bool -&gt; unit" Usage="vTMultiPassStorage.Dispose disposing" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <AssemblyInfo>
        <AssemblyName>Xamarin.Mac</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="disposing" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="disposing">
          <para>If set to <see langword="true" />, the method is invoked directly and will dispose manage and unmanaged resources;   If set to <see langword="false" /> the method is being called by the garbage collector finalizer and should only release unmanaged resources.</para>
        </param>
        <summary>Releases the resources used by the VTMultiPassStorage object.</summary>
        <remarks>
          <para>This Dispose method releases the resources used by the VTMultiPassStorage class.</para>
          <para>This method is called by both the Dispose() method and the object finalizer (Finalize).    When invoked by the Dispose method, the parameter disposing <paramref name="disposing" /> is set to <see langword="true" /> and any managed object references that this object holds are also disposed or released;  when invoked by the object finalizer, on the finalizer thread the value is set to <see langword="false" />. </para>
          <para>Calling the Dispose method when the application is finished using the VTMultiPassStorage ensures that all external resources used by this managed object are released as soon as possible.  Once developers have invoked the Dispose method, the object is no longer useful and developers should no longer make any calls to it.</para>
          <para>  For more information on how to override this method and on the Dispose/IDisposable pattern, read the ``Implementing a Dispose Method'' document at https://msdn.microsoft.com/en-us/library/fs2xkftw.aspx</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Finalize">
      <MemberSignature Language="C#" Value="~VTMultiPassStorage ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Finalize() cil managed" />
      <MemberSignature Language="DocId" Value="M:VideoToolbox.VTMultiPassStorage.Finalize" />
      <MemberSignature Language="F#" Value="override this.Finalize : unit -&gt; unit" Usage="vTMultiPassStorage.Finalize " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <AssemblyInfo>
        <AssemblyName>Xamarin.Mac</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Finalizer for the VTMultiPassStorage object</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Handle">
      <MemberSignature Language="C#" Value="public IntPtr Handle { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance native int Handle" />
      <MemberSignature Language="DocId" Value="P:VideoToolbox.VTMultiPassStorage.Handle" />
      <MemberSignature Language="F#" Value="member this.Handle : nativeint" Usage="VideoToolbox.VTMultiPassStorage.Handle" />
      <MemberType>Property</MemberType>
      <Implements>
        <InterfaceMember>P:ObjCRuntime.INativeObject.Handle</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
        <AssemblyName>Xamarin.iOS</AssemblyName>
      </AssemblyInfo>
      <AssemblyInfo>
        <AssemblyName>Xamarin.Mac</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.IntPtr</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Handle (pointer) to the unmanaged object representation.</summary>
        <value>A pointer</value>
        <remarks>This IntPtr is a handle to the underlying unmanaged representation for this object.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>