native_audiocapturer.h

Overview

The native_audiocapturer.h declares the functions related to an audio capturer.

Library: libohaudio.so

File to include: <ohaudio/native_audiocapturer.h>

System capability: SystemCapability.Multimedia.Audio.Core

Since: 10

Related module: OHAudio

Summary

Types

Name	Description
typedef void(* OH_AudioCapturer_OnReadDataCallback) (OH_AudioCapturer capturer, void userData, void *audioData, int32_t audioDataSize)	Defines the callback used to read audio data.
typedef void(* OH_AudioCapturer_OnDeviceChangeCallback) (OH_AudioCapturer capturer, void userData, OH_AudioDeviceDescriptorArray *deviceArray)	Defines the callback for audio capturer device change events.
typedef void(* OH_AudioCapturer_OnInterruptCallback) (OH_AudioCapturer capturer, void userData, OH_AudioInterrupt_ForceType type, OH_AudioInterrupt_Hint hint)	Defines the callback for interruption events of an audio capturer.
typedef void(* OH_AudioCapturer_OnErrorCallback) (OH_AudioCapturer renderer, void userData, OH_AudioStream_Result error)	Defines the callback for error events of an audio capturer.

Functions

Name	Description
OH_AudioStream_Result OH_AudioCapturer_Release(OH_AudioCapturer *capturer)	Releases an audio capturer.
OH_AudioStream_Result OH_AudioCapturer_Start(OH_AudioCapturer *capturer)	Starts an audio capturer.
OH_AudioStream_Result OH_AudioCapturer_Pause(OH_AudioCapturer *capturer)	Pauses an audio capturer.
OH_AudioStream_Result OH_AudioCapturer_Stop(OH_AudioCapturer *capturer)	Stops an audio capturer.
OH_AudioStream_Result OH_AudioCapturer_Flush(OH_AudioCapturer *capturer)	Flushes obtained audio data.
OH_AudioStream_Result OH_AudioCapturer_GetCurrentState(OH_AudioCapturer capturer, OH_AudioStream_State state)	Obtains the state of an audio capturer.
OH_AudioStream_Result OH_AudioCapturer_GetLatencyMode(OH_AudioCapturer capturer, OH_AudioStream_LatencyMode latencyMode)	Obtains the latency mode of an audio capturer.
OH_AudioStream_Result OH_AudioCapturer_GetStreamId(OH_AudioCapturer capturer, uint32_t streamId)	Obtains the stream ID of an audio capturer.
OH_AudioStream_Result OH_AudioCapturer_GetSamplingRate(OH_AudioCapturer capturer, int32_t rate)	Obtains the sampling rate of an audio capturer.
OH_AudioStream_Result OH_AudioCapturer_GetChannelCount(OH_AudioCapturer capturer, int32_t channelCount)	Obtains the number of channels for an audio capturer.
OH_AudioStream_Result OH_AudioCapturer_GetSampleFormat(OH_AudioCapturer capturer, OH_AudioStream_SampleFormat sampleFormat)	Obtains the sampling format of an audio capturer.
OH_AudioStream_Result OH_AudioCapturer_GetEncodingType(OH_AudioCapturer capturer, OH_AudioStream_EncodingType encodingType)	Obtains the encoding type of an audio capturer.
OH_AudioStream_Result OH_AudioCapturer_GetCapturerInfo(OH_AudioCapturer capturer, OH_AudioStream_SourceType sourceType)	Obtains the usage scenario of an audio capturer.
OH_AudioStream_Result OH_AudioCapturer_GetFrameSizeInCallback(OH_AudioCapturer capturer, int32_t frameSize)	Obtains the frame size in the callback.
OH_AudioStream_Result OH_AudioCapturer_GetTimestamp(OH_AudioCapturer capturer, clockid_t clockId, int64_t framePosition, int64_t *timestamp)	Obtains the timestamp and position information of an input audio stream.
OH_AudioStream_Result OH_AudioCapturer_GetFramesRead(OH_AudioCapturer capturer, int64_t frames)	Obtains the number of frames that have been read since the stream was created.
OH_AudioStream_Result OH_AudioCapturer_GetOverflowCount(OH_AudioCapturer capturer, uint32_t count)	Obtains the number of overloaded audio streams of an audio capturer.