Release 4.0.0-preview1-00201
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / 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 the 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 processed by the codec.\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 the video and the audio data.\r
42             </summary>\r
43         </member>\r
44         <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.#ctor">\r
45             <summary>\r
46             Initializes 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 has already 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 an 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"><paramref name="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         <!-- "M:Tizen.Multimedia.MediaCodec.MediaCodec.ProcessInput(Tizen.Multimedia.MediaPacket)" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
98         <member name="M:Tizen.Multimedia.MediaCodec.MediaCodec.FlushBuffers">\r
99             <summary>\r
100             Flushes both input and output buffers.\r
101             </summary>\r
102         </member>\r
103         <!-- "M:Tizen.Multimedia.MediaCodec.MediaCodec.GetCodecType(System.Boolean,Tizen.Multimedia.MediaFormatVideoMimeType)" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
104         <!-- "M:Tizen.Multimedia.MediaCodec.MediaCodec.GetCodecType(System.Boolean,Tizen.Multimedia.MediaFormatAudioMimeType)" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
105         <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.OutputAvailable">\r
106             <summary>\r
107             Occurs when an output buffer is available.\r
108             </summary>\r
109             <remarks>The output packet needs to be disposed after it is used to clean up unmanaged resources.</remarks>\r
110         </member>\r
111         <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.InputProcessed">\r
112             <summary>\r
113             Occurs when an input packet is processed.\r
114             </summary>\r
115             <see cref="M:Tizen.Multimedia.MediaCodec.MediaCodec.ProcessInput(Tizen.Multimedia.MediaPacket)"/>\r
116         </member>\r
117         <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.ErrorOccurred">\r
118             <summary>\r
119             Occurs whenever an error is produced in the codec.\r
120             </summary>\r
121         </member>\r
122         <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.EosReached">\r
123             <summary>\r
124             Occurs when the codec processes all input data.\r
125             </summary>\r
126         </member>\r
127         <member name="E:Tizen.Multimedia.MediaCodec.MediaCodec.BufferStatusChanged">\r
128             <summary>\r
129             Occurs when the codec needs more data or has enough data.\r
130             </summary>\r
131         </member>\r
132         <member name="T:Tizen.Multimedia.MediaCodec.MediaCodecErrorOccurredEventArgs">\r
133             <summary>\r
134             Provides data for the <see cref="E:Tizen.Multimedia.MediaCodec.MediaCodec.ErrorOccurred"/> event.\r
135             </summary>\r
136         </member>\r
137         <member name="M:Tizen.Multimedia.MediaCodec.MediaCodecErrorOccurredEventArgs.#ctor(Tizen.Multimedia.MediaCodec.MediaCodecError)">\r
138             <summary>\r
139             Initializes a new instance of the ErrorOccurredEventArgs class.\r
140             </summary>\r
141             <param name="error">The value representing the type of the error.</param>\r
142         </member>\r
143         <member name="P:Tizen.Multimedia.MediaCodec.MediaCodecErrorOccurredEventArgs.Error">\r
144             <summary>\r
145             Gets the value indicating what kind of the error.\r
146             </summary>\r
147         </member>\r
148         <member name="T:Tizen.Multimedia.MediaCodec.MediaCodecStatus">\r
149             <summary>\r
150             Specifies the status of a codec.\r
151             </summary>\r
152         </member>\r
153         <member name="F:Tizen.Multimedia.MediaCodec.MediaCodecStatus.LackOfData">\r
154             <summary>\r
155             Not enough data to decode or encode.\r
156             </summary>\r
157         </member>\r
158         <member name="F:Tizen.Multimedia.MediaCodec.MediaCodecStatus.EnoughData">\r
159             <summary>\r
160             Enough data to decode or encode.\r
161             </summary>\r
162         </member>\r
163         <member name="T:Tizen.Multimedia.MediaCodec.MediaCodecTypes">\r
164             <summary>\r
165             Specifies types of codec.\r
166             <para>\r
167             This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a bitwise combination of its member values.\r
168             </para>\r
169             </summary>\r
170         </member>\r
171         <member name="F:Tizen.Multimedia.MediaCodec.MediaCodecTypes.Hardware">\r
172             <summary>\r
173             The hardware-accelerated codec.\r
174             </summary>\r
175         </member>\r
176         <member name="F:Tizen.Multimedia.MediaCodec.MediaCodecTypes.Software">\r
177             <summary>\r
178             The software codec.\r
179             </summary>\r
180         </member>\r
181         <member name="T:Tizen.Multimedia.MediaCodec.OutputAvailableEventArgs">\r
182             <summary>\r
183             Provides data for the <see cref="E:Tizen.Multimedia.MediaCodec.MediaCodec.OutputAvailable"/> event.\r
184             </summary>\r
185             <remarks>The output packet needs to be disposed after it is used to clean up unmanaged resources.</remarks>\r
186         </member>\r
187         <member name="P:Tizen.Multimedia.MediaCodec.OutputAvailableEventArgs.Packet">\r
188             <summary>\r
189             Gets the result packet.\r
190             </summary>\r
191         </member>\r
192     </members>\r
193 </doc>\r