Class AudioEffect

View Source

Definition

Namespace:
Tizen.Multimedia
Assembly:
Tizen.Multimedia.MediaPlayer.dll

Provides the ability to control the audio effects for Player.


                
C#

                

                    
Copy

                    

                

            
public class AudioEffect
Inheritance
object
AudioEffect

Properties

View Source

BandLevelRange

Gets the range of band level in dB.

Declaration

                
C#

                

                    
Copy

                    

                

            
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
View Source

Count

Gets the number of items.

Declaration

                
C#

                

                    
Copy

                    

                

            
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
View Source

IsAvailable

Gets the value whether the AudioEffect is available or not.

Declaration

                
C#

                

                    
Copy

                    

                

            
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
View Source

this[int]

Gets a EqualizerBand at the specified index.

Declaration

                
C#

                

                    
Copy

                    

                

            
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)
View Source

Player

Gets the player that this AudioEffect belongs to.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Player Player { get; }
Property Value
Type Description
Player

Methods

View Source

Clear()

Clears the equalizer effect.

Declaration

                
C#

                

                    
Copy

                    

                

            
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