HMSAudioTrackSetting class
100ms HMSAudioTrackSetting
HMSAudioTrackSetting contains the useHardwareAcousticEchoCanceler, audioSource(iOS only), and trackInitialState.
Constructors
- HMSAudioTrackSetting({bool? useHardwareAcousticEchoCanceler, HMSAudioMixerSource? audioSource, HMSTrackInitState? trackInitialState = HMSTrackInitState.UNMUTED, HMSAudioMode? audioMode, HMSAndroidPhoneCallState phoneCallState = HMSAndroidPhoneCallState.DISABLE_MUTE_ON_VOIP_PHONE_CALL_RING, bool enableNoiseCancellation = false})
- HMSAudioTrackSetting.fromMap(Map map)
-
factory
Properties
- audioMode → HMSAudioMode?
-
audioMode property to set the audio mode of audio track i.e voice or music mode
Refer: Read more about audio mode here
final
- audioSource ↔ HMSAudioMixerSource?
-
audioSource only for iOS. Used for audioSharing use cases.
Refer: Read more about audio source here
getter/setter pair
- enableNoiseCancellation → bool
-
enableNoiseCancellation property sets the noise cancellation status in the room whether is enabled or not.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- phoneCallState → HMSAndroidPhoneCallState
-
phoneCallState property to set the state of microphone i.e mute/unmute on phone call ring
If set to
DISABLE_MUTE_ON_VOIP_PHONE_CALL_RING
then the microphone will not be muted on phone call ring Similarly if set toENABLE_MUTE_ON_PHONE_CALL_RING
then the microphone will be muted on phone call ring By default it's set toDISABLE_MUTE_ON_VOIP_PHONE_CALL_RING
Refer: Read more about phone call state herefinal - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- trackInitialState → HMSTrackInitState?
-
trackInitialState property to set the initial state of the audio track i.e Mute/Unmute.By default it's unmuted.
Refer: Read more about trackInitialState here
final
- useHardwareAcousticEchoCanceler → bool?
-
useHardwareAcousticEchoCanceler controls if the built-in HW acoustic echo canceler should be used or not.
The default is on if it is supported.
Please note that on some devices the hardware wrongly reports the HW echo canceler to be present whereas it does not work
In such as application need to set this to false, so that SW echo canceler is picked up.
Refer: Read more about useHardwareAcousticEchoCanceler here
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited