OHOS::Audio::AudioCapturer

Overview

Related Modules:

MultiMedia_AudioCapturer

Description:

Provides functions for applications to implement audio capturing.

Since:

1.0

Version:

1.0

Summary

Public Member Functions

Public Member Function Name

Description

GetFrameCount ()

uint64_t 

Obtains the number of frames required in the current condition, in bytes per sample.

SetCapturerInfo (const AudioCapturerInfo info)

int32_t 

Sets audio capture parameters.

GetCapturerInfo (AudioCapturerInfo &info)

int32_t 

Obtains audio capture parameters.

Start ()

bool 

Starts audio recording.

Read (uint8_t *buffer, size_t userSize, bool isBlockingRead)

int32_t 

Reads audio data.

GetStatus ()

State 

Obtains the audio capture state.

GetAudioTime (Timestamp &timestamp, Timestamp::Timebase base)

bool 

Obtains the timestamp.

Stop ()

bool 

Stops audio recording.

Release ()

bool 

Releases a local AudioCapturer object.

Static Public Member Functions

Static Public Member Function Name

Description

GetMinFrameCount (int32_t sampleRate, int32_t channelCount, AudioCodecFormat audioFormat, size_t &frameCount)

static bool 

Obtains the minimum number of frames required in a specified condition, in bytes per sample.