@byomakase/omakase-player 0.0.2 → 0.1.2

package/dist/api/audio-api.d.ts

@@ -17,8 +17,21 @@ import { Api } from "./api";
 import { Observable } from "rxjs";
 import { AudioEvent } from "../types";
 export interface AudioApi extends Api {
+    /***
+     *  Fires on audio track switched
+     */
     onAudioSwitched$: Observable<AudioEvent>;
+    /***
+     * Returns available audio tracks
+     */
     getAudioTracks(): any[];
+    /***
+     * Returns current active audio tracks
+     */
     getCurrentAudioTrack(): any;
+    /***
+     * Sets active audio track
+     * @param audioTrackId Audio track ID
+     */
     setAudioTrack(audioTrackId: number): any;
 }

package/dist/api/marker-lane-api.d.ts

@@ -20,14 +20,50 @@ import { PeriodMarker, PeriodMarkerConfig } from "../timeline/marker/period-mark
 import { Subject } from "rxjs";
 import { MarkerFocusEvent } from "../types";
 export interface MarkerLaneApi extends Api {
+    /***
+     *  Fires on marker focus
+     */
     onMarkerFocus$: Subject<MarkerFocusEvent>;
+    /***
+     * Creates new MomentMarker instance and adds it to MarkerLane
+     * @param config MomentMarker configuration
+     */
     createMomentMarker(config: MomentMarkerConfig): MomentMarker;
+    /***
+     * Creates new PeriodMarker instance and adds it to MarkerLane
+     * @param config PeriodMarkern configuration
+     */
     createPeriodMarker(config: PeriodMarkerConfig): PeriodMarker;
+    /***
+     * Adds Marker to MarkerLane
+     * @param marker Marker instance
+     */
     addMarker(marker: GenericMarker): GenericMarker;
+    /***
+     * Returns Marker by ID
+     * @param id Marker ID
+     */
     getMarker(id: string): GenericMarker;
+    /***
+     * Returns all Marker's
+     */
     getMarkers(): GenericMarker[];
+    /***
+     * Removes Marker by ID
+     * @param id Marker ID
+     */
     removeMarker(id: string): void;
+    /***
+     * Removes all Marker's
+     */
     removeAllMarkers(): void;
+    /***
+     * Focuses Marker by ID
+     * @param id Marker ID
+     */
     focusMarker(id: string): void;
+    /***
+     * Returns Marker in focus
+     */
     getMarkerInFocus(): GenericMarker;
 }

package/dist/api/omakase-player-api.d.ts

@@ -26,13 +26,52 @@ import { TimelineApi } from "./timeline-api";
 import { OmakasePlayerStyle } from "../omakase-player";
 import { ComponentConfigStyleComposed } from "../common/component";
 export interface OmakasePlayerApi extends Api, OmakaseEventEmitter<OmakasePlayerEventMap> {
+    /***
+     * Loads new video
+     * @param videoSourceUrl Video manifest URL
+     * @param videoFrameRate Video frame rate
+     */
     loadVideo(videoSourceUrl: string, videoFrameRate: number): Observable<Video>;
+    /***
+     * Loads new video
+     *
+     * @param videoSourceUrl Video manifest URL
+     * @param videoFrameRate Video frame rate
+     * @param duration Video duration
+     */
+    loadVideo(videoSourceUrl: string, videoFrameRate: number, duration: number): Observable<Video>;
+    /***
+     * Creates Timeline
+     * @param config Timeline configuration
+     */
     createTimeline(config: Partial<ComponentConfigStyleComposed<TimelineConfig>>): Observable<Timeline>;
+    /***
+     * Returns OmakasePlayerStyle
+     */
     get style(): OmakasePlayerStyle;
+    /***
+     * Sets OmakasePlayerStyle
+     * @param value
+     */
     set style(value: Partial<OmakasePlayerStyle>);
+    /***
+     * Returns Timeline API
+     */
     get timeline(): TimelineApi;
+    /***
+     * Returns Video API
+     */
     get video(): VideoApi;
+    /***
+     * Returns Audio API
+     */
     get audio(): AudioApi;
+    /***
+     * Returns Subtitles API
+     */
     get subtitles(): SubtitlesApi;
+    /***
+     * Returns Omakase Player events enumeration
+     */
     get EVENTS(): OmakasePlayerEventsType;
 }

package/dist/api/subtitles-api.d.ts

@@ -1,5 +1,5 @@
 /**
- *       Copyright 2023 ByOmakase, LLC (https://byomaka se.org)
+ *       Copyright 2023 ByOmakase, LLC (https://byomakase.org)
  *
  *       Licensed under the Apache License, Version 2.0 (the "License");
  *       you may not use this file except in compliance with the License.
@@ -20,17 +20,60 @@ import { SubtitlesVttTrack } from "../track/subtitles-vtt-track";
 import { SubtitlesVttTrackConfig } from "../types/vtt";
 import { OmakaseTextTrack, OmakaseTextTrackCue } from "../types";
 export interface SubtitlesApi extends Api {
+    /***
+     * Fires on subtitles create
+     */
     onCreate$: Observable<SubtitlesEvent>;
+    /***
+     * Fires on subtitles remove
+     */
     onRemove$: Observable<SubtitlesEvent>;
+    /***
+     * Fires on subtitles show
+     */
     onShow$: Observable<SubtitlesEvent>;
+    /***
+     * Fires on subtitles hide
+     */
     onHide$: Observable<SubtitlesEvent>;
+    /***
+     * Creates new Subtitles VTT track
+     * @param config SubtitlesVttTrack configuration
+     */
     createVttTrack(config: SubtitlesVttTrackConfig): Observable<SubtitlesVttTrack>;
+    /***
+     * Returns all VTT tracks
+     */
     getTracks(): OmakaseTextTrack<OmakaseTextTrackCue>[];
+    /***
+     * Removes VTT track by ID
+     * @param id VTT track ID
+     */
     removeTrack(id: string): any;
+    /***
+     * Removes all VTT tracks
+     */
     removeAllTracks(): any;
+    /***
+     * Returns current active VTT track
+     */
     getCurrentTrack(): OmakaseTextTrack<OmakaseTextTrackCue> | undefined;
+    /***
+     * Shows active VTT track
+     */
     showTrack(): any;
+    /***
+     * Shows VTT track by ID
+     * @param id VTT track ID
+     */
     showTrack(id: string): any;
+    /***
+     * Hides active VTT track
+     */
     hideTrack(): any;
+    /***
+     * Hides VTT track by ID
+     * @param id VTT track ID
+     */
     hideTrack(id: string): any;
 }

package/dist/api/timeline-api.d.ts

@@ -25,7 +25,13 @@ import { SubtitlesLaneConfig } from "../timeline/subtitles/subtitles-lane";
 import { ScrubberLane } from "../timeline/scrubber-lane";
 import { Scrollbar } from "../timeline/scrollbar";
 export interface TimelineApi extends Api {
+    /***
+     *  Fires on Timeline scroll
+     */
     onScroll$: Observable<TimelineScrollEvent>;
+    /***
+     *  Fires on Timeline zoom
+     */
     onZoom$: Observable<TimelineZoomEvent>;
     get style(): TimelineStyle;
     /***
@@ -79,13 +85,48 @@ export interface TimelineApi extends Api {
      * @param id TimelineLane.id
      */
     getLane(id: string): GenericTimelaneLane;
+    /***
+     * Returns ScrubberLane instance
+     */
     getScrubberLane(): ScrubberLane;
+    /***
+     * Returns MarkerLane instance
+     * @param id MarkerLane ID
+     */
     getMarkerLane(id: string): MarkerLane;
+    /***
+     * Returns ThumbnailLane instance
+     * @param id ThumbnailLane ID
+     */
     getThumbnailLane(id: string): ThumbnailLane;
+    /***
+     * Returns SubtitlesLane instance
+     * @param id SubtitlesLane ID
+     */
     getSubtitlesLane(id: string): SubtitlesLane;
+    /***
+     * Returns AudioTrackLane instance
+     * @param id AudioTrackLane ID
+     */
     getAudioTrackLane(id: string): AudioTrackLane;
+    /***
+     * Creates new MarkerLane and adds it to Timeline
+     * @param config MarkerLane config
+     */
     createMarkerLane(config: MarkerLaneConfig): MarkerLane;
+    /***
+     * Creates new ThumbnailLane and adds it to Timeline
+     * @param config ThumbnailLane config
+     */
     createThumbnailLane(config: ThumbnailLaneConfig): ThumbnailLane;
+    /***
+     * Creates new SubtitlesLane and adds it to Timeline
+     * @param config SubtitlesLane config
+     */
     createSubtitlesLane(config: SubtitlesLaneConfig): SubtitlesLane;
+    /***
+     * Shows or hides Timeline left panel
+     * @param visible
+     */
     toggleLeftPanelVisible(visible: boolean): void;
 }

