• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# OH_AudioCapturer_Callbacks_Struct
2
3
4## Overview
5
6The **OH_AudioCapturer_Callbacks_Struct** struct defines a pointer to the callback functions related to an audio capturer.
7
8**System capability**: SystemCapability.Multimedia.Audio.Core
9
10**Since**: 10
11
12**Related module**: [OHAudio](_o_h_audio.md)
13
14
15## Summary
16
17
18### Member Variables
19
20| Name| Description|
21| -------- | -------- |
22| int32_t(\* [OH_AudioCapturer_OnReadData](#oh_audiocapturer_onreaddata) )([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer, void \*userData, void \*buffer, int32_t lenth) | Defines a function pointer to the callback function used to read audio data.|
23| int32_t(\* [OH_AudioCapturer_OnStreamEvent](#oh_audiocapturer_onstreamevent) )([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer, void \*userData, [OH_AudioStream_Event](_o_h_audio.md#oh_audiostream_event) event) | Defines a function pointer to the callback function used to process audio recording stream events.|
24| int32_t(\* [OH_AudioCapturer_OnInterruptEvent](#oh_audiocapturer_oninterruptevent) )([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer, void \*userData, [OH_AudioInterrupt_ForceType](_o_h_audio.md#oh_audiointerrupt_forcetype) type, [OH_AudioInterrupt_Hint](_o_h_audio.md#oh_audiointerrupt_hint) hint) | Defines a function pointer to the callback function used to process audio recording interruption events.|
25| int32_t(\* [OH_AudioCapturer_OnError](#oh_audiocapturer_onerror) )([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer, void \*userData, [OH_AudioStream_Result](_o_h_audio.md#oh_audiostream_result) error) | Defines a function pointer to the callback function used to process audio recording errors.|
26
27
28## Member Variable Description
29
30
31### OH_AudioCapturer_OnError
32
33```
34int32_t(* OH_AudioCapturer_Callbacks_Struct::OH_AudioCapturer_OnError) (OH_AudioCapturer *capturer, void *userData, OH_AudioStream_Result error)
35```
36
37**Description**
38
39Defines a function pointer to the callback function used to process audio recording errors.
40
41**Since**: 10
42
43
44### OH_AudioCapturer_OnInterruptEvent
45
46```
47int32_t(* OH_AudioCapturer_Callbacks_Struct::OH_AudioCapturer_OnInterruptEvent) (OH_AudioCapturer *capturer, void *userData, OH_AudioInterrupt_ForceType type, OH_AudioInterrupt_Hint hint)
48```
49
50**Description**
51
52Defines a function pointer to the callback function used to process audio recording interruption events.
53
54**Since**: 10
55
56
57### OH_AudioCapturer_OnReadData
58
59```
60int32_t(* OH_AudioCapturer_Callbacks_Struct::OH_AudioCapturer_OnReadData) (OH_AudioCapturer *capturer, void *userData, void *buffer, int32_t lenth)
61```
62
63**Description**
64
65Defines a function pointer to the callback function used to read audio data.
66
67
68### OH_AudioCapturer_OnStreamEvent
69
70```
71int32_t(* OH_AudioCapturer_Callbacks_Struct::OH_AudioCapturer_OnStreamEvent) (OH_AudioCapturer *capturer, void *userData, OH_AudioStream_Event event)
72```
73
74**Description**
75
76Defines a function pointer to the callback function used to process audio recording stream events.
77
78**Since**: 10
79