• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# native_audiocapturer.h
2
3
4## Overview
5
6Declares the 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### Functions
19
20| Name| Description|
21| -------- | -------- |
22| [OH_AudioStream_Result](_o_h_audio.md#oh_audiostream_result)[OH_AudioCapturer_Release](_o_h_audio.md#oh_audiocapturer_release) ([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer) | Releases an audio capturer. |
23| [OH_AudioStream_Result](_o_h_audio.md#oh_audiostream_result)[OH_AudioCapturer_Start](_o_h_audio.md#oh_audiocapturer_start) ([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer) | Starts an audio capturer. |
24| [OH_AudioStream_Result](_o_h_audio.md#oh_audiostream_result)[OH_AudioCapturer_Pause](_o_h_audio.md#oh_audiocapturer_pause) ([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer) | Pauses an audio capturer. |
25| [OH_AudioStream_Result](_o_h_audio.md#oh_audiostream_result)[OH_AudioCapturer_Stop](_o_h_audio.md#oh_audiocapturer_stop) ([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer) | Stops an audio capturer. |
26| [OH_AudioStream_Result](_o_h_audio.md#oh_audiostream_result)[OH_AudioCapturer_Flush](_o_h_audio.md#oh_audiocapturer_flush) ([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer) | Flushes obtained audio data. |
27| [OH_AudioStream_Result](_o_h_audio.md#oh_audiostream_result)[OH_AudioCapturer_GetCurrentState](_o_h_audio.md#oh_audiocapturer_getcurrentstate) ([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer, [OH_AudioStream_State](_o_h_audio.md#oh_audiostream_state) \*state) | Obtains the state of an audio capturer. |
28| [OH_AudioStream_Result](_o_h_audio.md#oh_audiostream_result)[OH_AudioCapturer_GetLatencyMode](_o_h_audio.md#oh_audiocapturer_getlatencymode) ([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer, [OH_AudioStream_LatencyMode](_o_h_audio.md#oh_audiostream_latencymode) \*latencyMode) | Obtains the latency mode of an audio capturer. |
29| [OH_AudioStream_Result](_o_h_audio.md#oh_audiostream_result)[OH_AudioCapturer_GetStreamId](_o_h_audio.md#oh_audiocapturer_getstreamid) ([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer, uint32_t \*streamId) | Obtains the stream ID of an audio capturer. |
30| [OH_AudioStream_Result](_o_h_audio.md#oh_audiostream_result)[OH_AudioCapturer_GetSamplingRate](_o_h_audio.md#oh_audiocapturer_getsamplingrate) ([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer, int32_t \*rate) | Obtains the sampling rate of an audio capturer. |
31| [OH_AudioStream_Result](_o_h_audio.md#oh_audiostream_result)[OH_AudioCapturer_GetChannelCount](_o_h_audio.md#oh_audiocapturer_getchannelcount) ([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer, int32_t \*channelCount) | Obtains the number of channels for an audio capturer. |
32| [OH_AudioStream_Result](_o_h_audio.md#oh_audiostream_result)[OH_AudioCapturer_GetSampleFormat](_o_h_audio.md#oh_audiocapturer_getsampleformat) ([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer, [OH_AudioStream_SampleFormat](_o_h_audio.md#oh_audiostream_sampleformat) \*sampleFormat) | Obtains the sampling format of an audio capturer. |
33| [OH_AudioStream_Result](_o_h_audio.md#oh_audiostream_result)[OH_AudioCapturer_GetEncodingType](_o_h_audio.md#oh_audiocapturer_getencodingtype) ([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer, [OH_AudioStream_EncodingType](_o_h_audio.md#oh_audiostream_encodingtype) \*encodingType) | Obtains the encoding type of an audio capturer. |
34| [OH_AudioStream_Result](_o_h_audio.md#oh_audiostream_result)[OH_AudioCapturer_GetCapturerInfo](_o_h_audio.md#oh_audiocapturer_getcapturerinfo) ([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer, [OH_AudioStream_SourceType](_o_h_audio.md#oh_audiostream_sourcetype) \*sourceType) | Obtains the usage scenario of an audio capturer. |
35| [OH_AudioStream_Result](_o_h_audio.md#oh_audiostream_result)[OH_AudioCapturer_GetFrameSizeInCallback](_o_h_audio.md#oh_audiocapturer_getframesizeincallback) ([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer, int32_t \*frameSize) | Obtains the frame size in the callback. |
36| [OH_AudioStream_Result](_o_h_audio.md#oh_audiostream_result)[OH_AudioCapturer_GetTimestamp](_o_h_audio.md#oh_audiocapturer_gettimestamp) ([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer, clockid_t clockId, int64_t \*framePosition, int64_t \*timestamp) | Obtains the timestamp and position information of an input audio stream. |
37| [OH_AudioStream_Result](_o_h_audio.md#oh_audiostream_result)[OH_AudioCapturer_GetFramesRead](_o_h_audio.md#oh_audiocapturer_getframesread) ([OH_AudioCapturer](_o_h_audio.md#oh_audiocapturer) \*capturer, int64_t \*frames) | Obtains the number of frames that have been read since the stream was created. |
38