package/dist/api/video-api.d.ts

@@ -15,54 +15,198 @@
  */
 import { Api } from "./api";
 import { Observable } from "rxjs";
-import { AudioEvent, VideoEndedEvent, VideoLoadedEvent, VideoPlayEvent, VideoSeekedEvent, VideoSeekingEvent, VideoTimeChangeEvent } from "../types/events";
+import { AudioEvent, HelpMenuGroup, VideoEndedEvent, VideoErrorEvent, VideoLoadedEvent, VideoPlayEvent, VideoSeekedEvent, VideoSeekingEvent, VideoTimeChangeEvent } from "../types";
 import { Video } from "../video/video";
 import Hls from "hls.js";
-import { HelpMenuGroup } from "../types";
 export interface VideoApi extends Api {
+    /***
+     * Fires on video load
+     */
     onVideoLoaded$: Observable<VideoLoadedEvent>;
+    /***
+     * Fires on video time change
+     */
     onVideoTimeChange$: Observable<VideoTimeChangeEvent>;
+    /***
+     * Fires on video play
+     */
     onPlay$: Observable<VideoPlayEvent>;
+    /***
+     * Fires on video pause
+     */
     onPause$: Observable<VideoPlayEvent>;
+    /***
+     * Fires on video seeking
+     */
     onSeeking$: Observable<VideoSeekingEvent>;
+    /***
+     * Fires on video seeked
+     */
     onSeeked$: Observable<VideoSeekedEvent>;
+    /***
+     * Fires on video end
+     */
     onEnded$: Observable<VideoEndedEvent>;
+    /***
+     *  Fires on audio track switched
+     */
     onAudioSwitched$: Observable<AudioEvent>;
-    loadVideo(sourceUrl: string, frameRate: number, duration?: number): Observable<Video>;
+    /***
+     *  Fires on if error occurs on video load
+     */
+    onVideoError$: Observable<VideoErrorEvent>;
+    /***
+     * Indicates if video is loaded or not
+     */
     isVideoLoaded(): boolean;
+    /***
+     * Returns Video object that holds loaded video properties
+     */
     getVideo(): Video;
+    /***
+     * Returns HTML <video> element reference
+     */
     getHTMLVideoElement(): HTMLVideoElement;
+    /***
+     * Returns video duration. If duration is provided in omakasePlayer.loadVideo() method, method returns provided value. If duration is not provided in omakasePlayer.loadVideo() method, method returns HTML <video> element "duration" property
+     */
     getDuration(): number;
+    /***
+     * Returns video current time in seconds
+     */
     getCurrentTime(): number;
+    /***
+     * Returns video playback rate
+     */
     getPlaybackRate(): number;
+    /***
+     * Sets video playback rate
+     * @param playbackRate Decimal value between [0.1, 16]. For example, if provided value is "2", video playback rate will be 2x of normal playback rate
+     */
     setPlaybackRate(playbackRate: number): any;
+    /***
+     * Returns current volume level
+     */
     getVolume(): number;
+    /***
+     * Sets volume level
+     * @param volume Decimal value between [0, 1]
+     */
     setVolume(volume: number): any;
+    /***
+     * Returns current frame number
+     */
     getCurrentFrame(): number;
+    /***
+     * Returns video frame rate provided in omakasePlayer.loadVideo() method
+     */
     getFrameRate(): number;
+    /***
+     * Returns total number of frames in video
+     */
     getTotalFrames(): number;
+    /***
+     * Indicates if video is playing
+     */
     isPlaying(): boolean;
+    /***
+     * Indicates if video is paused
+     */
     isPaused(): boolean;
+    /***
+     * Indicates if video is seeking
+     */
     isSeeking(): boolean;
+    /***
+     * Starts video playback
+     */
     play(): void;
+    /***
+     * Pauses video playback
+     */
     pause(): void;
+    /***
+     * Toggles video play and pause
+     */
     togglePlayPause(): void;
+    /***
+     * Seeks to particular video frame. Video must be in non-playing mode.
+     * @param frame Video frame number
+     */
     seekToFrame(frame: number): Observable<boolean>;
+    /***
+     * Seeks to video frame offsetted by provided framesCount. Video must be in non-playing mode.
+     * @param framesCount Positive (seek forward) or negative (seek backward) integer
+     */
     seekFromCurrentFrame(framesCount: number): Observable<boolean>;
+    /***
+     * Seeks to previous video frame
+     */
     seekPreviousFrame(): Observable<boolean>;
+    /***
+     * Seeks to next video frame
+     */
     seekNextFrame(): Observable<boolean>;
-    seekToTimestamp(currentTime: number): Observable<boolean>;
-    formatTimestamp(currentTime: number): string;
+    /***
+     * Seeks to video timestamp
+     * @param time Video timestamp in seconds
+     */
+    seekToTimestamp(time: number): Observable<boolean>;
+    /***
+     * Formats video timestamp to HH:MM:SS:FF
+     * @param time Video timestamp in seconds
+     */
+    formatTimestamp(time: number): string;
+    /***
+     * Returns video frame number
+     * @param time Video timestamp in seconds
+     */
     calculateTimeToFrame(time: number): number;
+    /***
+     * Returns video timestamp in seconds
+     * @param framesCount Video frame number
+     */
     calculateFrameToTime(framesCount: number): number;
+    /***
+     * Video mute
+     */
     mute(): any;
+    /***
+     * Video unmute
+     */
     unmute(): any;
+    /***
+     * Indicates if video is in fullscreen mode
+     */
     isFullscreen(): boolean;
+    /***
+     * Toggles video fullscreen mode
+     */
     toggleFullscreen(): any;
+    /***
+     * Returns available audio tracks
+     */
     getAudioTracks(): any[];
+    /***
+     * Returns current active audio tracks
+     */
     getCurrentAudioTrack(): any;
+    /***
+     * Sets active audio track
+     * @param audioTrackId Audio track ID
+     */
     setAudioTrack(audioTrackId: number): any;
+    /***
+     * Returns Hls (hls.js) instance
+     */
     getHls(): Hls;
+    /***
+     * Adds new HelpMenuGroup to video context menu
+     * @param helpMenuGroup
+     */
     addHelpMenuGroup(helpMenuGroup: HelpMenuGroup): any;
+    /***
+     * Returns available HelpMenuGroup's
+     */
     getHelpMenuGroups(): HelpMenuGroup[];
 }

package/dist/dom/dom-controller.d.ts

@@ -31,10 +31,12 @@ export declare class DomController {
     private divButtonPlay;
     private divButtonPause;
     private divButtonLoading;
+    private divButtonError;
     private divButtonReplay;
     private divButtonHelp;
     private divHelp;
     private divHelpMenu;
+    private divErrorMessage;
     private _timeline;
     constructor(playerHTMLElementId: string);
     private createDom;