@byomakase/omakase-react-components 1.2.2 → 1.3.0-SNAPSHOT.1772555046

package/dist/index.es.d.ts

@@ -1,15 +1,27 @@
+import { AudioApi } from '@byomakase/omakase-player';
+import { AuthenticationData } from '@byomakase/omakase-player/dist/common/authentication';
+import { ChromingApi } from '@byomakase/omakase-player';
 import { ConfigWithOptionalStyle } from '@byomakase/omakase-player';
 import { convertFlowIdToSubtitlesId } from '../../../../shared/util/tams-util';
 import { default as default_2 } from 'react';
 import { LabelLaneConfig } from '@byomakase/omakase-player';
+import { Manifest } from '../../../plugins/virtual-manifest/src';
 import { Marker } from '@byomakase/omakase-player';
 import { MarkerLane } from '@byomakase/omakase-player';
 import { MarkerLaneConfig } from '@byomakase/omakase-player';
 import { MarkerListApi } from '@byomakase/omakase-player';
-import { MarkerListConfig } from '@byomakase/omakase-player/dist/marker-list/marker-list';
+import { MarkerListConfig } from '@byomakase/omakase-player';
+import { MarkerListConfig as MarkerListConfig_2 } from '@byomakase/omakase-player/dist/marker-list/marker-list';
+import { Observable } from 'rxjs';
 import { OmakasePlayer } from '@byomakase/omakase-player';
+import { OmakasePlayerApi } from '@byomakase/omakase-player';
 import { OmakasePlayerConfig } from '@byomakase/omakase-player';
 import { PeriodMarkerStyle } from '@byomakase/omakase-player';
+import { resolveAudioManifestName } from '../../../../shared/util/tams-util';
+import { resolveTextManifestName } from '../../../../shared/util/tams-util';
+import { RouterVisualizationApi } from '@byomakase/omakase-player';
+import { RouterVisualizationConfig } from '@byomakase/omakase-player/dist/router-visualization/router-visualization';
+import { SubtitlesApi } from '@byomakase/omakase-player';
 import { SubtitlesLaneConfig } from '@byomakase/omakase-player';
 import { TextLabelStyle } from '@byomakase/omakase-player';
 import { ThumbnailLaneConfig } from '@byomakase/omakase-player';
@@ -22,6 +34,10 @@ import { TimelineLaneStyle } from '@byomakase/omakase-player';
 import { TimelineNode } from '@byomakase/omakase-player';
 import { TimeRangeUtil } from '../../../../shared/util/time-range-util';
 import { Video } from '@byomakase/omakase-player';
+import { Video as Video_2 } from '@byomakase/omakase-player/dist/video/model';
+import { VideoApi } from '@byomakase/omakase-player';
+import { VideoLoadedEvent } from '@byomakase/omakase-player';
+import { VideoLoadingEvent } from '@byomakase/omakase-player';
 import { VideoLoadOptions } from '@byomakase/omakase-player';
 
 /**
@@ -732,6 +748,8 @@ export declare interface FlowStoragePost {
     limit?: number;
 }
 
+export declare function gatherAndExportToManifest(flow: Flow, subflows?: Flow[], flowsSegments?: Map<string, FlowSegment[]>): Manifest;
+
 /**
  * Time-addressable Media Store
  *
@@ -1050,8 +1068,8 @@ declare type NodeConstructionData = {
 export declare const OmakaseMarkerListComponent: default_2.MemoExoticComponent<({ omakasePlayer, config, onCreateMarkerListCallback, }: OmakaseMarkerListComponentProps) => default_2.JSX.Element>;
 
 declare type OmakaseMarkerListComponentProps = {
-    omakasePlayer: OmakasePlayer;
-    config: MarkerListConfig;
+    omakasePlayer: OmakasePlayerApi;
+    config: MarkerListConfig_2;
     onCreateMarkerListCallback?: (markerListApi: MarkerListApi) => void;
 };
 
@@ -1070,7 +1088,7 @@ export declare class OmakasePlayerTimelineBuilder {
     private _lanes;
     private _markersLaneMap;
     private _laneNodenMap;
-    constructor(omakasePlayer: OmakasePlayer);
+    constructor(omakasePlayer: OmakasePlayerApi);
     addMarkerLane(config: TimelineLaneConfigDefaultsExcluded<MarkerLaneConfig>): void;
     addMarkers(markerLaneId: string, markers: Marker[]): void;
     addTimelineNode(laneId: string, nodeConstructionData: NodeConstructionData): void;
@@ -1085,7 +1103,7 @@ export declare class OmakasePlayerTimelineBuilder {
 export declare const OmakasePlayerTimelineComponent: default_2.MemoExoticComponent<({ omakasePlayer, onTimelineCreatedCallback, timelineConfig, enableHotKeys, }: OmakasePlayerTimelineComponentProps) => default_2.JSX.Element>;
 
 declare interface OmakasePlayerTimelineComponentProps {
-    omakasePlayer: OmakasePlayer;
+    omakasePlayer: OmakasePlayerApi;
     onTimelineCreatedCallback: (timeline: TimelineApi) => void;
     timelineConfig: Partial<ConfigWithOptionalStyle<TimelineConfig>>;
     enableHotKeys?: boolean;
@@ -1106,7 +1124,7 @@ declare type OmakasePlayerTimelineControlsToolbarConstants = {
 
 declare type OmakasePlayerTimelineControlsToolbarProps = {
     selectedMarker: Marker | undefined;
-    omakasePlayer: OmakasePlayer;
+    omakasePlayer: OmakasePlayerApi;
     markerListApi?: MarkerListApi;
     segmentationLanes: MarkerLane[];
     source: MarkerLane | undefined;
@@ -1118,17 +1136,40 @@ declare type OmakasePlayerTimelineControlsToolbarProps = {
     onMarkerClickCallback: (marker: Marker | undefined) => void;
 };
 
+export declare class OmakaseTamsPlayer implements OmakasePlayerApi {
+    private _player;
+    private _videoApiProxy;
+    private _authenticationData?;
+    private _tamsEndpoint?;
+    constructor(config?: Partial<OmakasePlayerConfig>);
+    loadVideo(videoSource: string | TamsMediaData | string[], options?: TamsVideoLoadOptions): Observable<TamsVideo | Video_2>;
+    private _loadTamsMedia;
+    createTimeline(config: Partial<ConfigWithOptionalStyle<TimelineConfig>>): Observable<TimelineApi>;
+    createMarkerList(config: MarkerListConfig): Observable<MarkerListApi>;
+    initializeRouterVisualization(config: RouterVisualizationConfig): RouterVisualizationApi;
+    setAuthentication(authentication: AuthenticationData): void;
+    get timeline(): TimelineApi | undefined;
+    get audio(): AudioApi;
+    get subtitles(): SubtitlesApi;
+    get config(): OmakasePlayerConfig;
+    set config(config: OmakasePlayerConfig);
+    get chroming(): ChromingApi;
+    destroy(): void;
+    get video(): TamsVideoApi;
+    setTamsEndpoint(endpoint: string): void;
+}
+
 export declare const OmakaseTamsPlayerComponent: default_2.NamedExoticComponent<OmakaseTamsPlayerComponentProps>;
 
 declare type OmakaseTamsPlayerComponentProps = {
     flow: Flow;
-    childFlows: Flow[];
+    subflows: Flow[];
     flowsSegments: Map<string, FlowSegment[]>;
-    onVideoLoadedCallback?: (omakasePlayer: OmakasePlayer, video: Video, mediaInfo: MediaInfo) => void;
+    onVideoLoadedCallback?: (omakasePlayer: OmakasePlayerApi, video: TamsVideo) => void;
     config: Partial<OmakasePlayerConfig>;
     timerange: string;
     videoLoadOptions?: VideoLoadOptions;
-    enableHotkey?: boolean;
+    enableHotkeys?: boolean;
 };
 
 export declare const OmakaseTimeRangePicker: ({ timeRange, maxTimeRange, numberOfSegments, segmentSize, maxSliderRange, onCheckmarkClickCallback, }: OmakaseTimerangePickerProps) => default_2.JSX.Element;
@@ -1244,6 +1285,14 @@ export declare interface RegisterWebhook1 {
     accept_get_urls?: Array<string>;
 }
 
+export declare function removeGapsInSegments(segments?: FlowSegment[]): FlowSegment[] | undefined;
+
+export declare function removeGapsInSegmentsByExtending(segments?: FlowSegment[]): FlowSegment[] | undefined;
+
+export { resolveAudioManifestName }
+
+export { resolveTextManifestName }
+
 /**
  * Provides information about the store service
  */
@@ -1363,6 +1412,42 @@ export declare namespace Source {
     };
 }
 
+declare type TamsMediaData = {
+    flow: Flow;
+    subflows?: Flow[];
+    flowsSegments: Map<string, FlowSegment[]>;
+};
+
+export declare interface TamsVideo extends Video {
+    mediaStartTime: number;
+    thumbnailVttTrackUrl?: string;
+    tamsMediaData?: Partial<TamsMediaData>;
+    videoUrls?: Map<string, string>;
+    audioUrls?: Map<string, string>;
+    textUrls?: Map<string, string>;
+}
+
+export declare interface TamsVideoApi extends VideoApi {
+    getVideo: () => TamsVideo | undefined;
+    isTamsLoaded: () => boolean;
+}
+
+export declare interface TamsVideoLoadedEvent extends VideoLoadedEvent {
+    isTamsLoaded?: boolean;
+    video: Video | TamsVideo;
+}
+
+export declare interface TamsVideoLoadingEvent extends VideoLoadingEvent {
+    isTamsLoading?: boolean;
+}
+
+export declare interface TamsVideoLoadOptions extends VideoLoadOptions {
+    timerange?: string | undefined;
+    duration?: number | undefined;
+    returnTamsMediaData?: boolean;
+    ffomTimeZoneOffset?: number;
+}
+
 export { TimecodeUtil }
 
 export { TimeRangeUtil }
@@ -1453,6 +1538,30 @@ export declare interface UpdateServiceInfo {
     description?: string;
 }
 
+export declare function validateTamsPayload(flow: Flow, subflows?: Flow[], flowsSegments?: Map<string, FlowSegment[]>): {
+    valid: boolean;
+    message?: string;
+};
+
+export declare class VideoApiProxy {
+    private _player;
+    private _proxy;
+    private _mediaStartTime?;
+    private _loadOptions?;
+    private _onVideoLoaded$;
+    private _onVideoLoading$;
+    private _isTamsLoading;
+    private _lastVideoLoadedEvent$?;
+    private _tamsVideo?;
+    constructor(omakasePlayer: OmakasePlayer);
+    get proxy(): TamsVideoApi;
+    get mediaStartTime(): number | undefined;
+    get loadOptions(): TamsVideoLoadOptions | undefined;
+    set loadOptions(loadOptions: TamsVideoLoadOptions | undefined);
+    set mediaStartTime(mediaStartTime: number | undefined);
+    emitVideoLoadedEvent(tamsVideo: TamsVideo): void;
+}
+
 /**
  * Describes a video Flow
  */