This repository is aimed at developers who are interested in creating Custom Plugins for ovice, a platform that enables real-time interactions through a communication system leveraging iframe postMessage. The system provides a set of events to handle user participation, access participant information, and facilitate custom communication among users. It is designed to help developers integrate features easily and improve the user experience when interconnecting different domains.
Here are some examples of plugins you can use as a reference for developing your own:
| Plugin Name | Description |
|---|---|
| Meeting Cash Clock | A tool to monitor meeting cost in real-time. |
| RSS Reader | An RSS feed plugin to read news or articles within ovice. |
| Sound Track | A plugin to play background music or soundtracks in the space. |
| Fast Press Game | This is a quick press game for multiple people that can be used for quizzes, etc. |
| Grouping | This is a tool that allows you to efficiently divide participants into groups. |
| Memo | A simple memo app. |
These events notify about the status of users interacting with objects within ovice:
User is within the range of the object but not linked.
User is linked to the object.
User was linked but left the object.
User was linked or within the range of the object but moved out of range.
Events related to establishing the initial connection with ovice:
| Event Name | Triggered By |
|---|---|
| ovice_get_participants | Client Domain |
Events triggered by the ovice domain related to the actions of a participant:
| Event Name | Triggered By |
|---|---|
| ovice_participant_subscribed | ovice Domain |
| ovice_participant_unsubscribed | ovice Domain |
| ovice_participant_joined | ovice Domain |
| ovice_participant_left | ovice Domain |
Events designed to retrieve information about participants:
| Event Name | Triggered By |
|---|---|
| ovice_get_participants | Client Domain |
| ovice_participants | ovice Domain |
Events facilitating real-time communication between participants:
| Event Name | Triggered By |
|---|---|
| ovice_broadcast_message | Client Domain |
| ovice_emit_message | Client Domain |
An event meant to reflect messages between participants:
| Event Name | Triggered By |
|---|---|
| ovice_message | ovice Domain |
Events in the ovice domain related to data management and storage actions:
| Event Name | Triggered By |
|---|---|
| ovice_get_data | Client Domain |
| ovice_saved_data | ovice Domain |
| ovice_save_and_emit_data | Client Domain |
| ovice_shared_data | ovice Domain |
| ovice_data_saved_success | ovice Domain |