Represents a room. Used to manager room, room's events.
| Properties |
|---|
| Events | |
|---|---|
|
Invoked when new user join room. |
|
|
Invoked when user leave room. |
|
|
Invoked when add video track to room. |
|
|
Invoked when remove video track from room. |
|
|
Invoked when get message in room. |
| Methods |
|---|
|
publish(StringeeVideoTrack videoTrack) → result Publish video track to room. |
|
unPublish(StringeeVideoTrack videoTrack) → result Unpublish video track from room. |
|
subscribe(StringeeVideoTrack videoTrack, StringeeVideoTrackOptions options) → result Subcribe video track in room. |
|
unsubscribe(StringeeVideoTrack videoTrack) → result Unsubcribe video track in room. |
|
leave({required bool allClient}) → result Leave room. |
|
sendMessage(Map<dynamic, dynamic> msg) → result Sends any message to room. |
|
Close event stream. |
| id → String |
|---|
| It's the unique identification of the room on Stringee system. |
| recorded → bool |
|---|
| Whether the room is recorded:
- true - is recorded. - false - is not recorded. |
| eventStreamController → StreamController<dynamic> |
|---|
| It's controller of event stream which was sended from plugin. |
| didJoinRoom |
|---|
| Invoked when new user join room. Receive StringeeRoomUser from event['body']. |
| didLeaveRoom |
|---|
| Invoked when new user leave room. Receive StringeeRoomUser from event['body']. |
| didAddVideoTrack |
|---|
| Invoked when add video track to call. Receive StringeeVideoTrack from event['body']. |
| didRemoveVideoTrack |
|---|
| Invoked when remove video track from call. Receive StringeeVideoTrack from event['body']. |
| didReceiveRoomMessage |
|---|
| Invoked when get message in room. Receive from event['body']: - msg: Message. - from: StringeeRoomUser;. |
| publish(StringeeVideoTrack videoTrack) → result |
|---|
| Publish video track to room. |
| unPublish(StringeeVideoTrack videoTrack) → result |
|---|
| Unpublish video track from room.. |
| subscribe(StringeeVideoTrack videoTrack, StringeeVideoTrackOptions options) → result |
|---|
| Subcribe video track in room. |
| unsubscribe(StringeeVideoTrack videoTrack) → result |
|---|
| Unsubcribe video track in room. |
| leave({required bool allClient}) → result |
|---|
| Leave room. |
| sendMessage(Map<dynamic, dynamic> msg) → result |
|---|
| Sends any message to room. |
| destroy() → void |
|---|
| Close event stream. |
