- Meta Spark Studio
- Meta Spark Hub
- Features
- Learn
- Programs
- Blog
- Community
- Create AR effects for Instagram and Meta.Get Started
MultipeerModule
Allows an effect running in a video call to communicate with other instances of the same effect within the video call.
Multipeer communication is based around the broadcasting and receiving of JSON formatted messages on message channels.
Messages are broadcast to all peers except the instance that the message was broadcast from - an effect can’t broadcast a message to itself.
You can use the multipeer debugging tool to simulate message streams and debug multipeer effects.
Example
Properties
This module exposes no properties.
Methods
| Method | Description |
|---|---|
getBinaryMessageChannel | getBinaryMessageChannel(topic: string): BinaryMessageChannel Returns the specified BinaryMessageChannel.If no channel with the specified name is found, the GLOBAL channel is used by default.* topic - the name of the message channel (topic) to retrieve. |
getMessageChannel | getMessageChannel(topic: string): MessageChannel Returns the specified MessageChannel.If no channel with the specified name is found, the GLOBAL channel is used by default.* topic - the name of the message channel (topic) to retrieve. |
Classes
| Class | Description |
|---|---|
| MessageChannel | Represents a named bidirectional communication channel. Message channels are created on demand and persist for the duration of the effect's lifetime. Channels are available to all participants active within the same instance of an effect. |