bitmovin-player-react-native 0.44.1-alpha.0 → 1.0.0-alpha.0

package/src/components/PlayerView/events.ts

@@ -67,318 +67,316 @@ import {
 } from '../../events';
 
 /**
- * Type that defines all event props supported by `PlayerView` and `NativePlayerView`.
- * Used to generate the specific events interface for each component.
+ * Event props for `PlayerView`.
+ *
+ * Note the events of `PlayerView` are simply a proxy over
+ * the events from `NativePlayerView` just removing RN's bubbling data.
  */
-interface EventProps {
+export type PlayerViewEvents = {
   /**
    * Event emitted when an ad break has finished.
    */
-  onAdBreakFinished: AdBreakFinishedEvent;
+  onAdBreakFinished?: (event: AdBreakFinishedEvent) => void;
   /**
    * Event emitted when an ad break has started.
    */
-  onAdBreakStarted: AdBreakStartedEvent;
+  onAdBreakStarted?: (event: AdBreakStartedEvent) => void;
   /**
    * Event emitted when an ad has been clicked.
    */
-  onAdClicked: AdClickedEvent;
+  onAdClicked?: (event: AdClickedEvent) => void;
   /**
    * Event emitted when an ad error has occurred.
    */
-  onAdError: AdErrorEvent;
+  onAdError?: (event: AdErrorEvent) => void;
   /**
    * Event emitted when an ad has finished.
    */
-  onAdFinished: AdFinishedEvent;
+  onAdFinished?: (event: AdFinishedEvent) => void;
   /**
    * Event emitted when an ad manifest starts loading.
    */
-  onAdManifestLoad: AdManifestLoadEvent;
+  onAdManifestLoad?: (event: AdManifestLoadEvent) => void;
   /**
    * Event emitted when an ad manifest has been loaded.
    */
-  onAdManifestLoaded: AdManifestLoadedEvent;
+  onAdManifestLoaded?: (event: AdManifestLoadedEvent) => void;
   /**
    * Event emitted when an ad quartile has been reached.
    */
-  onAdQuartile: AdQuartileEvent;
+  onAdQuartile?: (event: AdQuartileEvent) => void;
   /**
    * Event emitted when an ad has been scheduled.
    */
-  onAdScheduled: AdScheduledEvent;
+  onAdScheduled?: (event: AdScheduledEvent) => void;
   /**
    * Event emitted when an ad has been skipped.
    */
-  onAdSkipped: AdSkippedEvent;
+  onAdSkipped?: (event: AdSkippedEvent) => void;
   /**
    * Event emitted when an ad has started.
    */
-  onAdStarted: AdStartedEvent;
+  onAdStarted?: (event: AdStartedEvent) => void;
   /**
    * Event emitted when casting to a cast-compatible device is available.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
-  onCastAvailable: CastAvailableEvent;
+  onCastAvailable?: (event: CastAvailableEvent) => void;
   /**
    * Event emitted when the playback on a cast-compatible device was paused.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
-  onCastPaused: CastPausedEvent;
+  onCastPaused?: (event: CastPausedEvent) => void;
   /**
    * Event emitted when the playback on a cast-compatible device has finished.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
-  onCastPlaybackFinished: CastPlaybackFinishedEvent;
+  onCastPlaybackFinished?: (event: CastPlaybackFinishedEvent) => void;
   /**
    * Event emitted when playback on a cast-compatible device has started.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
-  onCastPlaying: CastPlayingEvent;
+  onCastPlaying?: (event: CastPlayingEvent) => void;
   /**
    * Event emitted when the cast app is launched successfully.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
-  onCastStarted: CastStartedEvent;
+  onCastStarted?: (event: CastStartedEvent) => void;
   /**
    * Event emitted when casting is initiated, but the user still needs to choose which device should be used.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
-  onCastStart: CastStartEvent;
+  onCastStart?: (event: CastStartEvent) => void;
   /**
    * Event emitted when casting to a cast-compatible device is stopped.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
-  onCastStopped: CastStoppedEvent;
+  onCastStopped?: (event: CastStoppedEvent) => void;
   /**
    * Event emitted when the time update from the currently used cast-compatible device is received.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
-  onCastTimeUpdated: CastTimeUpdatedEvent;
+  onCastTimeUpdated?: (event: CastTimeUpdatedEvent) => void;
   /**
    * Event emitted when a cast-compatible device has been chosen and the player is waiting for the device to get ready for
    * playback.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
-  onCastWaitingForDevice: CastWaitingForDeviceEvent;
+  onCastWaitingForDevice?: (event: CastWaitingForDeviceEvent) => void;
   /**
    * Event emitted when a subtitle entry transitions into the active status.
    */
-  onCueEnter: CueEnterEvent;
+  onCueEnter?: (event: CueEnterEvent) => void;
   /**
    * Event emitted when an active subtitle entry transitions into the inactive status.
    */
-  onCueExit: CueExitEvent;
+  onCueExit?: (event: CueExitEvent) => void;
   /**
    * Event emitted when the player is destroyed.
    */
-  onDestroy: DestroyEvent;
+  onDestroy?: (event: DestroyEvent) => void;
   /**
    * Emitted when a download was finished.
    */
-  onDownloadFinished: DownloadFinishedEvent;
+  onDownloadFinished?: (event: DownloadFinishedEvent) => void;
   /**
    * All events emitted by the player.
    */
-  onEvent: Event;
+  onEvent?: (event: Event) => void;
   /**
    * Event emitted when fullscreen mode has been enabled.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
-  onFullscreenEnabled: FullscreenEnabledEvent;
+  onFullscreenEnabled?: (event: FullscreenEnabledEvent) => void;
   /**
    * Event emitted when fullscreen mode has been disabled.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
-  onFullscreenDisabled: FullscreenDisabledEvent;
+  onFullscreenDisabled?: (event: FullscreenDisabledEvent) => void;
   /**
    * Event emitted when fullscreen mode has been entered.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
-  onFullscreenEnter: FullscreenEnterEvent;
+  onFullscreenEnter?: (event: FullscreenEnterEvent) => void;
   /**
    * Event emitted when fullscreen mode has been exited.
    *
-   * @platform iOS, Android
+   * @remarks Platform: iOS, Android
    */
-  onFullscreenExit: FullscreenExitEvent;
+  onFullscreenExit?: (event: FullscreenExitEvent) => void;
   /**
    * Event emitted when the player has been muted.
    */
-  onMuted: MutedEvent;
+  onMuted?: (event: MutedEvent) => void;
   /**
    * Event emitted when the player has been paused.
    */
-  onPaused: PausedEvent;
+  onPaused?: (event: PausedEvent) => void;
   /**
    * Event mitted when the availability of the Picture in Picture mode changed.
    */
-  onPictureInPictureAvailabilityChanged: PictureInPictureAvailabilityChangedEvent;
+  onPictureInPictureAvailabilityChanged?: (
+    event: PictureInPictureAvailabilityChangedEvent
+  ) => void;
   /**
    * Event emitted when the player enters Picture in Picture mode.
    */
-  onPictureInPictureEnter: PictureInPictureEnterEvent;
+  onPictureInPictureEnter?: (event: PictureInPictureEnterEvent) => void;
   /**
    * Event emitted when the player entered Picture in Picture mode.
    *
-   * @platform iOS
+   * @remarks Platform: iOS
    */
-  onPictureInPictureEntered: PictureInPictureEnteredEvent;
+  onPictureInPictureEntered?: (event: PictureInPictureEnteredEvent) => void;
   /**
    * Event emitted when the player exits Picture in Picture mode.
    */
-  onPictureInPictureExit: PictureInPictureExitEvent;
+  onPictureInPictureExit?: (event: PictureInPictureExitEvent) => void;
   /**
    * Event emitted when the player exited Picture in Picture mode.
    *
-   * @platform iOS
+   * @remarks Platform: iOS
    */
-  onPictureInPictureExited: PictureInPictureExitedEvent;
+  onPictureInPictureExited?: (event: PictureInPictureExitedEvent) => void;
   /**
    * Event emitted when the player received an intention to start/resume playback.
    */
-  onPlay: PlayEvent;
+  onPlay?: (event: PlayEvent) => void;
   /**
    * Event emitted when the playback of the current media has finished.
    */
-  onPlaybackFinished: PlaybackFinishedEvent;
+  onPlaybackFinished?: (event: PlaybackFinishedEvent) => void;
   /**
    * Emitted when the player transitions from one playback speed to another.
-   * @platform iOS, tvOS
+   * @remarks Platform: iOS, tvOS
    */
-  onPlaybackSpeedChanged: PlaybackSpeedChangedEvent;
+  onPlaybackSpeedChanged?: (event: PlaybackSpeedChangedEvent) => void;
   /**
    * Event emitted when a source is loaded into the player.
    * Seeking and time shifting are allowed as soon as this event is seen.
    */
-  onPlayerActive: PlayerActiveEvent;
+  onPlayerActive?: (event: PlayerActiveEvent) => void;
   /**
    * Event Emitted when a player error occurred.
    */
-  onPlayerError: PlayerErrorEvent;
+  onPlayerError?: (event: PlayerErrorEvent) => void;
   /**
    * Event emitted when a player warning occurred.
    */
-  onPlayerWarning: PlayerWarningEvent;
+  onPlayerWarning?: (event: PlayerWarningEvent) => void;
   /**
    * Emitted when playback has started.
    */
-  onPlaying: PlayingEvent;
+  onPlaying?: (event: PlayingEvent) => void;
   /**
    * Emitted when the player is ready for immediate playback, because initial audio/video
    * has been downloaded.
    */
-  onReady: ReadyEvent;
+  onReady?: (event: ReadyEvent) => void;
   /**
    * Event emitted when the player is about to seek to a new position.
    * Only applies to VoD streams.
    */
-  onSeek: SeekEvent;
+  onSeek?: (event: SeekEvent) => void;
   /**
    * Event emitted when seeking has finished and data to continue playback is available.
    * Only applies to VoD streams.
    */
-  onSeeked: SeekedEvent;
+  onSeeked?: (event: SeekedEvent) => void;
   /**
    * Event mitted when the player starts time shifting.
    * Only applies to live streams.
    */
-  onTimeShift: TimeShiftEvent;
+  onTimeShift?: (event: TimeShiftEvent) => void;
   /**
    * Event emitted when time shifting has finished and data is available to continue playback.
    * Only applies to live streams.
    */
-  onTimeShifted: TimeShiftedEvent;
+  onTimeShifted?: (event: TimeShiftedEvent) => void;
   /**
    * Event emitted when the player begins to stall and to buffer due to an empty buffer.
    */
-  onStallStarted: StallStartedEvent;
+  onStallStarted?: (event: StallStartedEvent) => void;
   /**
    * Event emitted when the player ends stalling, due to enough data in the buffer.
    */
-  onStallEnded: StallEndedEvent;
+  onStallEnded?: (event: StallEndedEvent) => void;
   /**
    * Event emitted when a source error occurred.
    */
-  onSourceError: SourceErrorEvent;
+  onSourceError?: (event: SourceErrorEvent) => void;
   /**
    * Event emitted when a new source loading has started.
    */
-  onSourceLoad: SourceLoadEvent;
+  onSourceLoad?: (event: SourceLoadEvent) => void;
   /**
    * Event emitted when a new source is loaded.
    * This does not mean that the source is immediately ready for playback.
    * `ReadyEvent` indicates the player is ready for immediate playback.
    */
-  onSourceLoaded: SourceLoadedEvent;
+  onSourceLoaded?: (event: SourceLoadedEvent) => void;
   /**
    * Event emitted when the current source has been unloaded.
    */
-  onSourceUnloaded: SourceUnloadedEvent;
+  onSourceUnloaded?: (event: SourceUnloadedEvent) => void;
   /**
    * Event emitted when a source warning occurred.
    */
-  onSourceWarning: SourceWarningEvent;
+  onSourceWarning?: (event: SourceWarningEvent) => void;
   /**
    * Event emitted when a new audio track is added to the player.
    */
-  onAudioAdded: AudioAddedEvent;
+  onAudioAdded?: (event: AudioAddedEvent) => void;
   /**
    * Event emitted when the player's selected audio track has changed.
    */
-  onAudioChanged: AudioChangedEvent;
+  onAudioChanged?: (event: AudioChangedEvent) => void;
   /**
    * Event emitted when an audio track is removed from the player.
    */
-  onAudioRemoved: AudioRemovedEvent;
+  onAudioRemoved?: (event: AudioRemovedEvent) => void;
   /**
    * Event emitted when a new subtitle track is added to the player.
    */
-  onSubtitleAdded: SubtitleAddedEvent;
+  onSubtitleAdded?: (event: SubtitleAddedEvent) => void;
   /**
    * Event emitted when the player's selected subtitle track has changed.
    */
-  onSubtitleChanged: SubtitleChangedEvent;
+  onSubtitleChanged?: (event: SubtitleChangedEvent) => void;
   /**
    * Event emitted when a subtitle track is removed from the player.
    */
-  onSubtitleRemoved: SubtitleRemovedEvent;
+  onSubtitleRemoved?: (event: SubtitleRemovedEvent) => void;
   /**
    * Event emitted when the current playback time has changed.
    */
-  onTimeChanged: TimeChangedEvent;
+  onTimeChanged?: (event: TimeChangedEvent) => void;
   /**
    * Emitted when the player is unmuted.
    */
-  onUnmuted: UnmutedEvent;
+  onUnmuted?: (event: UnmutedEvent) => void;
   /**
    * Emitted when current video download quality has changed.
    */
-  onVideoDownloadQualityChanged: VideoDownloadQualityChangedEvent;
+  onVideoDownloadQualityChanged?: (
+    event: VideoDownloadQualityChangedEvent
+  ) => void;
   /**
    * Emitted when the current video playback quality has changed.
    */
-  onVideoPlaybackQualityChanged: VideoPlaybackQualityChangedEvent;
-}
-
-/**
- * Event props for `PlayerView`.
- *
- * Note the events of `PlayerView` are simply a proxy over
- * the events from `NativePlayerView` just removing RN's bubbling data.
- */
-export type PlayerViewEvents = {
-  [Prop in keyof EventProps]?: (event: EventProps[Prop]) => void;
+  onVideoPlaybackQualityChanged?: (
+    event: VideoPlaybackQualityChangedEvent
+  ) => void;
 };