程序包 ohos.media.audio

类 AudioCapturer

java.lang.Object

ohos.media.audio.AudioCapturer

public class AudioCapturer
extends Object

Provides interfaces for applications to implement PCM audio recording and pausing functions.

This class provides the record and stop interfaces to record and pause PCM audio. The initial parameters of this class are included in the AudioCapturerInfo class.

从以下版本开始:

1

SystemCapability

SystemCapability.Multimedia#AUDIO

嵌套类概要

嵌套类

限定符和类型	类	说明
static class	AudioCapturer.State	Describes recording states.

字段概要

字段

限定符和类型	字段	说明
static int	CAPTURER_SESSION_ID_NONE	Indicates the default ID when there is no recording session.
static int	ERROR	Indicates that the operation has failed.
static int	ERROR_BAD_VALUE	Indicates that the failure is caused by an invalid value.
static int	ERROR_DEAD_OBJECT	Indicates that the native layer is unavailable.
static int	ERROR_INVALID_OPERATION	Indicates that the failure is caused by the use of an incorrect method.
static int	INPUT_DEVICE_ID_NONE	Indicates the default ID when there is no input device.
static int	SUCCESS	Indicates that the operation is successful.

构造器概要

构造器

构造器	说明
AudioCapturer(AudioCapturerInfo audioCapturerInfo)	A constructor used to create an AudioCapturerInfo instance with specified information about the audio streams to record.
AudioCapturer(AudioCapturerInfo audioCapturerInfo, AudioDeviceDescriptor devInfo)	A constructor used to create an AudioCapturerInfo instance with specified information about the audio streams and input device.

方法概要

限定符和类型	方法	说明
boolean	addSoundEffect(UUID type, String packageName)	Adds a sound effect for audio recording.
AudioStreamInfo.ChannelMask	getAudioChannel()	Obtains channel mask information used for audio recording.
int	getAudioInputSource()	Obtains the audio stream input source.
AudioStreamInfo	getAudioStreamInfo()	Obtains an AudioStreamInfo instance of an audio source.
boolean	getAudioTime(Timestamp timestamp, Timestamp.Timebase timebase)	Obtains a Timestamp on demand.
int	getBufferFrameCount()	Obtains the buffer size in frames.
int	getCapturerSessionId()	Obtains a recording session ID.
int	getChannelCount()	Obtains the number of audio recording channels.
AudioDeviceDescriptor	getCurrentDevice()	Obtains information about the device that is recording audio.
AudioStreamInfo.EncodingFormat	getEncodingFormat()	Obtains the audio encoding format for the recording.
static int	getMinBufferSize(int sampleRate, int channelCount, int audioFormat)	Obtains the minimum buffer size (in bytes) required in the specified conditions.
int	getSampleRate()	Obtains the audio stream sampling rate.
AudioDeviceDescriptor	getSelectedDevice()	Obtains information about the audio input device.
Set<SoundEffect>	getSoundEffects()	Obtains activated sound effects.
AudioCapturer.State	getState()	Obtains the audio capture state.
int	read(byte[] data, int offset, int size)	Reads audio data from the audio hardware.
int	read(byte[] data, int offset, int size, boolean isBlocking)	Reads audio data from the recording hardware device and writes the data into a byte array.
int	read(float[] data, int offsetInFloats, int sizeInFloats)	(Blocking method) Reads audio data from the recording hardware device and writes the data into a float array.
int	read(float[] data, int offsetInFloats, int sizeInFloats, boolean isBlocking)	Reads audio data from the recording hardware device to a float array.
int	read(short[] data, int offsetInShorts, int sizeInShorts)	(Blocking method) Reads audio data from the recording hardware device and writes the data into a short array.
int	read(short[] data, int offsetInShorts, int sizeInShorts, boolean isBlocking)	Reads audio data from the recording hardware device and writes the data into a short array.
int	read(ByteBuffer buffer, int sizeInBytes)	(Blocking method) Reads audio data from the recording hardware device and writes the data into the direct buffer.
int	read(ByteBuffer buffer, int sizeInBytes, boolean isBlocking)	Reads audio data from the recording hardware device and writes the data into the direct buffer.
boolean	release()	Releases local audio recording object.
void	setFrameIntervalObserver(FrameIntervalObserver observer, int interval, EventHandler handler)	Sets an observer to listen for the event that the recording progress reaches a multiple of interval.
void	setFramePositionObserver(FramePositionObserver observer, int position, EventHandler handler)	Sets an observer to listen for the event that the recording progress reaches a specified position.
boolean	start()	Starts audio recording.
boolean	stop()	Stops audio recording.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

CAPTURER_SESSION_ID_NONE

