@byomakase/omakase-react-components 1.2.0-SNAPSHOT.1764842944 → 1.2.0

package/dist/index.es.d.ts

@@ -1,2 +1,1702 @@
-export * from './packages/react/omakase-react-components/src/index'
-export {}
+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 { 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 { OmakasePlayer } from '@byomakase/omakase-player';
+import { OmakasePlayerConfig } from '@byomakase/omakase-player';
+import { PeriodMarkerStyle } from '@byomakase/omakase-player';
+import { SubtitlesLaneConfig } from '@byomakase/omakase-player';
+import { TextLabelStyle } from '@byomakase/omakase-player';
+import { ThumbnailLaneConfig } from '@byomakase/omakase-player';
+import { TimecodeUtil } from '../../../../shared/util/timecode-util';
+import { TimelineApi } from '@byomakase/omakase-player';
+import { TimelineConfig } from '@byomakase/omakase-player';
+import { TimelineLaneComponentConfig } from '@byomakase/omakase-player/dist/timeline/timeline-lane';
+import { TimelineLaneConfigDefaultsExcluded } from '@byomakase/omakase-player/dist/timeline/timeline-lane';
+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 { VideoLoadOptions } from '@byomakase/omakase-player';
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare interface AudioCodecParameters {
+    /**
+     * The fixed number of samples per coded audio frame.
+     */
+    coded_frame_size?: number;
+    /**
+     * The MPEG-4 Object Type Identification. For more information on the use of this property in codec strings, see https://developer.mozilla.org/en-US/docs/Web/Media/Formats/codecs_parameter#mpeg-4_audio
+     */
+    mp4_oti?: number;
+}
+
+/**
+ * Describes an audio Flow
+ */
+export declare interface AudioFlow {
+    /**
+     * Flow identifier
+     */
+    id: string;
+    /**
+     * Source identifier
+     */
+    source_id: string;
+    /**
+     * Freeform string label for the flow
+     */
+    label?: string;
+    /**
+     * Freeform text describing the flow
+     */
+    description?: string;
+    /**
+     * A string identifier for the entity that created the flow. Implementations SHOULD set suitable default values for `created_by` based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.
+     */
+    created_by?: string;
+    /**
+     * A string identifier for the entity that updated the flow metadata most recently. Implementations SHOULD set suitable default values for `updated_by` based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.
+     */
+    updated_by?: string;
+    /**
+     * Key value is a freeform string.
+     */
+    tags?: {
+        [key: string]: string;
+    };
+    /**
+     * A change to the flow metadata, not including metadata_version, last_update or segments, results in a new version. If the metadata_version for flow instances is identical then the metadata is identical.
+     */
+    metadata_version?: string;
+    /**
+     * An indication of how many lossy encodings the flow content has been through. A flow with a higher generation may contain less of the original information than a flow with a lower generation.
+     */
+    generation?: number;
+    /**
+     * The date-time the flow was created in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    created?: string;
+    /**
+     * The date-time the flow metadata was updated in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    metadata_updated?: string;
+    /**
+     * The date-time the flow segments were updated in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    segments_updated?: string;
+    /**
+     * If set to \'true\', implementations SHOULD reject client requests to update Flow metadata (other than the read_only property), Flow Segments and media objects
+     */
+    read_only?: boolean;
+    /**
+     * A MIME type identification of the (lossy or lossless) coding used for the flow content.
+     */
+    codec?: string;
+    /**
+     * The container MIME type for flow segments.
+     */
+    container?: string;
+    /**
+     * The average bit rate of the flow segments in 1000 bits/second. A precise definition can be found in the [Setting Flow Bit Rate Properties](https://github.com/bbc/tams/blob/main/docs/appnotes/0013-setting-flow-bit-rate-properties.md) AppNote.
+     */
+    avg_bit_rate?: number;
+    /**
+     * The maximum bit rate of the flow segments in 1000 bits/second. A precise definition can be found in the [Setting Flow Bit Rate Properties](https://github.com/bbc/tams/blob/main/docs/appnotes/0013-setting-flow-bit-rate-properties.md) AppNote.
+     */
+    max_bit_rate?: number;
+    segment_duration?: FlowCoreSegmentDuration;
+    /**
+     * The timerange of samples available in the flow, as described by the [TimeRange](../schemas/timerange#top) type
+     */
+    timerange?: string;
+    /**
+     * List of Flows that are collected together by this Flow.
+     */
+    flow_collection?: Array<CollectionItem>;
+    /**
+     * Flows that reference this Flow to include it in a collection. This attribute is intended to be read-only. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    collected_by?: Array<string>;
+    container_mapping?: ContainerMapping1;
+    /**
+     * The primary content type URN for the flow.
+     */
+    format: AudioFlow.FormatEnum;
+    essence_parameters: AudioFlowEssenceParameters;
+}
+
+export declare namespace AudioFlow {
+    export type FormatEnum = 'urn:x-nmos:format:audio';
+    const FormatEnum: {
+        UrnxNmosformataudio: FormatEnum;
+    };
+}
+
+/**
+ * Describes the parameters of the essence inside this audio Flow
+ */
+export declare interface AudioFlowEssenceParameters {
+    /**
+     * The fixed number of samples per second.
+     */
+    sample_rate: number;
+    /**
+     * The channel count.
+     */
+    channels: number;
+    /**
+     * The number of significant bits used to represent the audio sample. The minumum number of bytes then equals `round_up(bit_depth / 8)`. If codec is `audio/x-raw-int` bit_depth must be set. If codec is `audio/x-raw-float` bit_depth must be set to 32 or 64
+     */
+    bit_depth?: number;
+    codec_parameters?: AudioCodecParameters;
+    unc_parameters?: UncompressedAudioParameters;
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare interface AVCCodecParameters {
+    /**
+     * AVC / H.264 profile byte. For more information on the use of this property in codec strings, see https://developer.mozilla.org/en-US/docs/Web/Media/Formats/codecs_parameter#using_the_codecs_parameter
+     */
+    profile: number;
+    /**
+     * AVC / H.264 level byte. For more information on the use of this property in codec strings, see https://developer.mozilla.org/en-US/docs/Web/Media/Formats/codecs_parameter#using_the_codecs_parameter
+     */
+    level: number;
+    /**
+     * AVC / H.264 flags byte. For more information on the use of this property in codec strings, see https://developer.mozilla.org/en-US/docs/Web/Media/Formats/codecs_parameter#using_the_codecs_parameter
+     */
+    flags: number;
+}
+
+/**
+ * Describes how an object (Source or Flow) is collected into another object of the same type
+ */
+export declare interface CollectionItem {
+    /**
+     * Source or Flow Identifier of the member of this collection. Sources must only collect Sources, and Flows must only collect Flows. Must already be registered in TAMS
+     */
+    id: string;
+    /**
+     * A human-readable role of the element in this collection (e.g. \'R\' to denote a right audio channel in a collection of mono audio Sources)
+     */
+    role: string;
+    container_mapping?: ContainerMapping;
+}
+
+/**
+ * Describes the mapping of the Flow essence from this Flow collection\'s container
+ */
+export declare interface ContainerMapping {
+    /**
+     * A zero-based and sequential track index in the container. This assumes a reliable ordering of tracks
+     */
+    track_index?: number;
+    /**
+     * A zero-based and sequential track index in the container for a particular Flow format. A container with a video and 2 audio tracks would have a format_track_index 0 for the video Flow and format_track_index 0 and 1 for the audio Flows. This assumes a reliable ordering of tracks for each Flow format
+     */
+    format_track_index?: number;
+    audio_track?: ContainerMappingAudioTrack;
+    mp2ts_container?: ContainerMappingMp2tsContainer;
+    mxf_container?: ContainerMappingMxfContainer;
+    isobmff_container?: ContainerMappingIsobmffContainer;
+}
+
+/**
+ * Describes the mapping of the Flow essence from the this Flow\'s container
+ */
+export declare interface ContainerMapping1 {
+    /**
+     * A zero-based and sequential track index in the container. This assumes a reliable ordering of tracks
+     */
+    track_index?: number;
+    /**
+     * A zero-based and sequential track index in the container for a particular Flow format. A container with a video and 2 audio tracks would have a format_track_index 0 for the video Flow and format_track_index 0 and 1 for the audio Flows. This assumes a reliable ordering of tracks for each Flow format
+     */
+    format_track_index?: number;
+    audio_track?: ContainerMappingAudioTrack;
+    mp2ts_container?: ContainerMappingMp2tsContainer;
+    mxf_container?: ContainerMappingMxfContainer;
+    isobmff_container?: ContainerMappingIsobmffContainer;
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Mapping for channels in audio tracks to the Flow channels
+ */
+export declare interface ContainerMappingAudioTrack {
+    /**
+     * Array of (zero-based) container channel numbers in Flow order
+     */
+    channel_numbers?: Array<number>;
+    /**
+     * Inclusive range of (zero-based) container channel numbers
+     */
+    channel_range?: string;
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Mapping to ISO Base Media File Format (e.g. MP4 and MOV) containers, ISO/IEC 14496-12
+ */
+export declare interface ContainerMappingIsobmffContainer {
+    /**
+     * The track ID
+     */
+    track_id?: number;
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Mapping to MPEG-2 Transport Stream containers, ISO/IEC 13818-1 or ITU-T Recommendation H.222.0
+ */
+export declare interface ContainerMappingMp2tsContainer {
+    /**
+     * The packet ID for the elementary stream packets
+     */
+    pid?: number;
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Mapping to Material Exchange Format containers, SMPTE ST 377-1
+ */
+export declare interface ContainerMappingMxfContainer {
+    /**
+     * The package UID. Either a SMPTE UMID URN or UUID URN
+     */
+    package_uid?: string;
+    /**
+     * The track ID in the package
+     */
+    track_id?: number;
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Identifies the content format for a flow or source using a URN string.
+ */
+export declare type Contentformat = 'urn:x-nmos:format:video' | 'urn:x-nmos:format:audio' | 'urn:x-nmos:format:data' | 'urn:x-nmos:format:multi';
+
+export declare const Contentformat: {
+    Video: Contentformat;
+    Audio: Contentformat;
+    Data: Contentformat;
+    Multi: Contentformat;
+};
+
+export { convertFlowIdToSubtitlesId }
+
+/**
+ * Describes a data Flow
+ */
+export declare interface DataFlow {
+    /**
+     * Flow identifier
+     */
+    id: string;
+    /**
+     * Source identifier
+     */
+    source_id: string;
+    /**
+     * Freeform string label for the flow
+     */
+    label?: string;
+    /**
+     * Freeform text describing the flow
+     */
+    description?: string;
+    /**
+     * A string identifier for the entity that created the flow. Implementations SHOULD set suitable default values for `created_by` based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.
+     */
+    created_by?: string;
+    /**
+     * A string identifier for the entity that updated the flow metadata most recently. Implementations SHOULD set suitable default values for `updated_by` based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.
+     */
+    updated_by?: string;
+    /**
+     * Key value is a freeform string.
+     */
+    tags?: {
+        [key: string]: string;
+    };
+    /**
+     * A change to the flow metadata, not including metadata_version, last_update or segments, results in a new version. If the metadata_version for flow instances is identical then the metadata is identical.
+     */
+    metadata_version?: string;
+    /**
+     * An indication of how many lossy encodings the flow content has been through. A flow with a higher generation may contain less of the original information than a flow with a lower generation.
+     */
+    generation?: number;
+    /**
+     * The date-time the flow was created in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    created?: string;
+    /**
+     * The date-time the flow metadata was updated in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    metadata_updated?: string;
+    /**
+     * The date-time the flow segments were updated in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    segments_updated?: string;
+    /**
+     * If set to \'true\', implementations SHOULD reject client requests to update Flow metadata (other than the read_only property), Flow Segments and media objects
+     */
+    read_only?: boolean;
+    /**
+     * A MIME type identification of the (lossy or lossless) coding used for the flow content.
+     */
+    codec?: string;
+    /**
+     * The container MIME type for flow segments.
+     */
+    container?: string;
+    /**
+     * The average bit rate of the flow segments in 1000 bits/second. A precise definition can be found in the [Setting Flow Bit Rate Properties](https://github.com/bbc/tams/blob/main/docs/appnotes/0013-setting-flow-bit-rate-properties.md) AppNote.
+     */
+    avg_bit_rate?: number;
+    /**
+     * The maximum bit rate of the flow segments in 1000 bits/second. A precise definition can be found in the [Setting Flow Bit Rate Properties](https://github.com/bbc/tams/blob/main/docs/appnotes/0013-setting-flow-bit-rate-properties.md) AppNote.
+     */
+    max_bit_rate?: number;
+    segment_duration?: FlowCoreSegmentDuration;
+    /**
+     * The timerange of samples available in the flow, as described by the [TimeRange](../schemas/timerange#top) type
+     */
+    timerange?: string;
+    /**
+     * List of Flows that are collected together by this Flow.
+     */
+    flow_collection?: Array<CollectionItem>;
+    /**
+     * Flows that reference this Flow to include it in a collection. This attribute is intended to be read-only. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    collected_by?: Array<string>;
+    container_mapping?: ContainerMapping1;
+    /**
+     * The primary content type URN for the flow.
+     */
+    format: DataFlow.FormatEnum;
+    essence_parameters: DataFlowEssenceParameters;
+}
+
+export declare namespace DataFlow {
+    export type FormatEnum = 'urn:x-nmos:format:data';
+    const FormatEnum: {
+        UrnxNmosformatdata: FormatEnum;
+    };
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Describes the parameters of the essence inside this data Flow
+ */
+export declare interface DataFlowEssenceParameters {
+    /**
+     * The type of information encoded in the flow, identified using a URN. e.g. The data_type may be urn:x-tams:data:bounding-box, and the codec `application/json`.
+     */
+    data_type?: string;
+}
+
+/**
+ * Describes an ongoing deletion request
+ */
+export declare interface DeletionRequest {
+    /**
+     * Deletion Request ID
+     */
+    id: string;
+    /**
+     * ID of the flow to which the deletion request relates
+     */
+    flow_id: string;
+    /**
+     * The timerange of FlowSegments to be deleted in this request, as described by the [TimeRange](../schemas/timerange#top) type
+     */
+    timerange_to_delete: string;
+    /**
+     * The timerange of FlowSegments not yet deleted by this request, as described by the [TimeRange](../schemas/timerange#top) type
+     */
+    timerange_remaining?: string;
+    /**
+     * Whether the Flow should be deleted once the timerange has been
+     */
+    delete_flow: boolean;
+    /**
+     * Date/Time when this deletion request was created
+     */
+    created?: string;
+    /**
+     * A string identifier for the entity that created the deletion request. Implementations SHOULD set suitable default values for `created_by` based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.
+     */
+    created_by?: string;
+    /**
+     * Date/Time when this deletion request was updated
+     */
+    updated?: string;
+    /**
+     * Date/Time when this deletion request will be deleted
+     */
+    expiry?: string;
+    /**
+     * Status of the delete request
+     */
+    status: DeletionRequest.StatusEnum;
+    error?: DeletionRequestError;
+}
+
+export declare namespace DeletionRequest {
+    export type StatusEnum = 'created' | 'started' | 'done' | 'error';
+    const StatusEnum: {
+        Created: StatusEnum;
+        Started: StatusEnum;
+        Done: StatusEnum;
+        Error: StatusEnum;
+    };
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Provides more information for the error status.
+ */
+export declare interface DeletionRequestError {
+    /**
+     * The error type name.
+     */
+    type: string;
+    /**
+     * Summary description of the error and causes.
+     */
+    summary: string;
+    /**
+     * Stack trace leading to error (as a list of strings)
+     */
+    traceback?: Array<string>;
+    /**
+     * Time at which the error ocurred, to aid in log correlation
+     */
+    time: string;
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Describes an event stream mechanism available in this implementation of TAMS
+ */
+export declare interface EventStreamMechanism {
+    /**
+     * Name of this type of event stream mechanism. Must be unique. Any name defined in this specification is reserved
+     */
+    name: string;
+    /**
+     * Location (e.g. a URL) at which documentation for this event stream mechanism may be found
+     */
+    docs?: string;
+    /**
+     * Configuration options required to make use of this mechanism
+     */
+    config?: object;
+}
+
+/**
+ * Describes a Flow
+ */
+/**
+ * @type Flow
+ * Describes a Flow
+ * @export
+ */
+export declare type Flow = AudioFlow | DataFlow | MultiEssenceFlow | VideoFlow | ImageFlow;
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The target flow segment duration in seconds. The duration for each segment may vary around this target value. See also the [Setting Flow Bit Rate Properties](https://github.com/bbc/tams/blob/main/docs/appnotes/0013-setting-flow-bit-rate-properties.md) AppNote for how this property can be used to calculate buffer sizes.
+ */
+export declare interface FlowCoreSegmentDuration {
+    /**
+     * numerator
+     */
+    numerator: number;
+    /**
+     * denominator
+     */
+    denominator?: number;
+}
+
+/**
+ * Provides the location and metadata of the media files corresponding to timerange segments of a Flow.
+ */
+export declare interface FlowSegment {
+    /**
+     * The object store identifier for the media object.
+     */
+    object_id: string;
+    /**
+     * The timestamp offset between the sample timestamps stored in the media file and the corresponding timestamp in the segment, ie. ts_offset = segment ts - media object ts. Assumed to be 0:0 if not set. Format as described by the [Timestamp](../schemas/timestamp#top) type, but cannot be negative
+     */
+    ts_offset?: string;
+    /**
+     * The timerange of segments that have been deleted. The timerange MUST intersect with a segment which has been deleted at both start and end (e.g. it cannot start or end in empty space).
+     */
+    timerange: string;
+    /**
+     * The difference between the exclusive end of the `timerange` and the last sample timestamp. Format as described by the [Timestamp](../schemas/timestamp#top) type, but cannot be negative
+     */
+    last_duration?: string;
+    /**
+     * The start of the segment represented as a count of samples from the start of the object. Note that a sample is a video frame or audio sample. A (coded) audio frame has multiple audio samples. Assumed to be 0 if not set.
+     */
+    sample_offset?: number;
+    /**
+     * The count of samples in the segment (which may be fewer than in the object). The count could be less than expected given the segment duration and rate if there are gaps. If not set, every sample from sample_offset onwards is used. Note that a sample is a video frame or audio sample. A (coded) audio frame has multiple audio samples
+     */
+    sample_count?: number;
+    /**
+     * A list of URLs to which a GET request can be made to directly retrieve the contents of the segment. This is required by the `http_object_store` media store type, which is the only one currently described. Clients may choose any URL in the list and treat them as identical, however servers may sort the list such that the preferred URL is first.
+     */
+    get_urls?: Array<FlowSegmentGetUrlsInner>;
+    /**
+     * The number of key frames in the segment. This should be set greater than zero when the segment contains key frames that serve as a stream access point
+     */
+    key_frame_count?: number;
+}
+
+/**
+ * Provides the location and metadata of the media files corresponding to timerange segments of a Flow.
+ */
+export declare interface FlowSegment1 {
+    /**
+     * The object store identifier for the media object.
+     */
+    object_id: string;
+    /**
+     * The timestamp offset between the sample timestamps stored in the media file and the corresponding timestamp in the segment, ie. ts_offset = segment ts - media object ts. Assumed to be 0:0 if not set. Format as described by the [Timestamp](../schemas/timestamp#top) type, but cannot be negative
+     */
+    ts_offset?: string;
+    /**
+     * The timerange for the samples contained in the segment. The timerange start is always inclusive. If samples have a duration then the timerange end is exclusive and covers at least the duration of the last sample. The exclusive timerange end will typically be set to the timestamp of the next sample. If the samples don\'t have a duration then the timerange end is inclusive. Format is described by the [TimeRange](../schemas/timerange#top) type. Note that where temporal re-ordering is used, the timerange and samples refers to the presentation timeline.
+     */
+    timerange: string;
+    /**
+     * The difference between the exclusive end of the `timerange` and the last sample timestamp. Format as described by the [Timestamp](../schemas/timestamp#top) type, but cannot be negative
+     */
+    last_duration?: string;
+    /**
+     * The start of the segment represented as a count of samples from the start of the object. Note that a sample is a video frame or audio sample. A (coded) audio frame has multiple audio samples. Assumed to be 0 if not set.
+     */
+    sample_offset?: number;
+    /**
+     * The count of samples in the segment (which may be fewer than in the object). The count could be less than expected given the segment duration and rate if there are gaps. If not set, every sample from sample_offset onwards is used. Note that a sample is a video frame or audio sample. A (coded) audio frame has multiple audio samples
+     */
+    sample_count?: number;
+    /**
+     * A list of URLs to which a GET request can be made to directly retrieve the contents of the segment. This is required by the `http_object_store` media store type, which is the only one currently described. Clients may choose any URL in the list and treat them as identical, however servers may sort the list such that the preferred URL is first.
+     */
+    get_urls?: Array<FlowSegmentGetUrlsInner>;
+    /**
+     * The number of key frames in the segment. This should be set greater than zero when the segment contains key frames that serve as a stream access point
+     */
+    key_frame_count?: number;
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare interface FlowSegmentGetUrlsInner {
+    /**
+     * Label identifying this URL. If the \'label\' is not set then this URL can\'t be filtered for using the \'accept_get_urls\' API query parameter.
+     */
+    label?: string;
+    /**
+     * A URL to which a GET request can be made to directly retrieve the contents of the segment. Clients should include credentials if the provide URL is on the same origin as the API endpoint
+     */
+    url: string;
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Post data for the flow storage endpoint
+ */
+export declare interface FlowStoragePost {
+    /**
+     * Limit the number of storage segments in each response page. Implementations may specify their own default and maximum for the limit
+     */
+    limit?: number;
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Gives information on a particular http request a client should perform
+ */
+export declare interface HTTPRequest {
+    /**
+     * The URL to make the request to
+     */
+    url: string;
+    /**
+     * The text of the body which needs to be included in the request
+     */
+    body?: string;
+    /**
+     * The content type which must be used
+     */
+    'content-type'?: string;
+    /**
+     * Additional headers that should be included
+     */
+    headers?: {
+        [key: string]: string;
+    };
+}
+
+/**
+ * Describes a image Flow
+ */
+export declare interface ImageFlow {
+    /**
+     * Flow identifier
+     */
+    id: string;
+    /**
+     * Source identifier
+     */
+    source_id: string;
+    /**
+     * Freeform string label for the flow
+     */
+    label?: string;
+    /**
+     * Freeform text describing the flow
+     */
+    description?: string;
+    /**
+     * A string identifier for the entity that created the flow. Implementations SHOULD set suitable default values for `created_by` based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.
+     */
+    created_by?: string;
+    /**
+     * A string identifier for the entity that updated the flow metadata most recently. Implementations SHOULD set suitable default values for `updated_by` based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.
+     */
+    updated_by?: string;
+    /**
+     * Key value is a freeform string.
+     */
+    tags?: {
+        [key: string]: string;
+    };
+    /**
+     * A change to the flow metadata, not including metadata_version, last_update or segments, results in a new version. If the metadata_version for flow instances is identical then the metadata is identical.
+     */
+    metadata_version?: string;
+    /**
+     * An indication of how many lossy encodings the flow content has been through. A flow with a higher generation may contain less of the original information than a flow with a lower generation.
+     */
+    generation?: number;
+    /**
+     * The date-time the flow was created in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    created?: string;
+    /**
+     * The date-time the flow metadata was updated in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    metadata_updated?: string;
+    /**
+     * The date-time the flow segments were updated in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    segments_updated?: string;
+    /**
+     * If set to \'true\', implementations SHOULD reject client requests to update Flow metadata (other than the read_only property), Flow Segments and media objects
+     */
+    read_only?: boolean;
+    /**
+     * A MIME type identification of the (lossy or lossless) coding used for the flow content.
+     */
+    codec?: string;
+    /**
+     * The container MIME type for flow segments.
+     */
+    container?: string;
+    /**
+     * The average bit rate of the flow segments in 1000 bits/second. A precise definition can be found in the [Setting Flow Bit Rate Properties](https://github.com/bbc/tams/blob/main/docs/appnotes/0013-setting-flow-bit-rate-properties.md) AppNote.
+     */
+    avg_bit_rate?: number;
+    /**
+     * The maximum bit rate of the flow segments in 1000 bits/second. A precise definition can be found in the [Setting Flow Bit Rate Properties](https://github.com/bbc/tams/blob/main/docs/appnotes/0013-setting-flow-bit-rate-properties.md) AppNote.
+     */
+    max_bit_rate?: number;
+    segment_duration?: FlowCoreSegmentDuration;
+    /**
+     * The timerange of samples available in the flow, as described by the [TimeRange](../schemas/timerange#top) type
+     */
+    timerange?: string;
+    /**
+     * List of Flows that are collected together by this Flow.
+     */
+    flow_collection?: Array<CollectionItem>;
+    /**
+     * Flows that reference this Flow to include it in a collection. This attribute is intended to be read-only. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    collected_by?: Array<string>;
+    container_mapping?: ContainerMapping1;
+    /**
+     * The primary content type URN for the flow.
+     */
+    format: ImageFlow.FormatEnum;
+    essence_parameters: ImageFlowEssenceParameters;
+}
+
+export declare namespace ImageFlow {
+    export type FormatEnum = "urn:x-tam:format:image";
+    const FormatEnum: {
+        UrnxNmosformatdata: FormatEnum;
+    };
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Describes the parameters of the essence inside this image Flow
+ */
+export declare interface ImageFlowEssenceParameters {
+    /**
+     * Parameters describing the essence of image Flow
+     */
+    frame_width: number;
+    frame_height: number;
+}
+
+/**
+ * Gives information on storage for media objects. This schema is for the `http_object_store` media store type which provides URLs for storing media objects in bucket, and is the only store type currently implemented.
+ */
+export declare interface MediaBucketObjectStore {
+    [key: string]: any | any;
+    /**
+     * Actions that need to be taken before the media object can be written
+     */
+    pre?: Array<MediaBucketObjectStorePreInner>;
+    /**
+     * List of information for identifying and uploading media objects
+     */
+    media_objects?: Array<MediaBucketObjectStoreMediaObjectsInner>;
+}
+
+/**
+ * Information for a media object
+ */
+export declare interface MediaBucketObjectStoreMediaObjectsInner {
+    /**
+     * The object store identifier for the media object.
+     */
+    object_id: string;
+    put_url: HTTPRequest;
+    put_cors_url?: HTTPRequest;
+}
+
+/**
+ * An action
+ */
+export declare interface MediaBucketObjectStorePreInner {
+    action: MediaBucketObjectStorePreInner.ActionEnum;
+    /**
+     * The name of the bucket that needs to be created
+     */
+    bucket_id?: string;
+    put_url?: HTTPRequest;
+    put_cors_url?: HTTPRequest;
+}
+
+export declare namespace MediaBucketObjectStorePreInner {
+    export type ActionEnum = 'create_bucket';
+    const ActionEnum: {
+        CreateBucket: ActionEnum;
+    };
+}
+
+export declare type MediaInfo = {
+    ffom: string | undefined;
+    mediaStartTime: number;
+    frameRate: number;
+    dropFrame: boolean;
+};
+
+/**
+ * Describes a multi-essence Flow
+ */
+export declare interface MultiEssenceFlow {
+    /**
+     * Flow identifier
+     */
+    id: string;
+    /**
+     * Source identifier
+     */
+    source_id: string;
+    /**
+     * Freeform string label for the flow
+     */
+    label?: string;
+    /**
+     * Freeform text describing the flow
+     */
+    description?: string;
+    /**
+     * A string identifier for the entity that created the flow. Implementations SHOULD set suitable default values for `created_by` based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.
+     */
+    created_by?: string;
+    /**
+     * A string identifier for the entity that updated the flow metadata most recently. Implementations SHOULD set suitable default values for `updated_by` based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.
+     */
+    updated_by?: string;
+    /**
+     * Key value is a freeform string.
+     */
+    tags?: {
+        [key: string]: string;
+    };
+    /**
+     * A change to the flow metadata, not including metadata_version, last_update or segments, results in a new version. If the metadata_version for flow instances is identical then the metadata is identical.
+     */
+    metadata_version?: string;
+    /**
+     * An indication of how many lossy encodings the flow content has been through. A flow with a higher generation may contain less of the original information than a flow with a lower generation.
+     */
+    generation?: number;
+    /**
+     * The date-time the flow was created in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    created?: string;
+    /**
+     * The date-time the flow metadata was updated in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    metadata_updated?: string;
+    /**
+     * The date-time the flow segments were updated in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    segments_updated?: string;
+    /**
+     * If set to \'true\', implementations SHOULD reject client requests to update Flow metadata (other than the read_only property), Flow Segments and media objects
+     */
+    read_only?: boolean;
+    /**
+     * A MIME type identification of the (lossy or lossless) coding used for the flow content.
+     */
+    codec?: string;
+    /**
+     * The container MIME type for flow segments.
+     */
+    container?: string;
+    /**
+     * The average bit rate of the flow segments in 1000 bits/second. A precise definition can be found in the [Setting Flow Bit Rate Properties](https://github.com/bbc/tams/blob/main/docs/appnotes/0013-setting-flow-bit-rate-properties.md) AppNote.
+     */
+    avg_bit_rate?: number;
+    /**
+     * The maximum bit rate of the flow segments in 1000 bits/second. A precise definition can be found in the [Setting Flow Bit Rate Properties](https://github.com/bbc/tams/blob/main/docs/appnotes/0013-setting-flow-bit-rate-properties.md) AppNote.
+     */
+    max_bit_rate?: number;
+    segment_duration?: FlowCoreSegmentDuration;
+    /**
+     * The timerange of samples available in the flow, as described by the [TimeRange](../schemas/timerange#top) type
+     */
+    timerange?: string;
+    /**
+     * List of Flows that are collected together by this Flow.
+     */
+    flow_collection?: Array<CollectionItem>;
+    /**
+     * Flows that reference this Flow to include it in a collection. This attribute is intended to be read-only. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    collected_by?: Array<string>;
+    container_mapping?: ContainerMapping1;
+    /**
+     * The primary content type URN for the flow.
+     */
+    format: MultiEssenceFlow.FormatEnum;
+}
+
+export declare namespace MultiEssenceFlow {
+    export type FormatEnum = 'urn:x-nmos:format:multi';
+    const FormatEnum: {
+        UrnxNmosformatmulti: FormatEnum;
+    };
+}
+
+declare type NodeConstructionData = {
+    config: TimelineLaneComponentConfig;
+    node: TimelineNode;
+};
+
+export declare const OmakaseMarkerListComponent: default_2.MemoExoticComponent<({ omakasePlayer, config, onCreateMarkerListCallback, }: OmakaseMarkerListComponentProps) => default_2.JSX.Element>;
+
+declare type OmakaseMarkerListComponentProps = {
+    omakasePlayer: OmakasePlayer;
+    config: MarkerListConfig;
+    onCreateMarkerListCallback?: (markerListApi: MarkerListApi) => void;
+};
+
+export declare const OmakasePlayerComponent: default_2.NamedExoticComponent<OmakasePlayerComponentProps>;
+
+declare type OmakasePlayerComponentProps = {
+    videoUrl: string;
+    videoLoadOptions?: VideoLoadOptions;
+    onVideoLoadedCallback?: (omakasePlayer: OmakasePlayer, video: Video) => void;
+    config: Partial<OmakasePlayerConfig>;
+    enableHotkeys?: boolean;
+};
+
+export declare class OmakasePlayerTimelineBuilder {
+    private omakasePlayer;
+    private _lanes;
+    private _markersLaneMap;
+    private _laneNodenMap;
+    constructor(omakasePlayer: OmakasePlayer);
+    addMarkerLane(config: TimelineLaneConfigDefaultsExcluded<MarkerLaneConfig>): void;
+    addMarkers(markerLaneId: string, markers: Marker[]): void;
+    addTimelineNode(laneId: string, nodeConstructionData: NodeConstructionData): void;
+    addThumbnailLane(config: TimelineLaneConfigDefaultsExcluded<ThumbnailLaneConfig>): void;
+    addLabelLane(config: TimelineLaneConfigDefaultsExcluded<LabelLaneConfig>): void;
+    addSubtitlesLane(config: TimelineLaneConfigDefaultsExcluded<SubtitlesLaneConfig>): void;
+    buildAndAttachTimeline(timelineConfig: Partial<ConfigWithOptionalStyle<TimelineConfig>>): void;
+    buildAttachedTimeline(timeline: TimelineApi): void;
+    private _createAndAttachLane;
+}
+
+export declare const OmakasePlayerTimelineComponent: default_2.MemoExoticComponent<({ omakasePlayer, onTimelineCreatedCallback, timelineConfig, enableHotKeys, }: OmakasePlayerTimelineComponentProps) => default_2.JSX.Element>;
+
+declare interface OmakasePlayerTimelineComponentProps {
+    omakasePlayer: OmakasePlayer;
+    onTimelineCreatedCallback: (timeline: TimelineApi) => void;
+    timelineConfig: Partial<ConfigWithOptionalStyle<TimelineConfig>>;
+    enableHotKeys?: boolean;
+}
+
+export declare const OmakasePlayerTimelineControlsToolbar: ({ selectedMarker, omakasePlayer, markerListApi, enableHotKeys, segmentationLanes, setSegmentationLanes, setSelectedMarker, onMarkerClickCallback, setSource, source, constants, }: OmakasePlayerTimelineControlsToolbarProps) => default_2.JSX.Element;
+
+declare type OmakasePlayerTimelineControlsToolbarConstants = {
+    HIGHLIGHTED_PERIOD_MARKER_STYLE: Partial<PeriodMarkerStyle> & {
+        color: string;
+    };
+    PERIOD_MARKER_STYLE: Partial<PeriodMarkerStyle> & {
+        color: string;
+    };
+    TIMELINE_LANE_STYLE: Partial<TimelineLaneStyle>;
+    MARKER_LANE_TEXT_LABEL_STYLE: Partial<TextLabelStyle>;
+};
+
+declare type OmakasePlayerTimelineControlsToolbarProps = {
+    selectedMarker: Marker | undefined;
+    omakasePlayer: OmakasePlayer;
+    markerListApi?: MarkerListApi;
+    segmentationLanes: MarkerLane[];
+    source: MarkerLane | undefined;
+    enableHotKeys?: boolean;
+    constants: OmakasePlayerTimelineControlsToolbarConstants;
+    setSource: default_2.Dispatch<default_2.SetStateAction<MarkerLane | undefined>>;
+    setSegmentationLanes: default_2.Dispatch<default_2.SetStateAction<MarkerLane[]>>;
+    setSelectedMarker: default_2.Dispatch<default_2.SetStateAction<Marker | undefined>>;
+    onMarkerClickCallback: (marker: Marker | undefined) => void;
+};
+
+export declare const OmakaseTamsPlayerComponent: default_2.NamedExoticComponent<OmakaseTamsPlayerComponentProps>;
+
+declare type OmakaseTamsPlayerComponentProps = {
+    flow: Flow;
+    childFlows: Flow[];
+    flowsSegments: Map<string, FlowSegment[]>;
+    onVideoLoadedCallback?: (omakasePlayer: OmakasePlayer, video: Video, mediaInfo: MediaInfo) => void;
+    config: Partial<OmakasePlayerConfig>;
+    timerange: string;
+    videoLoadOptions?: VideoLoadOptions;
+    enableHotkey?: boolean;
+};
+
+export declare const OmakaseTimeRangePicker: ({ timeRange, maxTimeRange, numberOfSegments, segmentSize, maxSliderRange, onCheckmarkClickCallback, }: OmakaseTimerangePickerProps) => default_2.JSX.Element;
+
+declare type OmakaseTimerangePickerProps = {
+    timeRange: string;
+    maxTimeRange: string;
+    numberOfSegments: number;
+    segmentSize: number;
+    maxSliderRange: number;
+    onCheckmarkClickCallback: (start: number, end: number) => void;
+};
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Register to receive updates via webhook
+ */
+export declare interface RegisterWebhook {
+    /**
+     * The URL to which the API should make HTTP POST requests with event data
+     */
+    url: string;
+    /**
+     * The HTTP header name that is added to the event POST
+     */
+    api_key_name?: string;
+    /**
+     * The value that the HTTP header \'api_key_name\' will be set to
+     */
+    api_key_value?: string;
+    /**
+     * List of event types to receive
+     */
+    events: Array<string>;
+    /**
+     * Limit Flow and Flow Segment events to Flows in the given list of Flow IDs
+     */
+    flow_ids?: Array<string>;
+    /**
+     * Limit Flow, Flow Segment and Source events to Sources in the given list of Source IDs
+     */
+    source_ids?: Array<string>;
+    /**
+     * Limit Flow and Flow Segment events to those with Flow that is collected by a Flow Collection in the given list of Flow Collection IDs
+     */
+    flow_collected_by_ids?: Array<string>;
+    /**
+     * Limit Flow, Flow Segment and Source events to those with Source that is collected by a Source Collection in the given list of Source Collection IDs
+     */
+    source_collected_by_ids?: Array<string>;
+    /**
+     * List of labels of URLs to include in the `get_urls` property in `flows/segments_added` events. This option is the same as the `accept_get_urls` query parameter for the /flows/{flowId}/segments API endpoint, except that the labels are represented using a JSON array rather than a (comma separated list) string.
+     */
+    accept_get_urls?: Array<string>;
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Register to receive updates via webhook
+ */
+export declare interface RegisterWebhook1 {
+    /**
+     * The URL to which the API should make HTTP POST requests with event data
+     */
+    url: string;
+    /**
+     * The HTTP header name that is added to the event POST with value \'api_key_value\'
+     */
+    api_key_name?: string;
+    /**
+     * The value that the HTTP header \'api_key_name\' will be set to
+     */
+    api_key_value?: string;
+    /**
+     * List of event types to receive
+     */
+    events: Array<string>;
+    /**
+     * Limit Flow and Flow Segment events to Flows in the given list of Flow IDs
+     */
+    flow_ids?: Array<string>;
+    /**
+     * Limit Flow, Flow Segment and Source events to Sources in the given list of Source IDs
+     */
+    source_ids?: Array<string>;
+    /**
+     * Limit Flow and Flow Segment events to those with Flow that is collected by a Flow Collection in the given list of Flow Collection IDs
+     */
+    flow_collected_by_ids?: Array<string>;
+    /**
+     * Limit Flow, Flow Segment and Source events to those with Source that is collected by a Source Collection in the given list of Source Collection IDs
+     */
+    source_collected_by_ids?: Array<string>;
+    /**
+     * List of labels of URLs to include in the `get_urls` property in `flows/segments_added` events. This option is the same as the `accept_get_urls` query parameter for the /flows/{flowId}/segments API endpoint, except that the labels are represented using a JSON array rather than a (comma separated list) string.
+     */
+    accept_get_urls?: Array<string>;
+}
+
+/**
+ * Provides information about the store service
+ */
+export declare interface Service {
+    /**
+     * The service instance name
+     */
+    name?: string;
+    /**
+     * The service instance description
+     */
+    description?: string;
+    /**
+     * The type identifier for the service. The value must start with \'urn:x-tams:service\'
+     */
+    type: string;
+    /**
+     * The version of the TAMS API specification this deployment implements
+     */
+    api_version: string;
+    /**
+     * The version of software providing this service. Note: Different implementations and software houses may use different conventions for their version identification. As such, this field is intentionally permissive and intended to be informative only. Implementations should avoid using this field to determine compatibility.
+     */
+    service_version?: string;
+    media_store: ServiceMediaStore;
+    /**
+     * List the types of event stream that this implementation supports
+     */
+    event_stream_mechanisms?: Array<EventStreamMechanism>;
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Provide information about the media store for this service
+ */
+export declare interface ServiceMediaStore {
+    /**
+     * The type of the media store. This determines the endpoints for reading and writing media
+     */
+    type: ServiceMediaStore.TypeEnum;
+}
+
+export declare namespace ServiceMediaStore {
+    export type TypeEnum = 'http_object_store';
+    const TypeEnum: {
+        HttpObjectStore: TypeEnum;
+    };
+}
+
+/**
+ * Describes a Source: an abstract representation of a piece of media as defined in <https://specs.amwa.tv/ms-04/releases/v1.0.0/docs/2.2._Explanation_-_Source.html>  Sources may be elemental (and represented directly by a Flow), or may represent a collection of other Sources, e.g. a Source collecting video and audio together.
+ */
+export declare interface Source {
+    /**
+     * Source identifier
+     */
+    id: string;
+    /**
+     * The primary content type URN for the Source.
+     */
+    format: Source.FormatEnum;
+    /**
+     * Freeform string label for the Source
+     */
+    label?: string;
+    /**
+     * Freeform text describing the Source
+     */
+    description?: string;
+    /**
+     * A string identifier for the entity that created the Source. Implementations SHOULD set suitable default values for `created_by` based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.
+     */
+    created_by?: string;
+    /**
+     * A string identifier for the entity that updated the Source metadata most recently. Implementations SHOULD set suitable default values for `updated_by` based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.
+     */
+    updated_by?: string;
+    /**
+     * The date-time the Source was created in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    created?: string;
+    /**
+     * The date-time the Source metadata was last updated in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    updated?: string;
+    /**
+     * Key value is a freeform string.
+     */
+    tags?: {
+        [key: string]: string;
+    };
+    /**
+     * List of Sources that are collected together by this Source. This attribute is intended to be read-only. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally. Source collections can be inferred from Flow collection definitions.
+     */
+    source_collection?: Array<CollectionItem>;
+    /**
+     * Sources that reference this Source to include it in a collection. This attribute is intended to be read-only. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally. Source collections can be inferred from Flow collection definitions.
+     */
+    collected_by?: Array<string>;
+}
+
+export declare namespace Source {
+    export type FormatEnum = 'urn:x-nmos:format:video' | 'urn:x-nmos:format:audio' | 'urn:x-nmos:format:data' | 'urn:x-nmos:format:multi';
+    const FormatEnum: {
+        Video: FormatEnum;
+        Audio: FormatEnum;
+        Data: FormatEnum;
+        Multi: FormatEnum;
+    };
+}
+
+export { TimecodeUtil }
+
+export { TimeRangeUtil }
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare interface UncompressedAudioParameters {
+    /**
+     * The uncompressed audio multi-channel representation type. If codec is `audio/x-raw-int` or `audio/x-raw-float`, unc_type must be set.
+     */
+    unc_type: UncompressedAudioParameters.UncTypeEnum;
+}
+
+export declare namespace UncompressedAudioParameters {
+    export type UncTypeEnum = 'interleaved' | 'planar' | 'pairs';
+    const UncTypeEnum: {
+        Interleaved: UncTypeEnum;
+        Planar: UncTypeEnum;
+        Pairs: UncTypeEnum;
+    };
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare interface UncompressedVideoParameters {
+    /**
+     * Uncompressed picture packing type. If codec is `video/raw`, unc_type must be set.
+     */
+    unc_type: UncompressedVideoParameters.UncTypeEnum;
+}
+
+export declare namespace UncompressedVideoParameters {
+    export type UncTypeEnum = 'planar' | 'YUYV' | 'UYVY' | 'AYUV' | 'v210' | 'v216' | 'RGB' | 'RGBx' | 'xRGB' | 'BGRx' | 'xBGR' | 'RGBA' | 'ARGB' | 'BGRA' | 'ABGR' | 'alpha';
+    const UncTypeEnum: {
+        Planar: UncTypeEnum;
+        Yuyv: UncTypeEnum;
+        Uyvy: UncTypeEnum;
+        Ayuv: UncTypeEnum;
+        V210: UncTypeEnum;
+        V216: UncTypeEnum;
+        Rgb: UncTypeEnum;
+        Rgbx: UncTypeEnum;
+        XRgb: UncTypeEnum;
+        Bgrx: UncTypeEnum;
+        XBgr: UncTypeEnum;
+        Rgba: UncTypeEnum;
+        Argb: UncTypeEnum;
+        Bgra: UncTypeEnum;
+        Abgr: UncTypeEnum;
+        Alpha: UncTypeEnum;
+    };
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Post update to the service info
+ */
+export declare interface UpdateServiceInfo {
+    /**
+     * The service instance name
+     */
+    name?: string;
+    /**
+     * The service instance description
+     */
+    description?: string;
+}
+
+/**
+ * Describes a video Flow
+ */
+export declare interface VideoFlow {
+    /**
+     * Flow identifier
+     */
+    id: string;
+    /**
+     * Source identifier
+     */
+    source_id: string;
+    /**
+     * Freeform string label for the flow
+     */
+    label?: string;
+    /**
+     * Freeform text describing the flow
+     */
+    description?: string;
+    /**
+     * A string identifier for the entity that created the flow. Implementations SHOULD set suitable default values for `created_by` based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.
+     */
+    created_by?: string;
+    /**
+     * A string identifier for the entity that updated the flow metadata most recently. Implementations SHOULD set suitable default values for `updated_by` based on the principal accessing the system, and MAY permit clients to edit the value, subject to suitable permissions-based limitations.
+     */
+    updated_by?: string;
+    /**
+     * Key value is a freeform string.
+     */
+    tags?: {
+        [key: string]: string;
+    };
+    /**
+     * A change to the flow metadata, not including metadata_version, last_update or segments, results in a new version. If the metadata_version for flow instances is identical then the metadata is identical.
+     */
+    metadata_version?: string;
+    /**
+     * An indication of how many lossy encodings the flow content has been through. A flow with a higher generation may contain less of the original information than a flow with a lower generation.
+     */
+    generation?: number;
+    /**
+     * The date-time the flow was created in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    created?: string;
+    /**
+     * The date-time the flow metadata was updated in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    metadata_updated?: string;
+    /**
+     * The date-time the flow segments were updated in a given context, e.g. in the store. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    segments_updated?: string;
+    /**
+     * If set to \'true\', implementations SHOULD reject client requests to update Flow metadata (other than the read_only property), Flow Segments and media objects
+     */
+    read_only?: boolean;
+    /**
+     * A MIME type identification of the (lossy or lossless) coding used for the flow content.
+     */
+    codec?: string;
+    /**
+     * The container MIME type for flow segments.
+     */
+    container?: string;
+    /**
+     * The average bit rate of the flow segments in 1000 bits/second. A precise definition can be found in the [Setting Flow Bit Rate Properties](https://github.com/bbc/tams/blob/main/docs/appnotes/0013-setting-flow-bit-rate-properties.md) AppNote.
+     */
+    avg_bit_rate?: number;
+    /**
+     * The maximum bit rate of the flow segments in 1000 bits/second. A precise definition can be found in the [Setting Flow Bit Rate Properties](https://github.com/bbc/tams/blob/main/docs/appnotes/0013-setting-flow-bit-rate-properties.md) AppNote.
+     */
+    max_bit_rate?: number;
+    segment_duration?: FlowCoreSegmentDuration;
+    /**
+     * The timerange of samples available in the flow, as described by the [TimeRange](../schemas/timerange#top) type
+     */
+    timerange?: string;
+    /**
+     * List of Flows that are collected together by this Flow.
+     */
+    flow_collection?: Array<CollectionItem>;
+    /**
+     * Flows that reference this Flow to include it in a collection. This attribute is intended to be read-only. Implementations SHOULD ignore this if given in a PUT request, and instead manage it internally
+     */
+    collected_by?: Array<string>;
+    container_mapping?: ContainerMapping1;
+    /**
+     * The primary content type URN for the flow.
+     */
+    format: VideoFlow.FormatEnum;
+    essence_parameters: VideoFlowEssenceParameters;
+}
+
+export declare namespace VideoFlow {
+    export type FormatEnum = 'urn:x-nmos:format:video';
+    const FormatEnum: {
+        UrnxNmosformatvideo: FormatEnum;
+    };
+}
+
+/**
+ * Describes the parameters of the essence inside this video Flow
+ */
+export declare interface VideoFlowEssenceParameters {
+    frame_rate?: VideoFlowEssenceParametersFrameRate;
+    /**
+     * The width of the picture in pixels.
+     */
+    frame_width: number;
+    /**
+     * The height of the picture in pixels.
+     */
+    frame_height: number;
+    /**
+     * The number of significant bits used to represent the video component sample. If codec is `video/raw`, bit_depth must be set.
+     */
+    bit_depth?: number;
+    /**
+     * Interlaced video mode for frames in this Flow
+     */
+    interlace_mode?: VideoFlowEssenceParameters.InterlaceModeEnum;
+    /**
+     * Colorspace used for the video
+     */
+    colorspace?: VideoFlowEssenceParameters.ColorspaceEnum;
+    /**
+     * Transfer characteristic
+     */
+    transfer_characteristic?: VideoFlowEssenceParameters.TransferCharacteristicEnum;
+    aspect_ratio?: VideoFlowEssenceParametersAspectRatio;
+    pixel_aspect_ratio?: VideoFlowEssenceParametersPixelAspectRatio;
+    /**
+     * Picture component representation.
+     */
+    component_type?: VideoFlowEssenceParameters.ComponentTypeEnum;
+    /**
+     * Horizontal chroma component sub-sampling. When unc_type is set to a YUV type, horiz_chroma_subs must be set.
+     */
+    horiz_chroma_subs?: number;
+    /**
+     * Vertical chroma component sub-sampling. When unc_type is set to a YUV type, vert_chroma_subs must be set.
+     */
+    vert_chroma_subs?: number;
+    unc_parameters?: UncompressedVideoParameters;
+    avc_parameters?: AVCCodecParameters;
+}
+
+export declare namespace VideoFlowEssenceParameters {
+    export type InterlaceModeEnum = 'progressive' | 'interlaced_tff' | 'interlaced_bff' | 'interlaced_psf';
+    const InterlaceModeEnum: {
+        Progressive: InterlaceModeEnum;
+        InterlacedTff: InterlaceModeEnum;
+        InterlacedBff: InterlaceModeEnum;
+        InterlacedPsf: InterlaceModeEnum;
+    };
+    export type ColorspaceEnum = 'BT601' | 'BT709' | 'BT2020' | 'BT2100';
+    const ColorspaceEnum: {
+        Bt601: ColorspaceEnum;
+        Bt709: ColorspaceEnum;
+        Bt2020: ColorspaceEnum;
+        Bt2100: ColorspaceEnum;
+    };
+    export type TransferCharacteristicEnum = 'SDR' | 'HLG' | 'PQ';
+    const TransferCharacteristicEnum: {
+        Sdr: TransferCharacteristicEnum;
+        Hlg: TransferCharacteristicEnum;
+        Pq: TransferCharacteristicEnum;
+    };
+    export type ComponentTypeEnum = 'YCbCr' | 'RGB';
+    const ComponentTypeEnum: {
+        YcbCr: ComponentTypeEnum;
+        Rgb: ComponentTypeEnum;
+    };
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The display aspect ratio. i.e. display_width / display_height
+ */
+export declare interface VideoFlowEssenceParametersAspectRatio {
+    /**
+     * numerator
+     */
+    numerator: number;
+    /**
+     * denominator
+     */
+    denominator: number;
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The fixed number of frames per second. If this parameter is unset, the frame_rate is either unknown or variable.
+ */
+export declare interface VideoFlowEssenceParametersFrameRate {
+    /**
+     * numerator
+     */
+    numerator: number;
+    /**
+     * denominator
+     */
+    denominator?: number;
+}
+
+/**
+ * Time-addressable Media Store
+ *
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The pixel aspect ratio. This is usually 1:1 (i.e. square pixels) for modern video. Some, usually older, video formats use non-square pixels e.g. some Standard Definition video. This is where that may be indicated.
+ */
+export declare interface VideoFlowEssenceParametersPixelAspectRatio {
+    /**
+     * numerator
+     */
+    numerator: number;
+    /**
+     * denominator
+     */
+    denominator: number;
+}
+
+export { }