Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

AVRecorder.PerformEffectForReaction

Triggers a specified reaction on the video stream.

Component Version macOS Windows Linux Server iOS SDK
AVRecorder 13.5 ✅ Yes ❌ No ❌ No ❌ No ✅ Yes
MBS( "AVRecorder.PerformEffectForReaction"; AVSession; reactionType )   More

Parameters

Parameter Description Example
AVSession The ID for the AVRecorder session as returned by AVRecorder.Init. $AVSession
reactionType Indicates which reaction to perform.

Result

Returns OK or error.

Description

Triggers a specified reaction on the video stream.
The reactionType requested must be one of those listed in AVRecorder.AvailableReactionTypes or an exception will be thrown. Performing a reaction when AVRecorder.CanPerformReactionEffects is false is ignored, and VoIP applications are encouraged to transmit and display such reactions outside of the video feed.

Requires macOS 14.0 or iOS 17.0.

Examples

Perform balloon reaction:

MBS( "AVRecorder.PerformEffectForReaction"; $$AVSession; "ReactionBalloons" )

See also

Release notes

Blog Entries

This function is free to use.

Created 21st October 2023, last changed 21st October 2023


AVRecorder.List - AVRecorder.ReactionEffectGesturesEnabled