Default immersitech event manager.
More...
#include <immersitech_event_manager.h>
|
| imm_event_manager () |
| Create a default event manager. More...
|
|
virtual | ~imm_event_manager () |
| Destroy a default event manager. More...
|
|
virtual void | create_room_event (int room_id) |
| A function to propagate an IMM_EVENT_CREATE_ROOM event. More...
|
|
virtual void | destroy_room_event (int room_id) |
| A function to propagate an IMM_EVENT_DESTROY_ROOM event. More...
|
|
virtual void | add_participant_event (int room_id, int participant_id, const char *participant_name, imm_participant_configuration config) |
| A function to propagate an IMM_EVENT_ADD_PARTICIPANT event. More...
|
|
virtual void | remove_participant_event (int room_id, int participant_id) |
| A function to propagate an IMM_EVENT_REMOVE_PARTICIPANT event. More...
|
|
virtual void | set_participant_seat_event (int room_id, int participant_id, imm_seat seat) |
| A function to propagate an IMM_EVENT_SET_PARTICIPANT_SEAT event. More...
|
|
virtual void | set_participant_position_event (int room_id, int participant_id, imm_position position, imm_heading heading) |
| A function to propagate an IMM_EVENT_SET_PARTICIPANT_POSITION event. More...
|
|
virtual void | set_participant_state_event (int room_id, int participant_id, imm_audio_control control_to_edit, int value) |
| A function to propagate an IMM_EVENT_SET_PARTICIPANT_STATE event. More...
|
|
virtual void | set_all_participants_state_event (int room_id, imm_audio_control control_to_edit, int value) |
| A function to propagate an IMM_EVENT_SET_ALL_PARTICIPANTS_STATE event. More...
|
|
virtual void | set_room_layout_event (int room_id, int room_layout_id) |
| A function to propagate an IMM_EVENT_SET_ROOM_LAYOUT event. More...
|
|
virtual void | set_name_event (int room_id, int participant_id, const char *name) |
| A function to propagate an IMM_EVENT_SET_NAME event. More...
|
|
Default immersitech event manager.
The default event manager will not do anything upon function call as seen in the function definitions. This class is made for a developer to inherit and create a custom event manager. With a custom event manager, each function can perform actions specific to their system / application.
◆ imm_event_manager()
imm_event_manager::imm_event_manager |
( |
| ) |
|
|
inline |
Create a default event manager.
In your custom event manager, you can set up any member variables here
◆ ~imm_event_manager()
virtual imm_event_manager::~imm_event_manager |
( |
| ) |
|
|
inlinevirtual |
Destroy a default event manager.
In your custom event manager, you can destroy any member variables you set up in the constructor
◆ add_participant_event()
virtual void imm_event_manager::add_participant_event |
( |
int |
room_id, |
|
|
int |
participant_id, |
|
|
const char * |
participant_name, |
|
|
imm_participant_configuration |
config |
|
) |
| |
|
inlinevirtual |
A function to propagate an IMM_EVENT_ADD_PARTICIPANT event.
In your custom event manager, implement this function to define what you would like to happen upon this event type being triggered.
- Parameters
-
[in] | room_id | The ID of the room that the participant was added to |
[in] | participant_id | The ID of the participant that was added |
[in] | participant_name | The name of the participant that was added |
[in] | config | The configuration for the participant such as input sampling rate and input number of frames |
◆ create_room_event()
virtual void imm_event_manager::create_room_event |
( |
int |
room_id | ) |
|
|
inlinevirtual |
A function to propagate an IMM_EVENT_CREATE_ROOM event.
In your custom event manager, implement this function to define what you would like to happen upon this event type being triggered.
- Parameters
-
[in] | room_id | The ID of the room that was created |
◆ destroy_room_event()
virtual void imm_event_manager::destroy_room_event |
( |
int |
room_id | ) |
|
|
inlinevirtual |
A function to propagate an IMM_EVENT_DESTROY_ROOM event.
In your custom event manager, implement this function to define what you would like to happen upon this event type being triggered.
- Parameters
-
[in] | room_id | The ID of the room that was destroyed |
◆ remove_participant_event()
virtual void imm_event_manager::remove_participant_event |
( |
int |
room_id, |
|
|
int |
participant_id |
|
) |
| |
|
inlinevirtual |
A function to propagate an IMM_EVENT_REMOVE_PARTICIPANT event.
In your custom event manager, implement this function to define what you would like to happen upon this event type being triggered.
- Parameters
-
[in] | room_id | The ID of the room that the participant was removed from |
[in] | participant_id | The ID of the participant that was removed |
◆ set_all_participants_state_event()
virtual void imm_event_manager::set_all_participants_state_event |
( |
int |
room_id, |
|
|
imm_audio_control |
control_to_edit, |
|
|
int |
value |
|
) |
| |
|
inlinevirtual |
A function to propagate an IMM_EVENT_SET_ALL_PARTICIPANTS_STATE event.
In your custom event manager, implement this function to define what you would like to happen upon this event type being triggered.
- Parameters
-
[in] | room_id | The ID of the room that the participants are in |
[in] | control_to_edit | The audio control that was changed |
[in] | value | The value the audio control was set to |
◆ set_name_event()
virtual void imm_event_manager::set_name_event |
( |
int |
room_id, |
|
|
int |
participant_id, |
|
|
const char * |
name |
|
) |
| |
|
inlinevirtual |
A function to propagate an IMM_EVENT_SET_NAME event.
In your custom event manager, implement this function to define what you would like to happen upon this event type being triggered.
- Parameters
-
[in] | room_id | The ID of the room that changed its layout |
[in] | participant_id | The ID of the participant whose name changed |
[in] | name | The new name for the participant |
◆ set_participant_position_event()
virtual void imm_event_manager::set_participant_position_event |
( |
int |
room_id, |
|
|
int |
participant_id, |
|
|
imm_position |
position, |
|
|
imm_heading |
heading |
|
) |
| |
|
inlinevirtual |
A function to propagate an IMM_EVENT_SET_PARTICIPANT_POSITION event.
In your custom event manager, implement this function to define what you would like to happen upon this event type being triggered.
- Parameters
-
[in] | room_id | The ID of the room that the participant was moved in |
[in] | participant_id | The ID of the participant that was moved |
[in] | position | The new position of the participant |
[in] | heading | The new heading of the participant |
◆ set_participant_seat_event()
virtual void imm_event_manager::set_participant_seat_event |
( |
int |
room_id, |
|
|
int |
participant_id, |
|
|
imm_seat |
seat |
|
) |
| |
|
inlinevirtual |
A function to propagate an IMM_EVENT_SET_PARTICIPANT_SEAT event.
In your custom event manager, implement this function to define what you would like to happen upon this event type being triggered.
- Parameters
-
[in] | room_id | The ID of the room that the participant was moved in |
[in] | participant_id | The ID of the participant that was moved |
[in] | seat | The seat that the participant was moved to |
◆ set_participant_state_event()
virtual void imm_event_manager::set_participant_state_event |
( |
int |
room_id, |
|
|
int |
participant_id, |
|
|
imm_audio_control |
control_to_edit, |
|
|
int |
value |
|
) |
| |
|
inlinevirtual |
A function to propagate an IMM_EVENT_SET_PARTICIPANT_STATE event.
In your custom event manager, implement this function to define what you would like to happen upon this event type being triggered.
- Parameters
-
[in] | room_id | The ID of the room that the participant is in |
[in] | participant_id | The ID of the participant whose state was changed |
[in] | control_to_edit | The audio control the was changed |
[in] | value | The value the audio control was set to |
◆ set_room_layout_event()
virtual void imm_event_manager::set_room_layout_event |
( |
int |
room_id, |
|
|
int |
room_layout_id |
|
) |
| |
|
inlinevirtual |
A function to propagate an IMM_EVENT_SET_ROOM_LAYOUT event.
In your custom event manager, implement this function to define what you would like to happen upon this event type being triggered.
- Parameters
-
[in] | room_id | The ID of the room that changed its layout |
[in] | room_layout_id | The ID of the room layout that was applied |
The documentation for this class was generated from the following file: