Artifacts/bin/Tizen.Multimedia.MediaCodec.xml

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