public static final int CAPTURER_SESSION_ID_NONE

Indicates the default ID when there is no recording session.

从以下版本开始:

1

另请参阅:

常量字段值

ERROR

public static final int ERROR

Indicates that the operation has failed.

从以下版本开始:

1

另请参阅:

常量字段值

ERROR_BAD_VALUE

public static final int ERROR_BAD_VALUE

Indicates that the failure is caused by an invalid value.

从以下版本开始:

1

另请参阅:

常量字段值

ERROR_DEAD_OBJECT

public static final int ERROR_DEAD_OBJECT

Indicates that the native layer is unavailable.

从以下版本开始:

1

另请参阅:

常量字段值

ERROR_INVALID_OPERATION

public static final int ERROR_INVALID_OPERATION

Indicates that the failure is caused by the use of an incorrect method.

从以下版本开始:

1

另请参阅:

常量字段值

INPUT_DEVICE_ID_NONE

public static final int INPUT_DEVICE_ID_NONE

Indicates the default ID when there is no input device.

从以下版本开始:

1

另请参阅:

常量字段值

SUCCESS

public static final int SUCCESS

Indicates that the operation is successful.

从以下版本开始:

1

另请参阅:

常量字段值

构造器详细资料

AudioCapturer

public AudioCapturer(AudioCapturerInfo audioCapturerInfo,
                     AudioDeviceDescriptor devInfo)
              throws IllegalArgumentException

A constructor used to create an AudioCapturerInfo instance with specified information about the audio streams and input device.

参数:

audioCapturerInfo - Indicates information about the audio streams to record.

devInfo - Indicates information about the preference input device of this AudioCapturer.

抛出:

IllegalArgumentException - Throws this exception if a parameter is invalid.

从以下版本开始:

2

AudioCapturer

public AudioCapturer(AudioCapturerInfo audioCapturerInfo)
              throws IllegalArgumentException

A constructor used to create an AudioCapturerInfo instance with specified information about the audio streams to record.

参数:

audioCapturerInfo - Indicates information about the audio streams to record.

抛出:

IllegalArgumentException - Throws this exception if a parameter is invalid.

从以下版本开始:

2

方法详细资料

getMinBufferSize

public static int getMinBufferSize(int sampleRate,
                                   int channelCount,
                                   int audioFormat)

Obtains the minimum buffer size (in bytes) required in the specified conditions.

参数:

sampleRate - Indicates the sampling rate (Hz).

channelCount - Indicates the audio channel count.

audioFormat - Indicates the audio data format.

返回:

Returns the minimum buffer size (in bytes); returns -1 if an exception occurs.

从以下版本开始:

1

addSoundEffect

public boolean addSoundEffect(UUID type,
                              String packageName)

Adds a sound effect for audio recording.

参数:

type - Indicates a sound effect type, which can be SoundEffect#SOUND_EFFECT_TYPE_EC, SoundEffect#SOUND_EFFECT_TYPE_GC, and SoundEffect#SOUND_EFFECT_TYPE_NS.

packageName - Indicates an application package name.

返回:

Returns true if the sound effect is added; returns false otherwise.

从以下版本开始:

1

getSoundEffects

public Set<SoundEffect> getSoundEffects()

Obtains activated sound effects.

返回:

Returns the list of activated sound effects.

从以下版本开始:

1

getCapturerSessionId

public int getCapturerSessionId()

Obtains a recording session ID.

返回:

Returns the recording session ID.

从以下版本开始:

1

getSelectedDevice

public AudioDeviceDescriptor getSelectedDevice()

Obtains information about the audio input device.

This method is used to obtain the input device information specified using the AudioCapturer(ohos.media.audio.AudioCapturerInfo) method. The input device may be different from the recording device.

返回:

Returns information about the audio input device.

从以下版本开始:

1

getCurrentDevice

public AudioDeviceDescriptor getCurrentDevice()

Obtains information about the device that is recording audio.

This method is used to obtain the audio recording device configured using the AudioCapturer#AudioCapturer(AudioCapturerInfo, AudioDeviceDescriptor) method.

返回:

Returns device information if any device is recording audio; returns null otherwise.

从以下版本开始:

1

getState

public AudioCapturer.State getState()

Obtains the audio capture state.

返回:

Returns the audio capture state, which is defined in State.

从以下版本开始:

2

getEncodingFormat

public AudioStreamInfo.EncodingFormat getEncodingFormat()

Obtains the audio encoding format for the recording.

返回:

Returns the encoding format.

从以下版本开始:

3

getChannelCount

public int getChannelCount()

Obtains the number of audio recording channels.

返回:

Returns the number of audio recording channels.

从以下版本开始:

3

getSampleRate

public int getSampleRate()

Obtains the audio stream sampling rate.

返回:

Returns the audio stream sampling rate.

从以下版本开始:

1

getBufferFrameCount

public int getBufferFrameCount()

Obtains the buffer size in frames.

返回:

Returns the buffer size in frames.

从以下版本开始:

3

getAudioInputSource

public int getAudioInputSource()

Obtains the audio stream input source.

返回:

Returns the audio stream input source, which is defined by AudioCapturerInfo.AudioInputSource.

从以下版本开始:

1

getAudioChannel

public AudioStreamInfo.ChannelMask getAudioChannel()

Obtains channel mask information used for audio recording.

返回:

Returns the AudioStreamInfo.ChannelMask object.

从以下版本开始:

3

getAudioTime

public boolean getAudioTime(Timestamp timestamp,
                            Timestamp.Timebase timebase)

Obtains a Timestamp on demand.

The Timestamp reflects the frame delivery information at the earliest point available in the capture pipeline.

参数:

timestamp - a caller provided non-null Timestamp instance.

timebase - one of Timestamp.Timebase#BOOTTIME or Timestamp.Timebase#MONOTONIC, used to select the clock for the Timestamp time.

返回:

Returns true if the timestamp get successfully; returns false otherwise.

从以下版本开始:

3

getAudioStreamInfo

public AudioStreamInfo getAudioStreamInfo()

Obtains an AudioStreamInfo instance of an audio source.

返回:

Returns the AudioStreamInfo instance set during the construction of this AudioCapturer.

从以下版本开始:

6

start

public final boolean start()

Starts audio recording.

返回:

Returns true if audio recording is started successfully; returns false otherwise.

从以下版本开始:

1

read

public int read(byte[] data,
                int offset,
                int size)

Reads audio data from the audio hardware.

参数:

data - Indicates the audio data.

offset - Indicates the offset (in bytes) of the audio data.

size - Indicates the size (in bytes) of the audio to be read.

返回:

Returns the size (an integer from 0 to size) of the audio data if the data is read successfully; returns one of the following error codes otherwise: ERROR_BAD_VALUE indicates a parameter error. ERROR_INVALID_OPERATION indicates that the AudioCapturer instance is not initialized. ERROR_DEAD_OBJECT indicates that the AudioCapturer instance is abnormal.

从以下版本开始:

1

read

public int read(byte[] data,
                int offset,
                int size,
                boolean isBlocking)

Reads audio data from the recording hardware device and writes the data into a byte array.

参数:

data - Indicates the byte array into which the audio data to be written.

offset - Indicates the offsets (in bytes) for writing the audio data.

size - Indicates the size (in bytes) of the audio data to be read.

isBlocking - Specifies whether this method blocks until all the requested data is read.

返回:

Returns the size of the audio data read from the device, which ranges from 0 to size; returns one of the following error codes otherwise:

1. ERROR_BAD_VALUE: An input parameter is incorrect.
2. ERROR_INVALID_OPERATION: The AudioCapturer instance is not initialized.
3. ERROR_DEAD_OBJECT: The status of the AudioCapturer instance is abnormal.

从以下版本开始:

3

read

public int read(short[] data,
                int offsetInShorts,
                int sizeInShorts)

(Blocking method) Reads audio data from the recording hardware device and writes the data into a short array.

参数:

data - Indicates the short array into which the audio data to be written.

offsetInShorts - Indicates the offsets (represented by shorts) for writing the audio data.

sizeInShorts - Indicates the size (represented by shorts) of the audio data to be read.

返回:

Returns the size of the audio data read from the device, which ranges from 0 to sizeInShorts; returns one of the following error codes otherwise:

1. ERROR_BAD_VALUE: An input parameter is incorrect.
2. ERROR_INVALID_OPERATION: The AudioCapturer instance is not initialized.
3. ERROR_DEAD_OBJECT: The status of the AudioCapturer instance is abnormal.

从以下版本开始:

3

read

public int read(short[] data,
                int offsetInShorts,
                int sizeInShorts,
                boolean isBlocking)

Reads audio data from the recording hardware device and writes the data into a short array.

参数:

data - Indicates the short array into which the audio data to be written.

offsetInShorts - Indicates the offsets (represented by shorts) for writing the audio data.

sizeInShorts - Indicates the size (represented by shorts) of the audio data to be read.

isBlocking - Specifies whether this method blocks until all the requested data is read.

返回:

Returns the size of the audio data read from the device, which ranges from 0 to sizeInShorts; returns one of the following error codes otherwise:

