• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# image_receiver_native.h
2<!--Kit: Image Kit-->
3<!--Subsystem: Multimedia-->
4<!--Owner: @aulight02-->
5<!--SE: @liyang_bryan-->
6<!--TSE: @xchaosioda-->
7
8## Overview
9
10The file declares the APIs used to obtain image data from the native layer.
11
12**Library**: libimage_receiver.so
13
14**System capability**: SystemCapability.Multimedia.Image.ImageReceiver
15
16**Since**: 12
17
18**Related module**: [Image_NativeModule](capi-image-nativemodule.md)
19
20## Summary
21
22### Structs
23
24| Name| typedef Keyword| Description|
25| -- | -- | -- |
26| [OH_ImageReceiverNative](capi-image-nativemodule-oh-imagereceivernative.md) | OH_ImageReceiverNative | Describes the image receiver, which is encapsulated at the native layer. The struct cannot be directly operated. Instead, functions must be called to create and release the struct and operate the fields in the struct.|
27| [OH_ImageReceiverOptions](capi-image-nativemodule-oh-imagereceiveroptions.md) | OH_ImageReceiverOptions | Describes the data type name of the image receiver options.|
28
29### Functions
30
31| Name| typedef Keyword| Description|
32| -- | -- | -- |
33| [typedef void (\*OH_ImageReceiver_OnCallback)(OH_ImageReceiverNative *receiver)](#oh_imagereceiver_oncallback) | OH_ImageReceiver_OnCallback | Defines the callbacks for the image receiver at the native layer.|
34| [typedef void (\*OH_ImageReceiver_ImageArriveCallback)(OH_ImageReceiverNative *receiver, void *userData)](#oh_imagereceiver_imagearrivecallback) | OH_ImageReceiver_ImageArriveCallback | Defines the callback for the ImageArrive event.|
35| [Image_ErrorCode OH_ImageReceiverOptions_Create(OH_ImageReceiverOptions **options)](#oh_imagereceiveroptions_create) | - | Creates an OH_ImageReceiverOptions object at the application layer.|
36| [Image_ErrorCode OH_ImageReceiverOptions_GetSize(OH_ImageReceiverOptions* options, Image_Size* size)](#oh_imagereceiveroptions_getsize) | - | Obtains the image size of an OH_ImageReceiverOptions object.|
37| [Image_ErrorCode OH_ImageReceiverOptions_SetSize(OH_ImageReceiverOptions* options, Image_Size size)](#oh_imagereceiveroptions_setsize) | - | Sets the image size for an OH_ImageReceiverOptions object.|
38| [Image_ErrorCode OH_ImageReceiverOptions_GetCapacity(OH_ImageReceiverOptions* options, int32_t* capacity)](#oh_imagereceiveroptions_getcapacity) | - | Obtains the capacity of an OH_ImageReceiverOptions object.|
39| [Image_ErrorCode OH_ImageReceiverOptions_SetCapacity(OH_ImageReceiverOptions* options, int32_t capacity)](#oh_imagereceiveroptions_setcapacity) | - | Sets the capacity for an OH_ImageReceiverOptions object.|
40| [Image_ErrorCode OH_ImageReceiverOptions_Release(OH_ImageReceiverOptions* options)](#oh_imagereceiveroptions_release) | - | Releases an OH_ImageReceiverOptions object.|
41| [Image_ErrorCode OH_ImageReceiverNative_Create(OH_ImageReceiverOptions* options, OH_ImageReceiverNative** receiver)](#oh_imagereceivernative_create) | - | Creates an OH_ImageReceiverNative object at the application layer.|
42| [Image_ErrorCode OH_ImageReceiverNative_GetReceivingSurfaceId(OH_ImageReceiverNative* receiver, uint64_t* surfaceId)](#oh_imagereceivernative_getreceivingsurfaceid) | - | Obtains the surface ID through an OH_ImageReceiverNative object. |
43| [Image_ErrorCode OH_ImageReceiverNative_ReadLatestImage(OH_ImageReceiverNative* receiver, OH_ImageNative** image)](#oh_imagereceivernative_readlatestimage) | - | Obtains the latest image through an OH_ImageReceiverNative object.<br>This function can be called to receive data only after the [OH_ImageReceiver_OnCallback](#oh_imagereceiver_oncallback) callback is triggered. When the OH_ImageNative object returned by this function is no longer needed, call [OH_ImageNative_Release](capi-image-native-h.md#oh_imagenative_release) to release the object. New data can be received only after the release.|
44| [Image_ErrorCode OH_ImageReceiverNative_ReadNextImage(OH_ImageReceiverNative* receiver, OH_ImageNative** image)](#oh_imagereceivernative_readnextimage) | - | Obtains the next image through an OH_ImageReceiverNative object.<br>This function can be called to receive data only after the [OH_ImageReceiver_OnCallback](#oh_imagereceiver_oncallback) callback is triggered. When the OH_ImageNative object returned by this function is no longer needed, call [OH_ImageNative_Release](capi-image-native-h.md#oh_imagenative_release) to release the object. New data can be received only after the release.|
45| [Image_ErrorCode OH_ImageReceiverNative_On(OH_ImageReceiverNative* receiver, OH_ImageReceiver_OnCallback callback)](#oh_imagereceivernative_on) | - | Registers the [OH_ImageReceiver_OnCallback](#oh_imagereceiver_oncallback) callback.<br>This callback is triggered whenever a new image is received.|
46| [Image_ErrorCode OH_ImageReceiverNative_Off(OH_ImageReceiverNative* receiver)](#oh_imagereceivernative_off) | - | Unregisters the [OH_ImageReceiver_OnCallback](#oh_imagereceiver_oncallback) callback.<br>The callback is registered by calling [OH_ImageReceiverNative_On](#oh_imagereceivernative_on).|
47| [Image_ErrorCode OH_ImageReceiverNative_GetSize(OH_ImageReceiverNative* receiver, Image_Size* size)](#oh_imagereceivernative_getsize) | - | Obtains the size of an **OH_ImageReceiverNative**.|
48| [Image_ErrorCode OH_ImageReceiverNative_GetCapacity(OH_ImageReceiverNative* receiver, int32_t* capacity)](#oh_imagereceivernative_getcapacity) | - | Obtains the capacity of an **OH_ImageReceiverNative**.|
49| [Image_ErrorCode OH_ImageReceiverNative_Release(OH_ImageReceiverNative* receiver)](#oh_imagereceivernative_release) | - | Releases an OH_ImageReceiverNative object.|
50| [Image_ErrorCode OH_ImageReceiverNative_OnImageArrive(OH_ImageReceiverNative *receiver,OH_ImageReceiver_ImageArriveCallback callback, void *userData)](#oh_imagereceivernative_onimagearrive) | - | Registers the [OH_ImageReceiver_ImageArriveCallback](#oh_imagereceiver_imagearrivecallback) callback.|
51| [Image_ErrorCode OH_ImageReceiverNative_OffImageArrive(OH_ImageReceiverNative *receiver,OH_ImageReceiver_ImageArriveCallback callback)](#oh_imagereceivernative_offimagearrive) | - | Unregisters the [OH_ImageReceiver_ImageArriveCallback](#oh_imagereceiver_imagearrivecallback) callback.|
52
53## Function Description
54
55### OH_ImageReceiver_OnCallback()
56
57```
58typedef void (*OH_ImageReceiver_OnCallback)(OH_ImageReceiverNative *receiver)
59```
60
61**Description**
62
63Defines the callbacks for the image receiver at the native layer.
64
65**Since**: 12
66
67### OH_ImageReceiver_ImageArriveCallback()
68
69```
70typedef void (*OH_ImageReceiver_ImageArriveCallback)(OH_ImageReceiverNative *receiver, void *userData)
71```
72
73**Description**
74
75Defines the callback for the ImageArrive event.
76
77**Since**: 20
78
79### OH_ImageReceiverOptions_Create()
80
81```
82Image_ErrorCode OH_ImageReceiverOptions_Create(OH_ImageReceiverOptions **options)
83```
84
85**Description**
86
87Creates an OH_ImageReceiverOptions object at the application layer.
88
89**Since**: 12
90
91
92**Parameters**
93
94| Name| Description|
95| -- | -- |
96| [OH_ImageReceiverOptions](capi-image-nativemodule-oh-imagereceiveroptions.md) **options | Double pointer to the OH_ImageReceiverOptions object created.|
97
98**Returns**
99
100| Type| Description|
101| -- | -- |
102| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) |**IMAGE_SUCCESS**: The operation is successful.<br> **IMAGE_BAD_PARAMETER**: A parameter is incorrect.<br> **IMAGE_ALLOC_FAILED**: Memory allocation fails.|
103
104### OH_ImageReceiverOptions_GetSize()
105
106```
107Image_ErrorCode OH_ImageReceiverOptions_GetSize(OH_ImageReceiverOptions* options, Image_Size* size)
108```
109
110**Description**
111
112Obtains the image size of an OH_ImageReceiverOptions object.
113
114**Since**: 12
115
116
117**Parameters**
118
119| Name| Description|
120| -- | -- |
121| [OH_ImageReceiverOptions](capi-image-nativemodule-oh-imagereceiveroptions.md)* options | Pointer to an OH_ImageReceiverOptions object.|
122| [Image_Size](capi-image-nativemodule-image-size.md)* size | Pointer to the Image_Size object obtained.|
123
124**Returns**
125
126| Type| Description|
127| -- | -- |
128| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) |**IMAGE_SUCCESS**: The operation is successful.<br>**IMAGE_BAD_PARAMETER**: A parameter is incorrect.|
129
130### OH_ImageReceiverOptions_SetSize()
131
132```
133Image_ErrorCode OH_ImageReceiverOptions_SetSize(OH_ImageReceiverOptions* options, Image_Size size)
134```
135
136**Description**
137
138Sets the image size for an OH_ImageReceiverOptions object.
139
140**Since**: 12
141
142
143**Parameters**
144
145| Name| Description|
146| -- | -- |
147| [OH_ImageReceiverOptions](capi-image-nativemodule-oh-imagereceiveroptions.md)* options| Pointer to an OH_ImageReceiverOptions object.|
148| [Image_Size](capi-image-nativemodule-image-size.md) size | Image_Size object.|
149
150**Returns**
151
152| Type| Description|
153| -- | -- |
154| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) |**IMAGE_SUCCESS**: The operation is successful.<br>**IMAGE_BAD_PARAMETER**: A parameter is incorrect.|
155
156### OH_ImageReceiverOptions_GetCapacity()
157
158```
159Image_ErrorCode OH_ImageReceiverOptions_GetCapacity(OH_ImageReceiverOptions* options, int32_t* capacity)
160```
161
162**Description**
163
164Obtains the capacity of an OH_ImageReceiverOptions object.
165
166**Since**: 12
167
168
169**Parameters**
170
171| Name| Description|
172| -- | -- |
173| [OH_ImageReceiverOptions](capi-image-nativemodule-oh-imagereceiveroptions.md)* options| Pointer to an OH_ImageReceiverOptions object.|
174| int32_t* capacity | Pointer to the capacity obtained.|
175
176**Returns**
177
178| Type| Description|
179| -- | -- |
180| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) |**IMAGE_SUCCESS**: The operation is successful.<br>**IMAGE_BAD_PARAMETER**: A parameter is incorrect.|
181
182### OH_ImageReceiverOptions_SetCapacity()
183
184```
185Image_ErrorCode OH_ImageReceiverOptions_SetCapacity(OH_ImageReceiverOptions* options, int32_t capacity)
186```
187
188**Description**
189
190Sets the capacity for an OH_ImageReceiverOptions object.
191
192**Since**: 12
193
194
195**Parameters**
196
197| Name| Description|
198| -- | -- |
199| [OH_ImageReceiverOptions](capi-image-nativemodule-oh-imagereceiveroptions.md)* options| Pointer to an OH_ImageReceiverOptions object.|
200| int32_t capacity | Capacity.|
201
202**Returns**
203
204| Type| Description|
205| -- | -- |
206| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) |**IMAGE_SUCCESS**: The operation is successful.<br>**IMAGE_BAD_PARAMETER**: A parameter is incorrect.|
207
208### OH_ImageReceiverOptions_Release()
209
210```
211Image_ErrorCode OH_ImageReceiverOptions_Release(OH_ImageReceiverOptions* options)
212```
213
214**Description**
215
216Releases an OH_ImageReceiverOptions object.
217
218**Since**: 12
219
220
221**Parameters**
222
223| Name| Description|
224| -- | -- |
225| [OH_ImageReceiverOptions](capi-image-nativemodule-oh-imagereceiveroptions.md)* options| Pointer to an OH_ImageReceiverOptions object.|
226
227**Returns**
228
229| Type| Description|
230| -- | -- |
231| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) |**IMAGE_SUCCESS**: The operation is successful.<br>**IMAGE_BAD_PARAMETER**: A parameter is incorrect.|
232
233### OH_ImageReceiverNative_Create()
234
235```
236Image_ErrorCode OH_ImageReceiverNative_Create(OH_ImageReceiverOptions* options, OH_ImageReceiverNative** receiver)
237```
238
239**Description**
240
241Creates an OH_ImageReceiverNative object at the application layer.
242
243**Since**: 12
244
245
246**Parameters**
247
248| Name| Description|
249| -- | -- |
250| [OH_ImageReceiverOptions](capi-image-nativemodule-oh-imagereceiveroptions.md)* options| Pointer to an OH_ImageReceiverOptions object.|
251| [OH_ImageReceiverNative](capi-image-nativemodule-oh-imagereceivernative.md)** receiver | Double pointer to the OH_ImageReceiverNative object obtained.|
252
253**Returns**
254
255| Type| Description|
256| -- | -- |
257| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) |**IMAGE_SUCCESS**: The operation is successful.<br> **IMAGE_BAD_PARAMETER**: A parameter is incorrect.<br> **IMAGE_ALLOC_FAILED**: Memory allocation fails.|
258
259### OH_ImageReceiverNative_GetReceivingSurfaceId()
260
261```
262Image_ErrorCode OH_ImageReceiverNative_GetReceivingSurfaceId(OH_ImageReceiverNative* receiver, uint64_t* surfaceId)
263```
264
265**Description**
266
267Obtains the surface ID through an OH_ImageReceiverNative object.
268
269**Since**: 12
270
271
272**Parameters**
273
274| Name| Description|
275| -- | -- |
276| [OH_ImageReceiverNative](capi-image-nativemodule-oh-imagereceivernative.md)* receiver | Pointer to an OH_ImageReceiverNative object.|
277| uint64_t* surfaceId | Pointer to the surface ID obtained.|
278
279**Returns**
280
281| Type| Description|
282| -- | -- |
283| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) |**IMAGE_SUCCESS**: The operation is successful.<br> **IMAGE_BAD_PARAMETER**: A parameter is incorrect.<br> **IMAGE_UNKNOWN_ERROR**: An unknown error occurs.|
284
285### OH_ImageReceiverNative_ReadLatestImage()
286
287```
288Image_ErrorCode OH_ImageReceiverNative_ReadLatestImage(OH_ImageReceiverNative* receiver, OH_ImageNative** image)
289```
290
291**Description**
292
293Obtains the latest image through an OH_ImageReceiverNative object.
294
295This function can be called to receive data only after the [OH_ImageReceiver_OnCallback](#oh_imagereceiver_oncallback) callback is triggered. When the OH_ImageNative object returned by this function is no longer needed, call [OH_ImageNative_Release](capi-image-native-h.md#oh_imagenative_release) to release the object. New data can be received only after the release.
296
297**Since**: 12
298
299
300**Parameters**
301
302| Name| Description|
303| -- | -- |
304| [OH_ImageReceiverNative](capi-image-nativemodule-oh-imagereceivernative.md)* receiver | Pointer to an OH_ImageReceiverNative object.|
305| [OH_ImageNative](capi-image-nativemodule-oh-imagenative.md)** image | Double pointer to the image obtained, which is an OH_ImageNative object at the application layer.|
306
307**Returns**
308
309| Type| Description|
310| -- | -- |
311| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) |**IMAGE_SUCCESS**: The operation is successful.<br> **IMAGE_BAD_PARAMETER**: A parameter is incorrect.<br>**IMAGE_UNKNOWN_ERROR**: An unknown error occurs.<br> **IMAGE_ALLOC_FAILED**: Memory allocation fails.|
312
313### OH_ImageReceiverNative_ReadNextImage()
314
315```
316Image_ErrorCode OH_ImageReceiverNative_ReadNextImage(OH_ImageReceiverNative* receiver, OH_ImageNative** image)
317```
318
319**Description**
320
321Obtains the next image through an OH_ImageReceiverNative object.
322
323This function can be called to receive data only after the [OH_ImageReceiver_OnCallback](#oh_imagereceiver_oncallback) callback is triggered. When the OH_ImageNative object returned by this function is no longer needed, call [OH_ImageNative_Release](capi-image-native-h.md#oh_imagenative_release) to release the object. New data can be received only after the release.
324
325**Since**: 12
326
327
328**Parameters**
329
330| Name| Description|
331| -- | -- |
332| [OH_ImageReceiverNative](capi-image-nativemodule-oh-imagereceivernative.md)* receiver | Pointer to an OH_ImageReceiverNative object.|
333| [OH_ImageNative](capi-image-nativemodule-oh-imagenative.md)** image | Double pointer to the image obtained, which is an OH_ImageNative object at the application layer.|
334
335**Returns**
336
337| Type| Description|
338| -- | -- |
339| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) |**IMAGE_SUCCESS**: The operation is successful.<br> **IMAGE_BAD_PARAMETER**: A parameter is incorrect.<br>**IMAGE_UNKNOWN_ERROR**: An unknown error occurs.<br> **IMAGE_ALLOC_FAILED**: Memory allocation fails.|
340
341### OH_ImageReceiverNative_On()
342
343```
344Image_ErrorCode OH_ImageReceiverNative_On(OH_ImageReceiverNative* receiver, OH_ImageReceiver_OnCallback callback)
345```
346
347**Description**
348
349Registers the [OH_ImageReceiver_OnCallback](#oh_imagereceiver_oncallback) callback.
350
351This callback is triggered whenever a new image is received.
352
353**Since**: 12
354
355
356**Parameters**
357
358| Name| Description|
359| -- | -- |
360| [OH_ImageReceiverNative](capi-image-nativemodule-oh-imagereceivernative.md)* receiver | Pointer to an OH_ImageReceiverNative object.|
361| [OH_ImageReceiver_OnCallback](#oh_imagereceiver_oncallback) callback | Callback to register.|
362
363**Returns**
364
365| Type| Description|
366| -- | -- |
367| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) |**IMAGE_SUCCESS**: The operation is successful.<br>**IMAGE_BAD_PARAMETER**: A parameter is incorrect.|
368
369### OH_ImageReceiverNative_Off()
370
371```
372Image_ErrorCode OH_ImageReceiverNative_Off(OH_ImageReceiverNative* receiver)
373```
374
375**Description**
376
377Unregisters the [OH_ImageReceiver_OnCallback](#oh_imagereceiver_oncallback) callback.
378
379The callback is registered by calling [OH_ImageReceiverNative_On](#oh_imagereceivernative_on).
380
381**Since**: 12
382
383
384**Parameters**
385
386| Name| Description|
387| -- | -- |
388| [OH_ImageReceiverNative](capi-image-nativemodule-oh-imagereceivernative.md)* receiver | Pointer to an OH_ImageReceiverNative object.|
389
390**Returns**
391
392| Type| Description|
393| -- | -- |
394| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) |**IMAGE_SUCCESS**: The operation is successful.<br>**IMAGE_BAD_PARAMETER**: A parameter is incorrect.|
395
396### OH_ImageReceiverNative_GetSize()
397
398```
399Image_ErrorCode OH_ImageReceiverNative_GetSize(OH_ImageReceiverNative* receiver, Image_Size* size)
400```
401
402**Description**
403
404Obtains the size of an **OH_ImageReceiverNative**.
405
406**Since**: 12
407
408
409**Parameters**
410
411| Name| Description|
412| -- | -- |
413| [OH_ImageReceiverNative](capi-image-nativemodule-oh-imagereceivernative.md)* receiver | Pointer to an OH_ImageReceiverNative object.|
414| [Image_Size](capi-image-nativemodule-image-size.md)* size | Pointer to the Image_Size object obtained.|
415
416**Returns**
417
418| Type| Description|
419| -- | -- |
420| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) |**IMAGE_SUCCESS**: The operation is successful.<br>**IMAGE_BAD_PARAMETER**: A parameter is incorrect.|
421
422### OH_ImageReceiverNative_GetCapacity()
423
424```
425Image_ErrorCode OH_ImageReceiverNative_GetCapacity(OH_ImageReceiverNative* receiver, int32_t* capacity)
426```
427
428**Description**
429
430Obtains the capacity of an **OH_ImageReceiverNative**.
431
432**Since**: 12
433
434
435**Parameters**
436
437| Name| Description|
438| -- | -- |
439| [OH_ImageReceiverNative](capi-image-nativemodule-oh-imagereceivernative.md)* receiver | Pointer to an OH_ImageReceiverNative object.|
440| int32_t* capacity | Pointer to the capacity obtained.|
441
442**Returns**
443
444| Type| Description|
445| -- | -- |
446| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) |**IMAGE_SUCCESS**: The operation is successful.<br>**IMAGE_BAD_PARAMETER**: A parameter is incorrect.|
447
448### OH_ImageReceiverNative_Release()
449
450```
451Image_ErrorCode OH_ImageReceiverNative_Release(OH_ImageReceiverNative* receiver)
452```
453
454**Description**
455
456Releases an OH_ImageReceiverNative object.
457
458**Since**: 12
459
460
461**Parameters**
462
463| Name| Description|
464| -- | -- |
465| [OH_ImageReceiverNative](capi-image-nativemodule-oh-imagereceivernative.md)* receiver | Pointer to an OH_ImageReceiverNative object.|
466
467**Returns**
468
469| Type| Description|
470| -- | -- |
471| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) |**IMAGE_SUCCESS**: The operation is successful.<br>**IMAGE_BAD_PARAMETER**: A parameter is incorrect.|
472
473### OH_ImageReceiverNative_OnImageArrive()
474
475```
476Image_ErrorCode OH_ImageReceiverNative_OnImageArrive(OH_ImageReceiverNative *receiver,OH_ImageReceiver_ImageArriveCallback callback, void *userData)
477```
478
479**Description**
480
481Registers the [OH_ImageReceiver_ImageArriveCallback](#oh_imagereceiver_imagearrivecallback) callback.
482
483**Since**: 20
484
485
486**Parameters**
487
488| Name| Description|
489| -- | -- |
490| [OH_ImageReceiverNative](capi-image-nativemodule-oh-imagereceivernative.md) *receiver | Pointer to an OH_ImageReceiverNative object that processes the callback.|
491| [OH_ImageReceiver_ImageArriveCallback](#oh_imagereceiver_imagearrivecallback) callback | Callback to register.|
492| void *userData | Pointer to user data.|
493
494**Returns**
495
496| Type| Description|
497| -- | -- |
498| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) |**IMAGE_SUCCESS**: The operation is successful.<br>         **IMAGE_RECEIVER_INVALID_PARAMETER**: A parameter is incorrect.|
499
500### OH_ImageReceiverNative_OffImageArrive()
501
502```
503Image_ErrorCode OH_ImageReceiverNative_OffImageArrive(OH_ImageReceiverNative *receiver,OH_ImageReceiver_ImageArriveCallback callback)
504```
505
506**Description**
507
508Unregisters the [OH_ImageReceiver_ImageArriveCallback](#oh_imagereceiver_imagearrivecallback) callback.
509
510**Since**: 20
511
512
513**Parameters**
514
515| Name| Description|
516| -- | -- |
517| [OH_ImageReceiverNative](capi-image-nativemodule-oh-imagereceivernative.md) *receiver | Pointer to an OH_ImageReceiverNative object that processes the callback.|
518| [OH_ImageReceiver_ImageArriveCallback](#oh_imagereceiver_imagearrivecallback) callback | Callback to unregister.|
519
520**Returns**
521
522| Type| Description|
523| -- | -- |
524| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) |**IMAGE_SUCCESS**: The operation is successful.<br>         **IMAGE_RECEIVER_INVALID_PARAMETER**: The **receiver** or **callback** parameter is not registered.|
525