Class AudioEffect

Definition

Namespace:

Tizen.Multimedia

Assembly:

Tizen.Multimedia.MediaPlayer.dll

Provides the ability to control the audio effects for Player.

public class AudioEffect

Inheritance

object

AudioEffect

Properties

BandLevelRange

Gets the range of band level in dB.

Declaration

public Range BandLevelRange { get; }

Property Value

Type	Description
Range

Exceptions

Type	Condition
NotAvailableException	If audio offload is enabled by calling IsEnabled. (Since tizen 6.0) -or- IsAvailable returns false. (Since tizen 6.0)

See Also

IsAvailable

Count

Gets the number of items.

Declaration

public int Count { get; }

Property Value

Type	Description
int

Exceptions

Type	Condition
NotAvailableException	If audio offload is enabled by calling IsEnabled. (Since tizen 6.0) -or- IsAvailable returns false. (Since tizen 6.0)

See Also

IsAvailable

IsAvailable

Gets the value whether the AudioEffect is available or not.

Declaration

public bool IsAvailable { get; }

Property Value

Type	Description
bool

Remarks

This function returns the availability of the AudioEffect. It could be unavailable depending on the platform capabilities.
If audio offload is enabled by calling IsEnabled, the IsAvailable returns false.(Since tizen 6.0)

Exceptions

Type	Condition
NotAvailableException	Depending on the audio codec type, the function is not available. (Since tizen 6.0)

See Also

AudioOffload

AudioCodecType

this[int]

Gets a EqualizerBand at the specified index.

Declaration

public EqualizerBand this[int index] { get; }

Parameters

Type	Name	Description
int	index	The index of the band to get.

Property Value

Type	Description
EqualizerBand

Exceptions

Type	Condition
System.ObjectDisposedException	The Player has already been disposed of.
System.ArgumentOutOfRangeException	is less than zero. -or- index is equal to or greater than Count.
NotAvailableException	If audio offload is enabled by calling IsEnabled. (Since tizen 6.0)

Player

Gets the player that this AudioEffect belongs to.

Declaration

public Player Player { get; }

Property Value

Type	Description
Player

Methods

Clear()

Clears the equalizer effect.

Declaration

public void Clear()

Exceptions

Type	Condition
System.ObjectDisposedException	The Player has already been disposed of.
NotAvailableException	If audio offload is enabled by calling IsEnabled. (Since tizen 6.0) -or- IsAvailable returns false. (Since tizen 6.0)

See Also

IsAvailable