1. ERROR_BAD_VALUE: An input parameter is incorrect.
2. ERROR_INVALID_OPERATION: The AudioCapturer instance is not initialized.
3. ERROR_DEAD_OBJECT: The status of the AudioCapturer instance is abnormal.

从以下版本开始:

3

read

public int read(float[] data,
                int offsetInFloats,
                int sizeInFloats)

(Blocking method) Reads audio data from the recording hardware device and writes the data into a float array.

参数:

data - Indicates the float array into which the audio data to be written.

offsetInFloats - Indicates the offsets (represented by floats) for writing the audio data.

sizeInFloats - Indicates the size (represented by floats) of the audio data to be read.

返回:

Returns the size of the audio data read from the device, which ranges from 0 to sizeInFloats; returns one of the following error codes otherwise:

1. ERROR_BAD_VALUE: An input parameter is incorrect.
2. ERROR_INVALID_OPERATION: The AudioCapturer instance is not initialized.
3. ERROR_DEAD_OBJECT: The status of the AudioCapturer instance is abnormal.

从以下版本开始:

3

read

public int read(float[] data,
                int offsetInFloats,
                int sizeInFloats,
                boolean isBlocking)

Reads audio data from the recording hardware device to a float array.

参数:

data - Indicates the float array into which the audio data to be written.

offsetInFloats - Indicates the offsets (represented by floats) for writing the audio data.

sizeInFloats - Indicates the size (represented by floats) of the audio data to be read.

isBlocking - Specifies whether this method blocks until all the requested data is read.

返回:

Returns the size of the audio data read from the device, which ranges from 0 to sizeInFloats; returns one of the following error codes otherwise:

1. ERROR_BAD_VALUE: An input parameter is incorrect.
2. ERROR_INVALID_OPERATION: The AudioCapturer instance is not initialized.
3. ERROR_DEAD_OBJECT: The status of the AudioCapturer instance is abnormal.

从以下版本开始:

3

read

public int read(ByteBuffer buffer,
                int sizeInBytes)

(Blocking method) Reads audio data from the recording hardware device and writes the data into the direct buffer. If the buffer is non-direct, returns 0.

参数:

buffer - Indicates the direct buffer where the audio data to be written.

sizeInBytes - Indicates the size (in bytes) of the audio data to be read. Set the size to an integral multiple of the frame size.

返回:

Returns the size of the audio data read from the device, which ranges from 0 to sizeInBytes; returns one of the following error codes otherwise:

1. ERROR_BAD_VALUE: An input parameter is incorrect.
2. ERROR_INVALID_OPERATION: The AudioCapturer instance is not initialized.
3. ERROR_DEAD_OBJECT: The status of the AudioCapturer instance is abnormal.

从以下版本开始:

3

read

public int read(ByteBuffer buffer,
                int sizeInBytes,
                boolean isBlocking)

Reads audio data from the recording hardware device and writes the data into the direct buffer. If the buffer is non-direct, returns 0.

参数:

buffer - Indicates the direct buffer where the audio data to be written.

sizeInBytes - Indicates the size (in bytes) of the audio data to be read. Set the size to an integral multiple of the frame size.

isBlocking - Specifies whether this method blocks until all the requested data is read.

返回:

Returns the size of the audio data read from the device, which ranges from 0 to sizeInBytes; returns one of the following error codes otherwise:

1. ERROR_BAD_VALUE: An input parameter is incorrect.
2. ERROR_INVALID_OPERATION: The AudioCapturer instance is not initialized.
3. ERROR_DEAD_OBJECT: The status of the AudioCapturer instance is abnormal.

从以下版本开始:

3

stop

public final boolean stop()

Stops audio recording.

返回:

Returns true if audio recording is stopped successfully; returns false otherwise.

从以下版本开始:

1

release

public final boolean release()

Releases local audio recording object.

返回:

Returns true if local audio is released successfully; returns false otherwise.

从以下版本开始:

1

setFramePositionObserver

public void setFramePositionObserver(FramePositionObserver observer,
                                     int position,
                                     EventHandler handler)

Sets an observer to listen for the event that the recording progress reaches a specified position.

参数:

observer - Indicates the observer to set.

position - Indicates the recording position.

handler - Indicates the event handler to invoke the observer. If you do not specify a handler, the default one will be used.

从以下版本开始:

4

setFrameIntervalObserver

public void setFrameIntervalObserver(FrameIntervalObserver observer,
                                     int interval,
                                     EventHandler handler)

Sets an observer to listen for the event that the recording progress reaches a multiple of interval.

参数:

observer - Indicates the observer to set.

interval - Indicates the audio frame interval.

handler - Indicates the event handler to invoke the observer. If you do not specify a handler, the default one will be used.

从以下版本开始:

4