程序包 ohos.media.audio

类 AudioWaver

java.lang.Object

ohos.media.audio.AudioWaver

public class AudioWaver
extends Object

Provides the audio visualization feature.

从以下版本开始:

4

SystemCapability

SystemCapability.Multimedia#AUDIO

嵌套类概要

嵌套类

限定符和类型	类	说明
static interface	AudioWaver.FrequencyDataObserver	Provides an observer to listen for frequency-domain audio data.
static interface	AudioWaver.WaveDataObserver	Provides an observer to listen for time-domain audio data.

构造器概要

构造器

构造器	说明
AudioWaver(int sessionId, String packageName)	A constructor used to create a AudioWaver instance.

方法概要

限定符和类型	方法	说明
static int	getMaxDataSize()	Obtains the maximum size allowed for audio data capturing.
static int	getMinDataSize()	Obtains the minimum size allowed for audio data capturing.
static int	getMinInterval()	Obtains the minimum interval allowed for audio data capturing.
void	release()	Releases audio visualization resources.
boolean	setActivated(boolean activated)	Activates or deactivates audio visualization.
boolean	setDataSize(int size)	Sets the size of audio data that can be captured.
boolean	setFrequencyDataObserver(AudioWaver.FrequencyDataObserver observer, int interval)	Sets an observer to listen for the frequency-domain waveform data at frequencies around the specific frequency.
boolean	setWaveDataObserver(AudioWaver.WaveDataObserver observer, int interval)	Sets an observer to listen for the time-domain waveform data at frequencies around the specific frequency.

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

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

构造器详细资料

AudioWaver

public AudioWaver(int sessionId,
                  String packageName)
           throws UnsupportedOperationException

A constructor used to create a AudioWaver instance.

参数:

sessionId - Indicates the ID of an audio playback session.

packageName - Indicates an application package name.

抛出:

UnsupportedOperationException - Throws this exception if initialization of this class fails.

从以下版本开始:

4

方法详细资料

release

public void release()

Releases audio visualization resources.

从以下版本开始:

4

setDataSize

public boolean setDataSize(int size)

Sets the size of audio data that can be captured.

Before calling this method, obtain the supported size range via getMinDataSize() and getMaxDataSize() and ensure the data size set by this method is within the range. Otherwise, the setting fails.

参数:

size - Indicates the audio data size to set.

返回:

Returns true if the setting is successful; returns false otherwise.

从以下版本开始:

4

setActivated

public boolean setActivated(boolean activated)

Activates or deactivates audio visualization.

参数:

activated - Specifies whether audio visualization will be activated. Value true means to activate the feature, and false means the opposite.

返回:

Returns true if the operation is successful; returns false otherwise.

从以下版本开始:

4

getMinDataSize

public static int getMinDataSize()

Obtains the minimum size allowed for audio data capturing.

The size of captured audio data must be within the allowed size range. For the maximum size allowed, see getMaxDataSize().

返回:

Returns the minimum size of the audio data to capture.

从以下版本开始:

4

getMaxDataSize

public static int getMaxDataSize()

Obtains the maximum size allowed for audio data capturing.

The size of captured audio data must be within the allowed size range. For the maximum size allowed, see getMaxDataSize().

返回:

Returns the maximum size of the audio data to capture.

从以下版本开始:

4

getMinInterval

public static int getMinInterval()

Obtains the minimum interval allowed for audio data capturing.

The minimum interval is used when you call setWaveDataObserver(ohos.media.audio.AudioWaver.WaveDataObserver,int) and setFrequencyDataObserver(ohos.media.audio.AudioWaver.FrequencyDataObserver,int) to ensure that the sampling interval is longer than or equal to the minimum interval.

返回:

Returns the minimum audio capturing interval.

从以下版本开始:

4

setWaveDataObserver

public boolean setWaveDataObserver(AudioWaver.WaveDataObserver observer,
                                   int interval)

Sets an observer to listen for the time-domain waveform data at frequencies around the specific frequency.

参数:

observer - Indicates the observer to set.

interval - Indicates the audio data capturing interval. You should use getMinInterval() to obtain the minimum interval and ensure that interval is greater than or equal to the minimum interval.

返回:

Returns true if the setting is successful; returns false otherwise.

从以下版本开始:

4

setFrequencyDataObserver

public boolean setFrequencyDataObserver(AudioWaver.FrequencyDataObserver observer,
                                        int interval)

Sets an observer to listen for the frequency-domain waveform data at frequencies around the specific frequency.

参数:

observer - Indicates the observer to set.

interval - Indicates the audio data capturing interval. You should use getMinInterval() to obtain the minimum interval and ensure that interval is greater than or equal to the minimum interval.

返回:

Returns true if the setting is successful; returns false otherwise.

从以下版本开始:

4