程序包 ohos.media.audio

类 SoundEffect

java.lang.Object

ohos.media.audio.SoundEffect

直接已知子类:

AudioEqualizer, EchoCancelerEffect, GainControlEffect, NoiseSuppressorEffect

public class SoundEffect
extends Object

Manages sound effects.

从以下版本开始:

1

SystemCapability

SystemCapability.Multimedia#AUDIO

嵌套类概要

嵌套类

限定符和类型	类	说明
static class	SoundEffect.SoundEffectInfo	Provides sound effect information.

字段概要

字段

限定符和类型	字段	说明
static String	SOUND_EFFECT_MODE_AUXILIARY	Indicates the auxiliary mode.
static String	SOUND_EFFECT_MODE_INSERT	Indicates the insert mode.
static String	SOUND_EFFECT_MODE_PRE_PROCESSING	Indicates the preprocessing mode.
static UUID	SOUND_EFFECT_TYPE_AE	Indicates the ID of the audio equalizer effect.
static UUID	SOUND_EFFECT_TYPE_EC	Indicates the ID of the echo cancellation effect.
static UUID	SOUND_EFFECT_TYPE_GC	Indicates the ID of the gain control effect.
static UUID	SOUND_EFFECT_TYPE_INVALID	Indicates the ID of an invalid sound effect.
static UUID	SOUND_EFFECT_TYPE_NS	Indicates the ID of the noise reduction effect.

构造器概要

构造器

构造器	说明
SoundEffect(UUID uid, UUID type, int priority, int sessionId, String packageName)	A constructor used to create a SoundEffect instance.

方法概要

限定符和类型	方法	说明
static SoundEffect.SoundEffectInfo[]	acquireEffects()	Obtains sound effects available on a device.
boolean	getActivated()	Checks whether a sound effect is activated.
int	getEffectId()	Obtains the native ID of a sound effect.
SoundEffect.SoundEffectInfo	getEffectInfo()	Obtains sound effect information.
static boolean	isEffectAvailable(UUID type)	Checks whether a device supports sound effects of a specified type.
boolean	release()	Releases sound effect resources.
boolean	setActivated(boolean activated)	Sets the sound effect status.

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

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

字段详细资料

SOUND_EFFECT_MODE_AUXILIARY

public static final String SOUND_EFFECT_MODE_AUXILIARY

Indicates the auxiliary mode.

从以下版本开始:

1

另请参阅:

常量字段值

SOUND_EFFECT_MODE_INSERT

public static final String SOUND_EFFECT_MODE_INSERT

Indicates the insert mode.

从以下版本开始:

1

另请参阅:

常量字段值

SOUND_EFFECT_MODE_PRE_PROCESSING

public static final String SOUND_EFFECT_MODE_PRE_PROCESSING

Indicates the preprocessing mode.

从以下版本开始:

1

另请参阅:

常量字段值

SOUND_EFFECT_TYPE_AE

public static final UUID SOUND_EFFECT_TYPE_AE

Indicates the ID of the audio equalizer effect.

从以下版本开始:

3

SOUND_EFFECT_TYPE_EC

public static final UUID SOUND_EFFECT_TYPE_EC

Indicates the ID of the echo cancellation effect.

从以下版本开始:

1

SOUND_EFFECT_TYPE_GC

public static final UUID SOUND_EFFECT_TYPE_GC

Indicates the ID of the gain control effect.

从以下版本开始:

1

SOUND_EFFECT_TYPE_INVALID

public static final UUID SOUND_EFFECT_TYPE_INVALID

Indicates the ID of an invalid sound effect.

从以下版本开始:

1

SOUND_EFFECT_TYPE_NS

public static final UUID SOUND_EFFECT_TYPE_NS

Indicates the ID of the noise reduction effect.

从以下版本开始:

1

构造器详细资料

SoundEffect

public SoundEffect(UUID uid,
                   UUID type,
                   int priority,
                   int sessionId,
                   String packageName)
            throws UnsupportedOperationException

A constructor used to create a SoundEffect instance.

参数:

uid - Indicates a sound effect ID.

type - Indicates a sound effect type.

priority - Indicates the priority of a sound effect.

sessionId - Indicates the ID of an audio recording or playback session.

packageName - Indicates an application package name.

抛出:

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

从以下版本开始:

1

方法详细资料

isEffectAvailable

public static boolean isEffectAvailable(UUID type)

Checks whether a device supports sound effects of a specified type.

参数:

type - Indicates a sound effect type.

返回:

Returns true if the device supports sound effects of the specified type; returns false otherwise.

从以下版本开始:

1

acquireEffects

public static SoundEffect.SoundEffectInfo[] acquireEffects()

Obtains sound effects available on a device.

返回:

Returns the list of available sound effects.

从以下版本开始:

1

getEffectInfo

public SoundEffect.SoundEffectInfo getEffectInfo()

Obtains sound effect information.

返回:

Returns a SoundEffectInfo object containing the sound effect information.

从以下版本开始:

1

getEffectId

public int getEffectId()

Obtains the native ID of a sound effect.

返回:

Returns the native ID of the audio effect.

从以下版本开始:

1

setActivated

public boolean setActivated(boolean activated)

Sets the sound effect status.

参数:

activated - Specifies whether to activate a sound effect. Value true means the sound effect will be activated, while false means the opposite.

返回:

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

从以下版本开始:

1

getActivated

public boolean getActivated()

Checks whether a sound effect is activated.

返回:

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

从以下版本开始:

1

release

public boolean release()

Releases sound effect resources.

返回:

Returns true if the resources are released; returns false otherwise.

从以下版本开始:

1