Release 4.0.0-preview1-00201
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.Multimedia.MediaCodec.xml
index 31712c4..43b1319 100644 (file)
-<?xml version="1.0"?>
-<doc>
-    <assembly>
-        <name>Tizen.Multimedia.MediaCodec</name>
-    </assembly>
-    <members>
-        <member name="T:Tizen.Multimedia.MediaCodec.BufferStatusChangedEventArgs">
-            <summary>
-            Provides data for the <see cref="E:Tizen.Multimedia.MediaCodec.MediaCodec.BufferStatusChanged"/> event.
-            </summary>
-        </member>
-        <member name="M:Tizen.Multimedia.MediaCodec.BufferStatusChangedEventArgs.#ctor(Tizen.Multimedia.MediaCodec.MediaCodecStatus)">
-            <summary>
-            Initializes a new instance of the BufferStatusChangedEventArgs class.
-            </summary>
-            <param name="status">The value representing new status of the codec.</param>
-        </member>
-        <member name="P:Tizen.Multimedia.MediaCodec.BufferStatusChangedEventArgs.Status">
-            <summary>
-            Gets the value indicating new status of the codec.
-            </summary>
-        </member>
-        <member name="T:Tizen.Multimedia.MediaCodec.InputProcessedEventArgs">
-            <summary>
-            Provides data for the <see cref="E:Tizen.Multimedia.MediaCodec.MediaCodec.InputProcessed"/> event.
-            </summary>
-        </member>
-        <member name="M:Tizen.Multimedia.MediaCodec.InputProcessedEventArgs.#ctor(Tizen.Multimedia.MediaPacket)">
-            <summary>
-            Initializes a new instance of the InputProcessedEventArgs class.
-            </summary>
-            <param name="packet">The packet that the codec has processed.</param>
-        </member>
-        <member name="P:Tizen.Multimedia.MediaCodec.InputProcessedEventArgs.Packet">
-            <summary>
-            Gets the packet that the codec has processed.
-            </summary>
-        </member>
-        <member name="T:Tizen.Multimedia.MediaCodec.MediaCodec">
-            <summary>
-            Provides the means to encode and decode video and audio data.
-            </summary>
-        </member>
-        <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.#ctor">
-            <summary>
-            Initialize a new instance of the MediaCodec class.
-            </summary>
-        </member>
-        <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.ValidateNotDisposed">
-            <summary>
-            Validates if the object already has been disposed of.
-            </summary>
-            <exception cref="T:System.ObjectDisposedException">The current object has been disposed of.</exception>
-        </member>
-        <member name="P:Tizen.Multimedia.MediaCodec.MediaCodec.SupportedVideoCodecs">
-            <summary>
-            Gets the audio codec list that the current device supports.
-            </summary>
-        </member>
-        <member name="P:Tizen.Multimedia.MediaCodec.MediaCodec.SupportedAudioCodecs">
-            <summary>
-            Gets the audio codec list that the current device supports.
-            </summary>
-        </member>
-        <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.Prepare">
-            <summary>
-            Prepares the MediaCodec for encoding or decoding.
-            </summary>
-            <exception cref="T:System.InvalidOperationException">
-                The codec is not configured, yet.\n
-                -or-\n
-                Internal error.
-            </exception>
-        </member>
-        <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.Unprepare">
-            <summary>
-            Unprepares the MediaCodec.
-            </summary>
-        </member>
-        <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.Configure(Tizen.Multimedia.MediaFormat,System.Boolean,Tizen.Multimedia.MediaCodec.MediaCodecTypes)">
-            <summary>
-            Configures the MediaCodec.
-            </summary>
-            <param name="format">The <see cref="T:Tizen.Multimedia.MediaFormat"/> for properties of media data to decode or encode.</param>
-            <param name="encoder">The value indicating whether the codec works as a encoder or a decoder.</param>
-            <param name="codecType">The value indicating whether the codec uses hardware acceleration.</param>
-            <exception cref="T:System.ArgumentNullException">format is null</exception>
-            <exception cref="T:System.ArgumentException">
-                <paramref name="codecType"/> is invalid.\n
-                -or-\n
-                <paramref name="format"/> is neither audio type nor video type.
-                </exception>
-            <exception cref="T:System.NotSupportedException">the mime type of the format is not supported.</exception>
-            <see cref="P:Tizen.Multimedia.MediaCodec.MediaCodec.SupportedAudioCodecs"/>
-            <see cref="P:Tizen.Multimedia.MediaCodec.MediaCodec.SupportedVideoCodecs"/>
-        </member>
-        <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.ProcessInput(Tizen.Multimedia.MediaPacket)">
-            <summary>
-            Adds the packet to the internal queue of the codec.
-            </summary>
-            <param name="packet">The packet to be encoded or decoded.</param>
-            <exception cref="T:System.ArgumentNullException">packet is null.</exception>
-            <exception cref="T:System.InvalidOperationException">the current codec is not prepared, yet.</exception>
-            <remarks>Any attempts to modify the packet will be failed until the <see cref="E:Tizen.Multimedia.MediaCodec.MediaCodec.InputProcessed"/> event for the packet is invoked.</remarks>
-        </member>
-        <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.FlushBuffers">
-            <summary>
-            Flushes both input and output buffers.
-            </summary>
-        </member>
-        <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.GetCodecType(System.Boolean,Tizen.Multimedia.MediaFormatVideoMimeType)">
-            <summary>
-            Retrieves supported codec types for the specified params.
-            </summary>
-            <param name="encoder">The value indicating encoder or decoder.</param>
-            <param name="type">The mime type to query.</param>
-            <returns>The values indicating which codec types are supported on the current device.</returns>
-            <exception cref="T:System.ArgumentException">type is invalid.</exception>
-        </member>
-        <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.GetCodecType(System.Boolean,Tizen.Multimedia.MediaFormatAudioMimeType)">
-            <summary>
-            Retrieves supported codec types for the specified params.
-            </summary>
-            <param name="encoder">The value indicating encoder or decoder.</param>
-            <param name="type">The mime type to query.</param>
-            <returns>The values indicating which codec types are supported on the current device.</returns>
-            <exception cref="T:System.ArgumentException">type is invalid.</exception>
-        </member>
-        <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.OutputAvailable">
-            <summary>
-            Occurs when an output buffer is available.
-            </summary>
-            <remarks>The output packet needs to be disposed after it is used to clean up unmanaged resources.</remarks>
-        </member>
-        <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.InputProcessed">
-            <summary>
-            Occurs when an input packet is processed.
-            </summary>
-            <see cref="M:Tizen.Multimedia.MediaCodec.MediaCodec.ProcessInput(Tizen.Multimedia.MediaPacket)"/>
-        </member>
-        <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.ErrorOccurred">
-            <summary>
-            Occurs whenever an error is produced in the codec.
-            </summary>
-        </member>
-        <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.EosReached">
-            <summary>
-            Occurs when the codec processes all input data.
-            </summary>
-        </member>
-        <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.BufferStatusChanged">
-            <summary>
-            Occurs when the codec needs more data or has enough data.
-            </summary>
-        </member>
-        <member name="T:Tizen.Multimedia.MediaCodec.MediaCodecErrorOccurredEventArgs">
-            <summary>
-            Provides data for the <see cref="E:Tizen.Multimedia.MediaCodec.MediaCodec.ErrorOccurred"/> event.
-            </summary>
-        </member>
-        <member name="M:Tizen.Multimedia.MediaCodec.MediaCodecErrorOccurredEventArgs.#ctor(Tizen.Multimedia.MediaCodec.MediaCodecError)">
-            <summary>
-            Initializes a new instance of the ErrorOccurredEventArgs class.
-            </summary>
-            <param name="error">The value representing the type of the error.</param>
-        </member>
-        <member name="P:Tizen.Multimedia.MediaCodec.MediaCodecErrorOccurredEventArgs.Error">
-            <summary>
-            Gets the value indicating what kind of the error.
-            </summary>
-        </member>
-        <member name="T:Tizen.Multimedia.MediaCodec.MediaCodecStatus">
-            <summary>
-            Specifies the status of a codec.
-            </summary>
-        </member>
-        <member name="F:Tizen.Multimedia.MediaCodec.MediaCodecStatus.LackOfData">
-            <summary>
-            Not enough data to decode or encode.
-            </summary>
-        </member>
-        <member name="F:Tizen.Multimedia.MediaCodec.MediaCodecStatus.EnoughData">
-            <summary>
-            Enough data to decode or encode.
-            </summary>
-        </member>
-        <member name="T:Tizen.Multimedia.MediaCodec.MediaCodecTypes">
-            <summary>
-            Specifies types of codec.
-            <para>
-            This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a bitwise combination of its member values.
-            </para>
-            </summary>
-        </member>
-        <member name="F:Tizen.Multimedia.MediaCodec.MediaCodecTypes.Hardware">
-            <summary>
-            The hardware-accelerated codec.
-            </summary>
-        </member>
-        <member name="F:Tizen.Multimedia.MediaCodec.MediaCodecTypes.Software">
-            <summary>
-            The software codec.
-            </summary>
-        </member>
-        <member name="T:Tizen.Multimedia.MediaCodec.OutputAvailableEventArgs">
-            <summary>
-            Provides data for the <see cref="E:Tizen.Multimedia.MediaCodec.MediaCodec.OutputAvailable"/> event.
-            </summary>
-            <remarks>The output packet needs to be disposed after it is used to clean up unmanaged resources.</remarks>
-        </member>
-        <member name="P:Tizen.Multimedia.MediaCodec.OutputAvailableEventArgs.Packet">
-            <summary>
-            Gets the result packet.
-            </summary>
-        </member>
-    </members>
-</doc>
+<?xml version="1.0"?>\r
+<doc>\r
+    <assembly>\r
+        <name>Tizen.Multimedia.MediaCodec</name>\r
+    </assembly>\r
+    <members>\r
+        <member name="T:Tizen.Multimedia.MediaCodec.BufferStatusChangedEventArgs">\r
+            <summary>\r
+            Provides data for the <see cref="E:Tizen.Multimedia.MediaCodec.MediaCodec.BufferStatusChanged"/> event.\r
+            </summary>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.MediaCodec.BufferStatusChangedEventArgs.#ctor(Tizen.Multimedia.MediaCodec.MediaCodecStatus)">\r
+            <summary>\r
+            Initializes a new instance of the BufferStatusChangedEventArgs class.\r
+            </summary>\r
+            <param name="status">The value representing new status of the codec.</param>\r
+        </member>\r
+        <member name="P:Tizen.Multimedia.MediaCodec.BufferStatusChangedEventArgs.Status">\r
+            <summary>\r
+            Gets the value indicating the new status of the codec.\r
+            </summary>\r
+        </member>\r
+        <member name="T:Tizen.Multimedia.MediaCodec.InputProcessedEventArgs">\r
+            <summary>\r
+            Provides data for the <see cref="E:Tizen.Multimedia.MediaCodec.MediaCodec.InputProcessed"/> event.\r
+            </summary>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.MediaCodec.InputProcessedEventArgs.#ctor(Tizen.Multimedia.MediaPacket)">\r
+            <summary>\r
+            Initializes a new instance of the InputProcessedEventArgs class.\r
+            </summary>\r
+            <param name="packet">The packet that the codec has processed.</param>\r
+        </member>\r
+        <member name="P:Tizen.Multimedia.MediaCodec.InputProcessedEventArgs.Packet">\r
+            <summary>\r
+            Gets the packet processed by the codec.\r
+            </summary>\r
+        </member>\r
+        <member name="T:Tizen.Multimedia.MediaCodec.MediaCodec">\r
+            <summary>\r
+            Provides the means to encode and decode the video and the audio data.\r
+            </summary>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.#ctor">\r
+            <summary>\r
+            Initializes a new instance of the MediaCodec class.\r
+            </summary>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.ValidateNotDisposed">\r
+            <summary>\r
+            Validates if the object has already been disposed of.\r
+            </summary>\r
+            <exception cref="T:System.ObjectDisposedException">The current object has been disposed of.</exception>\r
+        </member>\r
+        <member name="P:Tizen.Multimedia.MediaCodec.MediaCodec.SupportedVideoCodecs">\r
+            <summary>\r
+            Gets the audio codec list that the current device supports.\r
+            </summary>\r
+        </member>\r
+        <member name="P:Tizen.Multimedia.MediaCodec.MediaCodec.SupportedAudioCodecs">\r
+            <summary>\r
+            Gets the audio codec list that the current device supports.\r
+            </summary>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.Prepare">\r
+            <summary>\r
+            Prepares the MediaCodec for encoding or decoding.\r
+            </summary>\r
+            <exception cref="T:System.InvalidOperationException">\r
+                The codec is not configured yet.\n\r
+                -or-\n\r
+                Internal error.\r
+            </exception>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.Unprepare">\r
+            <summary>\r
+            Unprepares the MediaCodec.\r
+            </summary>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.Configure(Tizen.Multimedia.MediaFormat,System.Boolean,Tizen.Multimedia.MediaCodec.MediaCodecTypes)">\r
+            <summary>\r
+            Configures the MediaCodec.\r
+            </summary>\r
+            <param name="format">The <see cref="T:Tizen.Multimedia.MediaFormat"/> for properties of media data to decode or encode.</param>\r
+            <param name="encoder">The value indicating whether the codec works as an encoder or a decoder.</param>\r
+            <param name="codecType">The value indicating whether the codec uses hardware acceleration.</param>\r
+            <exception cref="T:System.ArgumentNullException"><paramref name="format"/> is null.</exception>\r
+            <exception cref="T:System.ArgumentException">\r
+                <paramref name="codecType"/> is invalid.\n\r
+                -or-\n\r
+                <paramref name="format"/> is neither audio type nor video type.\r
+                </exception>\r
+            <exception cref="T:System.NotSupportedException">The mime type of the format is not supported.</exception>\r
+            <see cref="P:Tizen.Multimedia.MediaCodec.MediaCodec.SupportedAudioCodecs"/>\r
+            <see cref="P:Tizen.Multimedia.MediaCodec.MediaCodec.SupportedVideoCodecs"/>\r
+        </member>\r
+        <!-- "M:Tizen.Multimedia.MediaCodec.MediaCodec.ProcessInput(Tizen.Multimedia.MediaPacket)" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+        <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.FlushBuffers">\r
+            <summary>\r
+            Flushes both input and output buffers.\r
+            </summary>\r
+        </member>\r
+        <!-- "M:Tizen.Multimedia.MediaCodec.MediaCodec.GetCodecType(System.Boolean,Tizen.Multimedia.MediaFormatVideoMimeType)" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+        <!-- "M:Tizen.Multimedia.MediaCodec.MediaCodec.GetCodecType(System.Boolean,Tizen.Multimedia.MediaFormatAudioMimeType)" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+        <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.OutputAvailable">\r
+            <summary>\r
+            Occurs when an output buffer is available.\r
+            </summary>\r
+            <remarks>The output packet needs to be disposed after it is used to clean up unmanaged resources.</remarks>\r
+        </member>\r
+        <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.InputProcessed">\r
+            <summary>\r
+            Occurs when an input packet is processed.\r
+            </summary>\r
+            <see cref="M:Tizen.Multimedia.MediaCodec.MediaCodec.ProcessInput(Tizen.Multimedia.MediaPacket)"/>\r
+        </member>\r
+        <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.ErrorOccurred">\r
+            <summary>\r
+            Occurs whenever an error is produced in the codec.\r
+            </summary>\r
+        </member>\r
+        <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.EosReached">\r
+            <summary>\r
+            Occurs when the codec processes all input data.\r
+            </summary>\r
+        </member>\r
+        <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.BufferStatusChanged">\r
+            <summary>\r
+            Occurs when the codec needs more data or has enough data.\r
+            </summary>\r
+        </member>\r
+        <member name="T:Tizen.Multimedia.MediaCodec.MediaCodecErrorOccurredEventArgs">\r
+            <summary>\r
+            Provides data for the <see cref="E:Tizen.Multimedia.MediaCodec.MediaCodec.ErrorOccurred"/> event.\r
+            </summary>\r
+        </member>\r
+        <member name="M:Tizen.Multimedia.MediaCodec.MediaCodecErrorOccurredEventArgs.#ctor(Tizen.Multimedia.MediaCodec.MediaCodecError)">\r
+            <summary>\r
+            Initializes a new instance of the ErrorOccurredEventArgs class.\r
+            </summary>\r
+            <param name="error">The value representing the type of the error.</param>\r
+        </member>\r
+        <member name="P:Tizen.Multimedia.MediaCodec.MediaCodecErrorOccurredEventArgs.Error">\r
+            <summary>\r
+            Gets the value indicating what kind of the error.\r
+            </summary>\r
+        </member>\r
+        <member name="T:Tizen.Multimedia.MediaCodec.MediaCodecStatus">\r
+            <summary>\r
+            Specifies the status of a codec.\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Multimedia.MediaCodec.MediaCodecStatus.LackOfData">\r
+            <summary>\r
+            Not enough data to decode or encode.\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Multimedia.MediaCodec.MediaCodecStatus.EnoughData">\r
+            <summary>\r
+            Enough data to decode or encode.\r
+            </summary>\r
+        </member>\r
+        <member name="T:Tizen.Multimedia.MediaCodec.MediaCodecTypes">\r
+            <summary>\r
+            Specifies types of codec.\r
+            <para>\r
+            This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a bitwise combination of its member values.\r
+            </para>\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Multimedia.MediaCodec.MediaCodecTypes.Hardware">\r
+            <summary>\r
+            The hardware-accelerated codec.\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Multimedia.MediaCodec.MediaCodecTypes.Software">\r
+            <summary>\r
+            The software codec.\r
+            </summary>\r
+        </member>\r
+        <member name="T:Tizen.Multimedia.MediaCodec.OutputAvailableEventArgs">\r
+            <summary>\r
+            Provides data for the <see cref="E:Tizen.Multimedia.MediaCodec.MediaCodec.OutputAvailable"/> event.\r
+            </summary>\r
+            <remarks>The output packet needs to be disposed after it is used to clean up unmanaged resources.</remarks>\r
+        </member>\r
+        <member name="P:Tizen.Multimedia.MediaCodec.OutputAvailableEventArgs.Packet">\r
+            <summary>\r
+            Gets the result packet.\r
+            </summary>\r
+        </member>\r
+    </members>\r
+</doc>\r