Artifacts/bin/Tizen.Multimedia.MediaCodec.xml

   1 <?xml version="1.0"?>
   2 <doc>
   3     <assembly>
   4         <name>Tizen.Multimedia.MediaCodec</name>
   5     </assembly>
   6     <members>
   7         <member name="T:Tizen.Multimedia.MediaCodec.BufferStatusChangedEventArgs">
   8             <summary>
   9             Provides data for the <see cref="E:Tizen.Multimedia.MediaCodec.MediaCodec.BufferStatusChanged"/> event.
  10             </summary>
  11         </member>
  12         <member name="M:Tizen.Multimedia.MediaCodec.BufferStatusChangedEventArgs.#ctor(Tizen.Multimedia.MediaCodec.MediaCodecStatus)">
  13             <summary>
  14             Initializes a new instance of the BufferStatusChangedEventArgs class.
  15             </summary>
  16             <param name="status">The value representing new status of the codec.</param>
  17         </member>
  18         <member name="P:Tizen.Multimedia.MediaCodec.BufferStatusChangedEventArgs.Status">
  19             <summary>
  20             Gets the value indicating new status of the codec.
  21             </summary>
  22         </member>
  23         <member name="T:Tizen.Multimedia.MediaCodec.InputProcessedEventArgs">
  24             <summary>
  25             Provides data for the <see cref="E:Tizen.Multimedia.MediaCodec.MediaCodec.InputProcessed"/> event.
  26             </summary>
  27         </member>
  28         <member name="M:Tizen.Multimedia.MediaCodec.InputProcessedEventArgs.#ctor(Tizen.Multimedia.MediaPacket)">
  29             <summary>
  30             Initializes a new instance of the InputProcessedEventArgs class.
  31             </summary>
  32             <param name="packet">The packet that the codec has processed.</param>
  33         </member>
  34         <member name="P:Tizen.Multimedia.MediaCodec.InputProcessedEventArgs.Packet">
  35             <summary>
  36             Gets the packet that the codec has processed.
  37             </summary>
  38         </member>
  39         <member name="T:Tizen.Multimedia.MediaCodec.MediaCodec">
  40             <summary>
  41             Provides the means to encode and decode video and audio data.
  42             </summary>
  43         </member>
  44         <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.#ctor">
  45             <summary>
  46             Initialize a new instance of the MediaCodec class.
  47             </summary>
  48         </member>
  49         <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.ValidateNotDisposed">
  50             <summary>
  51             Validates if the object already has been disposed of.
  52             </summary>
  53             <exception cref="T:System.ObjectDisposedException">The current object has been disposed of.</exception>
  54         </member>
  55         <member name="P:Tizen.Multimedia.MediaCodec.MediaCodec.SupportedVideoCodecs">
  56             <summary>
  57             Gets the audio codec list that the current device supports.
  58             </summary>
  59         </member>
  60         <member name="P:Tizen.Multimedia.MediaCodec.MediaCodec.SupportedAudioCodecs">
  61             <summary>
  62             Gets the audio codec list that the current device supports.
  63             </summary>
  64         </member>
  65         <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.Prepare">
  66             <summary>
  67             Prepares the MediaCodec for encoding or decoding.
  68             </summary>
  69             <exception cref="T:System.InvalidOperationException">
  70                 The codec is not configured, yet.\n
  71                 -or-\n
  72                 Internal error.
  73             </exception>
  74         </member>
  75         <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.Unprepare">
  76             <summary>
  77             Unprepares the MediaCodec.
  78             </summary>
  79         </member>
  80         <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.Configure(Tizen.Multimedia.MediaFormat,System.Boolean,Tizen.Multimedia.MediaCodec.MediaCodecTypes)">
  81             <summary>
  82             Configures the MediaCodec.
  83             </summary>
  84             <param name="format">The <see cref="T:Tizen.Multimedia.MediaFormat"/> for properties of media data to decode or encode.</param>
  85             <param name="encoder">The value indicating whether the codec works as a encoder or a decoder.</param>
  86             <param name="codecType">The value indicating whether the codec uses hardware acceleration.</param>
  87             <exception cref="T:System.ArgumentNullException">format is null</exception>
  88             <exception cref="T:System.ArgumentException">
  89                 <paramref name="codecType"/> is invalid.\n
  90                 -or-\n
  91                 <paramref name="format"/> is neither audio type nor video type.
  92                 </exception>
  93             <exception cref="T:System.NotSupportedException">the mime type of the format is not supported.</exception>
  94             <see cref="P:Tizen.Multimedia.MediaCodec.MediaCodec.SupportedAudioCodecs"/>
  95             <see cref="P:Tizen.Multimedia.MediaCodec.MediaCodec.SupportedVideoCodecs"/>
  96         </member>
  97         <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.ProcessInput(Tizen.Multimedia.MediaPacket)">
  98             <summary>
  99             Adds the packet to the internal queue of the codec.
 100             </summary>
 101             <param name="packet">The packet to be encoded or decoded.</param>
 102             <exception cref="T:System.ArgumentNullException">packet is null.</exception>
 103             <exception cref="T:System.InvalidOperationException">the current codec is not prepared, yet.</exception>
 104             <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>
 105         </member>
 106         <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.FlushBuffers">
 107             <summary>
 108             Flushes both input and output buffers.
 109             </summary>
 110         </member>
 111         <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.GetCodecType(System.Boolean,Tizen.Multimedia.MediaFormatVideoMimeType)">
 112             <summary>
 113             Retrieves supported codec types for the specified params.
 114             </summary>
 115             <param name="encoder">The value indicating encoder or decoder.</param>
 116             <param name="type">The mime type to query.</param>
 117             <returns>The values indicating which codec types are supported on the current device.</returns>
 118             <exception cref="T:System.ArgumentException">type is invalid.</exception>
 119         </member>
 120         <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.GetCodecType(System.Boolean,Tizen.Multimedia.MediaFormatAudioMimeType)">
 121             <summary>
 122             Retrieves supported codec types for the specified params.
 123             </summary>
 124             <param name="encoder">The value indicating encoder or decoder.</param>
 125             <param name="type">The mime type to query.</param>
 126             <returns>The values indicating which codec types are supported on the current device.</returns>
 127             <exception cref="T:System.ArgumentException">type is invalid.</exception>
 128         </member>
 129         <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.OutputAvailable">
 130             <summary>
 131             Occurs when an output buffer is available.
 132             </summary>
 133             <remarks>The output packet needs to be disposed after it is used to clean up unmanaged resources.</remarks>
 134         </member>
 135         <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.InputProcessed">
 136             <summary>
 137             Occurs when an input packet is processed.
 138             </summary>
 139             <see cref="M:Tizen.Multimedia.MediaCodec.MediaCodec.ProcessInput(Tizen.Multimedia.MediaPacket)"/>
 140         </member>
 141         <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.ErrorOccurred">
 142             <summary>
 143             Occurs whenever an error is produced in the codec.
 144             </summary>
 145         </member>
 146         <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.EosReached">
 147             <summary>
 148             Occurs when the codec processes all input data.
 149             </summary>
 150         </member>
 151         <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.BufferStatusChanged">
 152             <summary>
 153             Occurs when the codec needs more data or has enough data.
 154             </summary>
 155         </member>
 156         <member name="T:Tizen.Multimedia.MediaCodec.MediaCodecErrorOccurredEventArgs">
 157             <summary>
 158             Provides data for the <see cref="E:Tizen.Multimedia.MediaCodec.MediaCodec.ErrorOccurred"/> event.
 159             </summary>
 160         </member>
 161         <member name="M:Tizen.Multimedia.MediaCodec.MediaCodecErrorOccurredEventArgs.#ctor(Tizen.Multimedia.MediaCodec.MediaCodecError)">
 162             <summary>
 163             Initializes a new instance of the ErrorOccurredEventArgs class.
 164             </summary>
 165             <param name="error">The value representing the type of the error.</param>
 166         </member>
 167         <member name="P:Tizen.Multimedia.MediaCodec.MediaCodecErrorOccurredEventArgs.Error">
 168             <summary>
 169             Gets the value indicating what kind of the error.
 170             </summary>
 171         </member>
 172         <member name="T:Tizen.Multimedia.MediaCodec.MediaCodecStatus">
 173             <summary>
 174             Specifies the status of a codec.
 175             </summary>
 176         </member>
 177         <member name="F:Tizen.Multimedia.MediaCodec.MediaCodecStatus.LackOfData">
 178             <summary>
 179             Not enough data to decode or encode.
 180             </summary>
 181         </member>
 182         <member name="F:Tizen.Multimedia.MediaCodec.MediaCodecStatus.EnoughData">
 183             <summary>
 184             Enough data to decode or encode.
 185             </summary>
 186         </member>
 187         <member name="T:Tizen.Multimedia.MediaCodec.MediaCodecTypes">
 188             <summary>
 189             Specifies types of codec.
 190             <para>
 191             This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a bitwise combination of its member values.
 192             </para>
 193             </summary>
 194         </member>
 195         <member name="F:Tizen.Multimedia.MediaCodec.MediaCodecTypes.Hardware">
 196             <summary>
 197             The hardware-accelerated codec.
 198             </summary>
 199         </member>
 200         <member name="F:Tizen.Multimedia.MediaCodec.MediaCodecTypes.Software">
 201             <summary>
 202             The software codec.
 203             </summary>
 204         </member>
 205         <member name="T:Tizen.Multimedia.MediaCodec.OutputAvailableEventArgs">
 206             <summary>
 207             Provides data for the <see cref="E:Tizen.Multimedia.MediaCodec.MediaCodec.OutputAvailable"/> event.
 208             </summary>
 209             <remarks>The output packet needs to be disposed after it is used to clean up unmanaged resources.</remarks>
 210         </member>
 211         <member name="P:Tizen.Multimedia.MediaCodec.OutputAvailableEventArgs.Packet">
 212             <summary>
 213             Gets the result packet.
 214             </summary>
 215         </member>
 216     </members>
 217 </doc>