fix(FEC-8984): add preset event (#439)

dispatch preset changed on player Gui
kaltura · Oct 24, 2019 · 6de3b54 · 6de3b54
1 parent b00e35e
commit 6de3b54
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 0 deletions.
diff --git a/docs/events.md b/docs/events.md
@@ -4,6 +4,7 @@
 | --------------------------------------------------------------- |
 | [`UI_CLICKED`](#UI_CLICKED)                                     |
 | [`UI_VISIBILITY_CHANGED`](#UI_VISIBILITY_CHANGED)               |
+| [`UI_PRESET_CHANGE`](#UI_PRESET_CHANGE)                         |
 | [`USER_CLICKED_PLAY`](#USER_CLICKED_PLAY)                       |
 | [`USER_CLICKED_PAUSE`](#USER_CLICKED_PAUSE)                     |
 | [`USER_CLICKED_REWIND`](#USER_CLICKED_REWIND)                   |
@@ -39,6 +40,20 @@
 
 #
 
+#
+
+> ### <a name="UI_PRESET_CHANGE"></a>UI_PRESET_CHANGE
+>
+> Fires when preset change.
+> <br><br>_payload parameters:_
+>
+> | Name   | Type     | Description                        |
+> | ------ | -------- | ---------------------------------- |
+> | `from` | `string` | Preset name before change          |
+> | `to`   | `string` | Preset name after change           |
+
+#
+
 > ### <a name="USER_CLICKED_PLAY"></a>USER_CLICKED_PLAY
 >
 > Fires when the user initiated play by the UI.<br>

diff --git a/src/components/event-dispatcher/event-dispatcher-provider.js b/src/components/event-dispatcher/event-dispatcher-provider.js
@@ -98,6 +98,10 @@ function onChangeableComponentsHandler(store: any, action: Object, player: Objec
       player.dispatchEvent(new SeekedEvent(action.payload.from, action.payload.to));
       break;
 
+    case 'PlayerGui':
+      player.dispatchEvent(new FakeEvent(FakeEvent.Type.UI_PRESET_CHANGE, action.payload));
+      break;
+
     default:
       break;
   }

diff --git a/src/event/event-type.js b/src/event/event-type.js
@@ -4,6 +4,7 @@ const namespace = 'playkit-ui';
 const EventType: {[event: string]: string} = {
   UI_CLICKED: `${namespace}-uiclicked`,
   UI_VISIBILITY_CHANGED: `${namespace}-uivisibilitychanged`,
+  UI_PRESET_CHANGE: `${namespace}-uipresetchange`,
   USER_CLICKED_PLAY: `${namespace}-userclickedplay`,
   USER_CLICKED_PAUSE: `${namespace}-userclickedpause`,
   USER_CLICKED_REWIND: `${namespace}-userclickedrewind`,

diff --git a/src/middlewares/event-dispatcher.js b/src/middlewares/event-dispatcher.js
@@ -77,6 +77,9 @@ function onChangeableComponentsHandler(store: any, action: Object, player: Objec
       player.dispatchEvent(new SeekedEvent(action.payload.from, action.payload.to));
       break;
 
+    case 'PlayerGui':
+      player.dispatchEvent(new FakeEvent(FakeEvent.Type.UI_PRESET_CHANGE, action.payload));
+      break;
     default:
       break;
   }

diff --git a/src/player-gui.js b/src/player-gui.js
@@ -4,6 +4,7 @@ import {connect} from 'preact-redux';
 import {bindActions} from './utils';
 import {actions} from './reducers/shell';
 import getLogger from './utils/logger';
+import {withEventDispatcher} from 'components/event-dispatcher';
 
 /**
  * mapping state to props
@@ -26,11 +27,14 @@ const mapStateToProps = state => ({
 });
 
 const logger = getLogger('PlayerGUI');
+const COMPONENT_NAME = 'PlayerGui';
 
 @connect(
   mapStateToProps,
   bindActions(actions)
 )
+@withEventDispatcher(COMPONENT_NAME)
+
 /**
  * Player GUI component
  *
@@ -74,6 +78,7 @@ class PlayerGUI extends Component {
       const presetName = uiComponent ? uiComponent.nodeName.displayName || '' : '';
 
       if (activePresetName !== presetName) {
+        props.notifyChange({from: activePresetName, to: presetName});
         props.updateActivePresetName(presetName);
         logger.debug(`set active preset '${presetName}'`);
       }