LocalVideoEffectsFeature Class

Package:

com.azure.android.communication.calling

• java.lang.Object
• • LocalVideoStreamFeature
  • • com.azure.android.communication.calling.LocalVideoEffectsFeature

public class LocalVideoEffectsFeature extends LocalVideoStreamFeature

LocalVideoStream Feature for managing video effects.

Method Summary

Modifier and Type	Method and Description
void	addOnVideoEffectDisabledListener(VideoEffectDisabledListener listener) Adds the specified listener to receive OnVideoEffectDisabled events. Registers the event notifying the application that the effect is disabled.
void	addOnVideoEffectEnabledListener(VideoEffectEnabledListener listener) Adds the specified listener to receive OnVideoEffectEnabled events. Registers the event notifying the application that the effect is enabled.
void	addOnVideoEffectErrorListener(VideoEffectErrorListener listener) Adds the specified listener to receive OnVideoEffectError events. Registers the event notifying the application that the effect has an error.
void	disableEffect(VideoEffect effect) Disable an enabled video effect.
void	enableEffect(VideoEffect effect) Enables a video effect. Video effect to start
boolean	isEffectSupported(VideoEffect effect) Checks if a video effect is supported on the device. Video effect to check if supported
void	removeOnVideoEffectDisabledListener(VideoEffectDisabledListener listener) Removes the specified listener to receive OnVideoEffectDisabled events. Registers the event notifying the application that the effect is disabled.
void	removeOnVideoEffectEnabledListener(VideoEffectEnabledListener listener) Removes the specified listener to receive OnVideoEffectEnabled events. Registers the event notifying the application that the effect is enabled.
void	removeOnVideoEffectErrorListener(VideoEffectErrorListener listener) Removes the specified listener to receive OnVideoEffectError events. Registers the event notifying the application that the effect has an error.

Inherited Members

LocalVideoStreamFeature.finalize() LocalVideoStreamFeature.getName()

Method Details

addOnVideoEffectDisabledListener

public void addOnVideoEffectDisabledListener(VideoEffectDisabledListener listener)

Adds the specified listener to receive OnVideoEffectDisabled events. Registers the event notifying the application that the effect is disabled.

Parameters:

listener

addOnVideoEffectEnabledListener

public void addOnVideoEffectEnabledListener(VideoEffectEnabledListener listener)

Adds the specified listener to receive OnVideoEffectEnabled events. Registers the event notifying the application that the effect is enabled.

Parameters:

listener

addOnVideoEffectErrorListener

public void addOnVideoEffectErrorListener(VideoEffectErrorListener listener)

Adds the specified listener to receive OnVideoEffectError events. Registers the event notifying the application that the effect has an error.

Parameters:

listener

disableEffect

public void disableEffect(VideoEffect effect)

Disable an enabled video effect.

Parameters:

effect

enableEffect

public void enableEffect(VideoEffect effect)

Enables a video effect. Video effect to start

Parameters:

effect - Video effect to start

isEffectSupported

public boolean isEffectSupported(VideoEffect effect)

Checks if a video effect is supported on the device. Video effect to check if supported

Parameters:

effect - Video effect to check if supported

removeOnVideoEffectDisabledListener

public void removeOnVideoEffectDisabledListener(VideoEffectDisabledListener listener)

Removes the specified listener to receive OnVideoEffectDisabled events. Registers the event notifying the application that the effect is disabled.

Parameters:

listener

removeOnVideoEffectEnabledListener

public void removeOnVideoEffectEnabledListener(VideoEffectEnabledListener listener)

Removes the specified listener to receive OnVideoEffectEnabled events. Registers the event notifying the application that the effect is enabled.

Parameters:

listener

removeOnVideoEffectErrorListener

public void removeOnVideoEffectErrorListener(VideoEffectErrorListener listener)

Removes the specified listener to receive OnVideoEffectError events. Registers the event notifying the application that the effect has an error.

Parameters:

listener