@vidispine/vdt-js 23.4.0-pre.2 → 23.4.0-pre.3

package/dist/index.d.ts

@@ -253,6 +253,12 @@ export declare interface FormatTimeCodeSecondsOptions extends TimeCodeInputOptio
      * e.g. `1.04 => 104@100 => 26@25` (if no explicit `timeBase` is set)
      */
     useGCD?: boolean;
+    /**
+     * Select if it should floor, round or ceil if conforming seconds to the supplied timebase
+     *
+     * @default `'floor'`
+     */
+    roundingMode?: 'floor' | 'ceil' | 'round';
 }
 
 /**
@@ -303,6 +309,27 @@ export declare interface FormatTimeCodeTextOptions extends TimeCodeInputOptions
  */
 export declare const formatTimeCodeType: (timeCode: TimeCodeInput, options?: TimeCodeInputOptions) => TimeCode;
 
+/**
+ * Filter a shape type list to get shapes that are playable in a browser
+ *
+ * The mime types "video/quicktime" & "video/x-m4v" are considered "video/mp4" if:
+ * 1. container format is "MPEG-4" or "mov"
+ * 2. video codec is "h264"
+ *
+ * @param itemType
+ * @param options
+ * @returns
+ *
+ * @category Shape
+ */
+export declare const getPlayerSources: (itemType: ItemType, options?: GetPlayerSourcesOptions) => PlayerSource[];
+
+export declare type GetPlayerSourcesOptions = {
+    allowedMimeTypes?: string[];
+    allowedMethods?: string[];
+    streamingServers?: string[];
+};
+
 /**
  * Return a const for the document type of a shape (looks at mimeType)
  *
@@ -1014,7 +1041,21 @@ export declare type ParseSearchResultEventsOptions = {
  *
  * @category Shape
  */
-export declare const parseShapeType: (shapeType?: ShapeType) => ParsedShapeType;
+export declare const parseShapeType: (shapeType?: ShapeType, options?: ParseShapeTypeOptions) => ParsedShapeType;
+
+declare type ParseShapeTypeOptions = {
+    /**
+     * Which component type to prioritize when merging and duplicate keys in components
+     *
+     * Default priority:
+     * 1. 'container'
+     * 2. 'video'
+     * 3. 'audio'
+     * 4. 'binary'
+     *
+     */
+    priority?: ('container' | 'video' | 'audio' | 'binary')[];
+};
 
 /**
  * Parse simple (key/value) metadata
@@ -1114,6 +1155,13 @@ export declare type ParseValueOptions = {
  */
 export declare const parseVideoComponent: (videoComponentType?: VideoComponentType) => ParsedVideoComponentType;
 
+export declare type PlayerSource = {
+    src: string;
+    type: string;
+    label: string;
+    timeBase: string;
+};
+
 /**
  * Const object with VidiCore role names
  *
@@ -1404,14 +1452,15 @@ export declare class TimeCode {
      * Creates a new TimeCode instance with specified timeBase and samples adjusted to that.
      *
      * @remarks
-     * If it conforms to a less granular time base - it will floor samples (hasn't reached that sample yet)
+     * It floors samples when conforming to a less granular time base (can be changed with `options.mode`)
+     *
      * - e.g. "51@50".conformTo("PAL") => "25@PAL" (not "26@PAL")
      *
      * @param timeBase The TimeBase it should conform the TimeCode to
-     * @param options Explicitly set TimeCode options, by default these are derived from `timeBase`
+     * @param options Explicitly set conform options, by default these are derived from `timeBase`
      * @returns A new TimeCode instance with the conformTo timeBase applied
      */
-    conformTimeBase(timeBase: TimeCodeInput['timeBase'], options?: TimeCodeInputOptions): TimeCode;
+    conformTimeBase(timeBase: TimeCodeInput['timeBase'], options?: TimeCodeConformOptions): TimeCode;
     /**
      * Get TimeCode as a text representation
      *
@@ -1464,7 +1513,7 @@ export declare class TimeCode {
      *
      * @returns Total seconds for the time code
      */
-    toSeconds(): number;
+    toSeconds(options?: TimeCodeToSecondsOptions): number;
     /**
      * Get TimeCode in a duration representation
      *
@@ -1514,11 +1563,19 @@ export declare class TimeCode {
     };
 }
 
+export declare interface TimeCodeConformOptions extends TimeCodeInputOptions {
+    /**
+     * Set if conforming should floor, round or ceil samples when converting to a less granular timebase
+     * @default `'floor'`
+     */
+    roundingMode?: 'floor' | 'ceil' | 'round';
+}
+
 export declare type TimeCodeInput = {
     /** Amount of samples for the time code */
     samples?: number | string;
     /** The time base for the time code */
-    timeBase?: string | TimeBaseInput | TimeBase;
+    timeBase?: string | number | TimeBaseInput | TimeBase;
 };
 
 export declare type TimeCodeInputOptions = {
@@ -1528,4 +1585,13 @@ export declare type TimeCodeInputOptions = {
     frameSeparator?: string;
 };
 
+declare type TimeCodeToSecondsOptions = {
+    /**
+     * Set true if seconds should be rounded with millisecond precision
+     *
+     * @default false
+     */
+    round?: boolean;
+};
+
 export { }