@byomakase/omakase-react-components 0.0.1-SNAPSHOT.1743070950

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (103) hide show
  1. package/LICENSE +204 -0
  2. package/README.md +3 -0
  3. package/dist/index.cjs.js +213 -0
  4. package/dist/index.cjs.js.map +1 -0
  5. package/dist/index.es.d.ts +2 -0
  6. package/dist/index.es.js +3959 -0
  7. package/dist/index.es.js.map +1 -0
  8. package/dist/index.umd.js +213 -0
  9. package/dist/index.umd.js.map +1 -0
  10. package/dist/omakase-react-components.css +1 -0
  11. package/dist/react/omakase-components/src/components/OmakaseMarkerListComponent/OmakaseMarkerListComponent.d.ts +10 -0
  12. package/dist/react/omakase-components/src/components/OmakaseMarkerListComponent/index.d.ts +1 -0
  13. package/dist/react/omakase-components/src/components/OmakasePlayerComponent/OmakasePlayerComponent.d.ts +12 -0
  14. package/dist/react/omakase-components/src/components/OmakasePlayerComponent/OmakasePlayerHotKeyHandler.d.ts +5 -0
  15. package/dist/react/omakase-components/src/components/OmakasePlayerComponent/index.d.ts +1 -0
  16. package/dist/react/omakase-components/src/components/OmakasePlayerTimelineComponent/OmakasePlayerTimelineComponent.d.ts +9 -0
  17. package/dist/react/omakase-components/src/components/OmakasePlayerTimelineComponent/OmaksePlayerTimelineBuilder.d.ts +21 -0
  18. package/dist/react/omakase-components/src/components/OmakasePlayerTimelineComponent/index.d.ts +2 -0
  19. package/dist/react/omakase-components/src/components/OmakasePlayerTimelineControlsToolbar/OmakaseButton.d.ts +12 -0
  20. package/dist/react/omakase-components/src/components/OmakasePlayerTimelineControlsToolbar/OmakasePlayerTimelineControlsToolbar.d.ts +25 -0
  21. package/dist/react/omakase-components/src/components/OmakasePlayerTimelineControlsToolbar/index.d.ts +1 -0
  22. package/dist/react/omakase-components/src/components/OmakaseTamsPlayerComponent/OmakaseTamsPlayerComponent.d.ts +17 -0
  23. package/dist/react/omakase-components/src/components/OmakaseTamsPlayerComponent/index.d.ts +1 -0
  24. package/dist/react/omakase-components/src/components/OmakaseTamsPlayerComponent/virtual-manifest/m3u8-exporter.d.ts +2 -0
  25. package/dist/react/omakase-components/src/components/OmakaseTamsPlayerComponent/virtual-manifest/m3u8.d.ts +79 -0
  26. package/dist/react/omakase-components/src/components/OmakaseTamsPlayerComponent/virtual-manifest/m3u8.model.d.ts +127 -0
  27. package/dist/react/omakase-components/src/components/OmakaseTimeRangePicker/OmakaseTimeRangePicker.d.ts +11 -0
  28. package/dist/react/omakase-components/src/components/OmakaseTimeRangePicker/index.d.ts +1 -0
  29. package/dist/react/omakase-components/src/components/index.d.ts +7 -0
  30. package/dist/react/omakase-components/src/icons/Back3Icon.d.ts +3 -0
  31. package/dist/react/omakase-components/src/icons/DeleteMarkerIcon.d.ts +3 -0
  32. package/dist/react/omakase-components/src/icons/Forward3Icon.d.ts +3 -0
  33. package/dist/react/omakase-components/src/icons/LeftBracketIcon.d.ts +3 -0
  34. package/dist/react/omakase-components/src/icons/LeftDoubleBracketIcon.d.ts +3 -0
  35. package/dist/react/omakase-components/src/icons/LeftMarkerIcon.d.ts +3 -0
  36. package/dist/react/omakase-components/src/icons/PlusIcon.d.ts +3 -0
  37. package/dist/react/omakase-components/src/icons/RefreshIcon.d.ts +3 -0
  38. package/dist/react/omakase-components/src/icons/RightBracketIcon.d.ts +3 -0
  39. package/dist/react/omakase-components/src/icons/RightDoubleBracketIcon.d.ts +3 -0
  40. package/dist/react/omakase-components/src/icons/RightMarkerIcon.d.ts +3 -0
  41. package/dist/react/omakase-components/src/icons/SplitMarkerIcon.d.ts +3 -0
  42. package/dist/react/omakase-components/src/icons/index.d.ts +1 -0
  43. package/dist/react/omakase-components/src/index.d.ts +3 -0
  44. package/dist/react/omakase-components/src/types/tams/index.d.ts +1 -0
  45. package/dist/react/omakase-components/src/types/tams/model/audio-codec-parameters.d.ts +19 -0
  46. package/dist/react/omakase-components/src/types/tams/model/audio-flow-essence-parameters.d.ts +21 -0
  47. package/dist/react/omakase-components/src/types/tams/model/audio-flow.d.ts +104 -0
  48. package/dist/react/omakase-components/src/types/tams/model/avc-codec-parameters.d.ts +23 -0
  49. package/dist/react/omakase-components/src/types/tams/model/collection-item.d.ts +15 -0
  50. package/dist/react/omakase-components/src/types/tams/model/container-mapping-audio-track.d.ts +22 -0
  51. package/dist/react/omakase-components/src/types/tams/model/container-mapping-isobmff-container.d.ts +18 -0
  52. package/dist/react/omakase-components/src/types/tams/model/container-mapping-mp2ts-container.d.ts +18 -0
  53. package/dist/react/omakase-components/src/types/tams/model/container-mapping-mxf-container.d.ts +22 -0
  54. package/dist/react/omakase-components/src/types/tams/model/container-mapping.d.ts +21 -0
  55. package/dist/react/omakase-components/src/types/tams/model/container-mapping1.d.ts +21 -0
  56. package/dist/react/omakase-components/src/types/tams/model/contentformat.d.ts +19 -0
  57. package/dist/react/omakase-components/src/types/tams/model/data-flow-essence-parameters.d.ts +18 -0
  58. package/dist/react/omakase-components/src/types/tams/model/data-flow.d.ts +104 -0
  59. package/dist/react/omakase-components/src/types/tams/model/deletion-request-error.d.ts +30 -0
  60. package/dist/react/omakase-components/src/types/tams/model/deletion-request.d.ts +56 -0
  61. package/dist/react/omakase-components/src/types/tams/model/event-stream-mechanism.d.ts +26 -0
  62. package/dist/react/omakase-components/src/types/tams/model/flow-core-segment-duration.d.ts +22 -0
  63. package/dist/react/omakase-components/src/types/tams/model/flow-segment-get-urls-inner.d.ts +19 -0
  64. package/dist/react/omakase-components/src/types/tams/model/flow-segment.d.ts +38 -0
  65. package/dist/react/omakase-components/src/types/tams/model/flow-segment1.d.ts +38 -0
  66. package/dist/react/omakase-components/src/types/tams/model/flow-storage-post.d.ts +18 -0
  67. package/dist/react/omakase-components/src/types/tams/model/flow.d.ts +14 -0
  68. package/dist/react/omakase-components/src/types/tams/model/http-request.d.ts +32 -0
  69. package/dist/react/omakase-components/src/types/tams/model/image-flow-essence-parameters.d.ts +19 -0
  70. package/dist/react/omakase-components/src/types/tams/model/image-flow.d.ts +104 -0
  71. package/dist/react/omakase-components/src/types/tams/model/media-bucket-object-store-media-objects-inner.d.ts +12 -0
  72. package/dist/react/omakase-components/src/types/tams/model/media-bucket-object-store-pre-inner.d.ts +19 -0
  73. package/dist/react/omakase-components/src/types/tams/model/media-bucket-object-store.d.ts +16 -0
  74. package/dist/react/omakase-components/src/types/tams/model/models.d.ts +41 -0
  75. package/dist/react/omakase-components/src/types/tams/model/multi-essence-flow.d.ts +102 -0
  76. package/dist/react/omakase-components/src/types/tams/model/register-webhook.d.ts +50 -0
  77. package/dist/react/omakase-components/src/types/tams/model/register-webhook1.d.ts +50 -0
  78. package/dist/react/omakase-components/src/types/tams/model/service-media-store.d.ts +24 -0
  79. package/dist/react/omakase-components/src/types/tams/model/service.d.ts +32 -0
  80. package/dist/react/omakase-components/src/types/tams/model/source.d.ts +61 -0
  81. package/dist/react/omakase-components/src/types/tams/model/uncompressed-audio-parameters.d.ts +23 -0
  82. package/dist/react/omakase-components/src/types/tams/model/uncompressed-video-parameters.d.ts +36 -0
  83. package/dist/react/omakase-components/src/types/tams/model/update-service-info.d.ts +22 -0
  84. package/dist/react/omakase-components/src/types/tams/model/video-flow-essence-parameters-aspect-ratio.d.ts +22 -0
  85. package/dist/react/omakase-components/src/types/tams/model/video-flow-essence-parameters-frame-rate.d.ts +22 -0
  86. package/dist/react/omakase-components/src/types/tams/model/video-flow-essence-parameters-pixel-aspect-ratio.d.ts +22 -0
  87. package/dist/react/omakase-components/src/types/tams/model/video-flow-essence-parameters.d.ts +78 -0
  88. package/dist/react/omakase-components/src/types/tams/model/video-flow.d.ts +104 -0
  89. package/dist/react/omakase-components/src/types/user-agent.d.ts +2 -0
  90. package/dist/react/omakase-components/src/util/array-util.d.ts +3 -0
  91. package/dist/react/omakase-components/src/util/blob-util.d.ts +7 -0
  92. package/dist/react/omakase-components/src/util/color-util.d.ts +21 -0
  93. package/dist/react/omakase-components/src/util/crypto-util.d.ts +3 -0
  94. package/dist/react/omakase-components/src/util/frame-rate-util.d.ts +3 -0
  95. package/dist/react/omakase-components/src/util/object-util.d.ts +1 -0
  96. package/dist/react/omakase-components/src/util/player-util.d.ts +3 -0
  97. package/dist/react/omakase-components/src/util/rxjs-util.d.ts +2 -0
  98. package/dist/react/omakase-components/src/util/string-util.d.ts +9 -0
  99. package/dist/react/omakase-components/src/util/time-range-util.d.ts +38 -0
  100. package/dist/react/omakase-components/src/util/timecode-util.d.ts +10 -0
  101. package/dist/react/omakase-components/src/util/window-util.d.ts +6 -0
  102. package/dist/react/omakase-components/vite.config.d.ts +2 -0
  103. package/package.json +32 -0
@@ -0,0 +1,104 @@
1
+ import { FlowCoreSegmentDuration } from './flow-core-segment-duration';
2
+ import { ContainerMapping1 } from './container-mapping1';
3
+ import { CollectionItem } from './collection-item';
4
+ import { ImageFlowEssenceParameters } from './image-flow-essence-parameters';
5
+ /**
6
+ * Describes a image Flow
7
+ */
8
+ export interface ImageFlow {
9
+ /**
10
+ * Flow identifier
11
+ */
12
+ id: string;
13
+ /**
14
+ * Source identifier
15
+ */
16
+ source_id: string;
17
+ /**
18
+ * Freeform string label for the flow
19
+ */
20
+ label?: string;
21
+ /**
22
+ * Freeform text describing the flow
23
+ */
24
+ description?: string;
25
+ /**
26
+ * 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.
27
+ */
28
+ created_by?: string;
29
+ /**
30
+ * 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.
31
+ */
32
+ updated_by?: string;
33
+ /**
34
+ * Key value is a freeform string.
35
+ */
36
+ tags?: {
37
+ [key: string]: string;
38
+ };
39
+ /**
40
+ * 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.
41
+ */
42
+ metadata_version?: string;
43
+ /**
44
+ * 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.
45
+ */
46
+ generation?: number;
47
+ /**
48
+ * 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
49
+ */
50
+ created?: string;
51
+ /**
52
+ * 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
53
+ */
54
+ metadata_updated?: string;
55
+ /**
56
+ * 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
57
+ */
58
+ segments_updated?: string;
59
+ /**
60
+ * If set to \'true\', implementations SHOULD reject client requests to update Flow metadata (other than the read_only property), Flow Segments and media objects
61
+ */
62
+ read_only?: boolean;
63
+ /**
64
+ * A MIME type identification of the (lossy or lossless) coding used for the flow content.
65
+ */
66
+ codec?: string;
67
+ /**
68
+ * The container MIME type for flow segments.
69
+ */
70
+ container?: string;
71
+ /**
72
+ * 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.
73
+ */
74
+ avg_bit_rate?: number;
75
+ /**
76
+ * 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.
77
+ */
78
+ max_bit_rate?: number;
79
+ segment_duration?: FlowCoreSegmentDuration;
80
+ /**
81
+ * The timerange of samples available in the flow, as described by the [TimeRange](../schemas/timerange#top) type
82
+ */
83
+ timerange?: string;
84
+ /**
85
+ * List of Flows that are collected together by this Flow.
86
+ */
87
+ flow_collection?: Array<CollectionItem>;
88
+ /**
89
+ * 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
90
+ */
91
+ collected_by?: Array<string>;
92
+ container_mapping?: ContainerMapping1;
93
+ /**
94
+ * The primary content type URN for the flow.
95
+ */
96
+ format: DataFlow.FormatEnum;
97
+ essence_parameters: ImageFlowEssenceParameters;
98
+ }
99
+ export declare namespace DataFlow {
100
+ type FormatEnum = "urn:x-nmos:format:image";
101
+ const FormatEnum: {
102
+ UrnxNmosformatdata: FormatEnum;
103
+ };
104
+ }
@@ -0,0 +1,12 @@
1
+ import { HTTPRequest } from './http-request';
2
+ /**
3
+ * Information for a media object
4
+ */
5
+ export interface MediaBucketObjectStoreMediaObjectsInner {
6
+ /**
7
+ * The object store identifier for the media object.
8
+ */
9
+ object_id: string;
10
+ put_url: HTTPRequest;
11
+ put_cors_url?: HTTPRequest;
12
+ }
@@ -0,0 +1,19 @@
1
+ import { HTTPRequest } from './http-request';
2
+ /**
3
+ * An action
4
+ */
5
+ export interface MediaBucketObjectStorePreInner {
6
+ action: MediaBucketObjectStorePreInner.ActionEnum;
7
+ /**
8
+ * The name of the bucket that needs to be created
9
+ */
10
+ bucket_id?: string;
11
+ put_url?: HTTPRequest;
12
+ put_cors_url?: HTTPRequest;
13
+ }
14
+ export declare namespace MediaBucketObjectStorePreInner {
15
+ type ActionEnum = 'create_bucket';
16
+ const ActionEnum: {
17
+ CreateBucket: ActionEnum;
18
+ };
19
+ }
@@ -0,0 +1,16 @@
1
+ import { MediaBucketObjectStorePreInner } from './media-bucket-object-store-pre-inner';
2
+ import { MediaBucketObjectStoreMediaObjectsInner } from './media-bucket-object-store-media-objects-inner';
3
+ /**
4
+ * 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.
5
+ */
6
+ export interface MediaBucketObjectStore {
7
+ [key: string]: any | any;
8
+ /**
9
+ * Actions that need to be taken before the media object can be written
10
+ */
11
+ pre?: Array<MediaBucketObjectStorePreInner>;
12
+ /**
13
+ * List of information for identifying and uploading media objects
14
+ */
15
+ media_objects?: Array<MediaBucketObjectStoreMediaObjectsInner>;
16
+ }
@@ -0,0 +1,41 @@
1
+ export * from './avc-codec-parameters';
2
+ export * from './audio-codec-parameters';
3
+ export * from './audio-flow';
4
+ export * from './audio-flow-essence-parameters';
5
+ export * from './collection-item';
6
+ export * from './container-mapping';
7
+ export * from './container-mapping1';
8
+ export * from './container-mapping-audio-track';
9
+ export * from './container-mapping-isobmff-container';
10
+ export * from './container-mapping-mp2ts-container';
11
+ export * from './container-mapping-mxf-container';
12
+ export * from './contentformat';
13
+ export * from './data-flow';
14
+ export * from './data-flow-essence-parameters';
15
+ export * from './deletion-request';
16
+ export * from './deletion-request-error';
17
+ export * from './event-stream-mechanism';
18
+ export * from './flow';
19
+ export * from './flow-core-segment-duration';
20
+ export * from './flow-segment';
21
+ export * from './flow-segment1';
22
+ export * from './flow-segment-get-urls-inner';
23
+ export * from './flow-storage-post';
24
+ export * from './http-request';
25
+ export * from './media-bucket-object-store';
26
+ export * from './media-bucket-object-store-media-objects-inner';
27
+ export * from './media-bucket-object-store-pre-inner';
28
+ export * from './multi-essence-flow';
29
+ export * from './register-webhook';
30
+ export * from './register-webhook1';
31
+ export * from './service';
32
+ export * from './service-media-store';
33
+ export * from './source';
34
+ export * from './uncompressed-audio-parameters';
35
+ export * from './uncompressed-video-parameters';
36
+ export * from './update-service-info';
37
+ export * from './video-flow';
38
+ export * from './video-flow-essence-parameters';
39
+ export * from './video-flow-essence-parameters-aspect-ratio';
40
+ export * from './video-flow-essence-parameters-frame-rate';
41
+ export * from './video-flow-essence-parameters-pixel-aspect-ratio';
@@ -0,0 +1,102 @@
1
+ import { FlowCoreSegmentDuration } from './flow-core-segment-duration';
2
+ import { ContainerMapping1 } from './container-mapping1';
3
+ import { CollectionItem } from './collection-item';
4
+ /**
5
+ * Describes a multi-essence Flow
6
+ */
7
+ export interface MultiEssenceFlow {
8
+ /**
9
+ * Flow identifier
10
+ */
11
+ id: string;
12
+ /**
13
+ * Source identifier
14
+ */
15
+ source_id: string;
16
+ /**
17
+ * Freeform string label for the flow
18
+ */
19
+ label?: string;
20
+ /**
21
+ * Freeform text describing the flow
22
+ */
23
+ description?: string;
24
+ /**
25
+ * 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.
26
+ */
27
+ created_by?: string;
28
+ /**
29
+ * 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.
30
+ */
31
+ updated_by?: string;
32
+ /**
33
+ * Key value is a freeform string.
34
+ */
35
+ tags?: {
36
+ [key: string]: string;
37
+ };
38
+ /**
39
+ * 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.
40
+ */
41
+ metadata_version?: string;
42
+ /**
43
+ * 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.
44
+ */
45
+ generation?: number;
46
+ /**
47
+ * 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
48
+ */
49
+ created?: string;
50
+ /**
51
+ * 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
52
+ */
53
+ metadata_updated?: string;
54
+ /**
55
+ * 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
56
+ */
57
+ segments_updated?: string;
58
+ /**
59
+ * If set to \'true\', implementations SHOULD reject client requests to update Flow metadata (other than the read_only property), Flow Segments and media objects
60
+ */
61
+ read_only?: boolean;
62
+ /**
63
+ * A MIME type identification of the (lossy or lossless) coding used for the flow content.
64
+ */
65
+ codec?: string;
66
+ /**
67
+ * The container MIME type for flow segments.
68
+ */
69
+ container?: string;
70
+ /**
71
+ * 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.
72
+ */
73
+ avg_bit_rate?: number;
74
+ /**
75
+ * 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.
76
+ */
77
+ max_bit_rate?: number;
78
+ segment_duration?: FlowCoreSegmentDuration;
79
+ /**
80
+ * The timerange of samples available in the flow, as described by the [TimeRange](../schemas/timerange#top) type
81
+ */
82
+ timerange?: string;
83
+ /**
84
+ * List of Flows that are collected together by this Flow.
85
+ */
86
+ flow_collection?: Array<CollectionItem>;
87
+ /**
88
+ * 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
89
+ */
90
+ collected_by?: Array<string>;
91
+ container_mapping?: ContainerMapping1;
92
+ /**
93
+ * The primary content type URN for the flow.
94
+ */
95
+ format: MultiEssenceFlow.FormatEnum;
96
+ }
97
+ export declare namespace MultiEssenceFlow {
98
+ type FormatEnum = 'urn:x-nmos:format:multi';
99
+ const FormatEnum: {
100
+ UrnxNmosformatmulti: FormatEnum;
101
+ };
102
+ }
@@ -0,0 +1,50 @@
1
+ /**
2
+ * Time-addressable Media Store
3
+ *
4
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
5
+ *
6
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ * https://openapi-generator.tech
8
+ * Do not edit the class manually.
9
+ */
10
+ /**
11
+ * Register to receive updates via webhook
12
+ */
13
+ export interface RegisterWebhook {
14
+ /**
15
+ * The URL to which the API should make HTTP POST requests with event data
16
+ */
17
+ url: string;
18
+ /**
19
+ * The HTTP header name that is added to the event POST
20
+ */
21
+ api_key_name?: string;
22
+ /**
23
+ * The value that the HTTP header \'api_key_name\' will be set to
24
+ */
25
+ api_key_value?: string;
26
+ /**
27
+ * List of event types to receive
28
+ */
29
+ events: Array<string>;
30
+ /**
31
+ * Limit Flow and Flow Segment events to Flows in the given list of Flow IDs
32
+ */
33
+ flow_ids?: Array<string>;
34
+ /**
35
+ * Limit Flow, Flow Segment and Source events to Sources in the given list of Source IDs
36
+ */
37
+ source_ids?: Array<string>;
38
+ /**
39
+ * 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
40
+ */
41
+ flow_collected_by_ids?: Array<string>;
42
+ /**
43
+ * 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
44
+ */
45
+ source_collected_by_ids?: Array<string>;
46
+ /**
47
+ * 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.
48
+ */
49
+ accept_get_urls?: Array<string>;
50
+ }
@@ -0,0 +1,50 @@
1
+ /**
2
+ * Time-addressable Media Store
3
+ *
4
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
5
+ *
6
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ * https://openapi-generator.tech
8
+ * Do not edit the class manually.
9
+ */
10
+ /**
11
+ * Register to receive updates via webhook
12
+ */
13
+ export interface RegisterWebhook1 {
14
+ /**
15
+ * The URL to which the API should make HTTP POST requests with event data
16
+ */
17
+ url: string;
18
+ /**
19
+ * The HTTP header name that is added to the event POST with value \'api_key_value\'
20
+ */
21
+ api_key_name?: string;
22
+ /**
23
+ * The value that the HTTP header \'api_key_name\' will be set to
24
+ */
25
+ api_key_value?: string;
26
+ /**
27
+ * List of event types to receive
28
+ */
29
+ events: Array<string>;
30
+ /**
31
+ * Limit Flow and Flow Segment events to Flows in the given list of Flow IDs
32
+ */
33
+ flow_ids?: Array<string>;
34
+ /**
35
+ * Limit Flow, Flow Segment and Source events to Sources in the given list of Source IDs
36
+ */
37
+ source_ids?: Array<string>;
38
+ /**
39
+ * 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
40
+ */
41
+ flow_collected_by_ids?: Array<string>;
42
+ /**
43
+ * 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
44
+ */
45
+ source_collected_by_ids?: Array<string>;
46
+ /**
47
+ * 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.
48
+ */
49
+ accept_get_urls?: Array<string>;
50
+ }
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Time-addressable Media Store
3
+ *
4
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
5
+ *
6
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ * https://openapi-generator.tech
8
+ * Do not edit the class manually.
9
+ */
10
+ /**
11
+ * Provide information about the media store for this service
12
+ */
13
+ export interface ServiceMediaStore {
14
+ /**
15
+ * The type of the media store. This determines the endpoints for reading and writing media
16
+ */
17
+ type: ServiceMediaStore.TypeEnum;
18
+ }
19
+ export declare namespace ServiceMediaStore {
20
+ type TypeEnum = 'http_object_store';
21
+ const TypeEnum: {
22
+ HttpObjectStore: TypeEnum;
23
+ };
24
+ }
@@ -0,0 +1,32 @@
1
+ import { ServiceMediaStore } from './service-media-store';
2
+ import { EventStreamMechanism } from './event-stream-mechanism';
3
+ /**
4
+ * Provides information about the store service
5
+ */
6
+ export interface Service {
7
+ /**
8
+ * The service instance name
9
+ */
10
+ name?: string;
11
+ /**
12
+ * The service instance description
13
+ */
14
+ description?: string;
15
+ /**
16
+ * The type identifier for the service. The value must start with \'urn:x-tams:service\'
17
+ */
18
+ type: string;
19
+ /**
20
+ * The version of the TAMS API specification this deployment implements
21
+ */
22
+ api_version: string;
23
+ /**
24
+ * 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.
25
+ */
26
+ service_version?: string;
27
+ media_store: ServiceMediaStore;
28
+ /**
29
+ * List the types of event stream that this implementation supports
30
+ */
31
+ event_stream_mechanisms?: Array<EventStreamMechanism>;
32
+ }
@@ -0,0 +1,61 @@
1
+ import { CollectionItem } from './collection-item';
2
+ /**
3
+ * 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.
4
+ */
5
+ export interface Source {
6
+ /**
7
+ * Source identifier
8
+ */
9
+ id: string;
10
+ /**
11
+ * The primary content type URN for the Source.
12
+ */
13
+ format: Source.FormatEnum;
14
+ /**
15
+ * Freeform string label for the Source
16
+ */
17
+ label?: string;
18
+ /**
19
+ * Freeform text describing the Source
20
+ */
21
+ description?: string;
22
+ /**
23
+ * 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.
24
+ */
25
+ created_by?: string;
26
+ /**
27
+ * 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.
28
+ */
29
+ updated_by?: string;
30
+ /**
31
+ * 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
32
+ */
33
+ created?: string;
34
+ /**
35
+ * 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
36
+ */
37
+ updated?: string;
38
+ /**
39
+ * Key value is a freeform string.
40
+ */
41
+ tags?: {
42
+ [key: string]: string;
43
+ };
44
+ /**
45
+ * 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.
46
+ */
47
+ source_collection?: Array<CollectionItem>;
48
+ /**
49
+ * 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.
50
+ */
51
+ collected_by?: Array<string>;
52
+ }
53
+ export declare namespace Source {
54
+ type FormatEnum = 'urn:x-nmos:format:video' | 'urn:x-nmos:format:audio' | 'urn:x-nmos:format:data' | 'urn:x-nmos:format:multi';
55
+ const FormatEnum: {
56
+ Video: FormatEnum;
57
+ Audio: FormatEnum;
58
+ Data: FormatEnum;
59
+ Multi: FormatEnum;
60
+ };
61
+ }
@@ -0,0 +1,23 @@
1
+ /**
2
+ * Time-addressable Media Store
3
+ *
4
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
5
+ *
6
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ * https://openapi-generator.tech
8
+ * Do not edit the class manually.
9
+ */
10
+ export interface UncompressedAudioParameters {
11
+ /**
12
+ * The uncompressed audio multi-channel representation type. If codec is `audio/x-raw-int` or `audio/x-raw-float`, unc_type must be set.
13
+ */
14
+ unc_type: UncompressedAudioParameters.UncTypeEnum;
15
+ }
16
+ export declare namespace UncompressedAudioParameters {
17
+ type UncTypeEnum = 'interleaved' | 'planar' | 'pairs';
18
+ const UncTypeEnum: {
19
+ Interleaved: UncTypeEnum;
20
+ Planar: UncTypeEnum;
21
+ Pairs: UncTypeEnum;
22
+ };
23
+ }
@@ -0,0 +1,36 @@
1
+ /**
2
+ * Time-addressable Media Store
3
+ *
4
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
5
+ *
6
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ * https://openapi-generator.tech
8
+ * Do not edit the class manually.
9
+ */
10
+ export interface UncompressedVideoParameters {
11
+ /**
12
+ * Uncompressed picture packing type. If codec is `video/raw`, unc_type must be set.
13
+ */
14
+ unc_type: UncompressedVideoParameters.UncTypeEnum;
15
+ }
16
+ export declare namespace UncompressedVideoParameters {
17
+ type UncTypeEnum = 'planar' | 'YUYV' | 'UYVY' | 'AYUV' | 'v210' | 'v216' | 'RGB' | 'RGBx' | 'xRGB' | 'BGRx' | 'xBGR' | 'RGBA' | 'ARGB' | 'BGRA' | 'ABGR' | 'alpha';
18
+ const UncTypeEnum: {
19
+ Planar: UncTypeEnum;
20
+ Yuyv: UncTypeEnum;
21
+ Uyvy: UncTypeEnum;
22
+ Ayuv: UncTypeEnum;
23
+ V210: UncTypeEnum;
24
+ V216: UncTypeEnum;
25
+ Rgb: UncTypeEnum;
26
+ Rgbx: UncTypeEnum;
27
+ XRgb: UncTypeEnum;
28
+ Bgrx: UncTypeEnum;
29
+ XBgr: UncTypeEnum;
30
+ Rgba: UncTypeEnum;
31
+ Argb: UncTypeEnum;
32
+ Bgra: UncTypeEnum;
33
+ Abgr: UncTypeEnum;
34
+ Alpha: UncTypeEnum;
35
+ };
36
+ }
@@ -0,0 +1,22 @@
1
+ /**
2
+ * Time-addressable Media Store
3
+ *
4
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
5
+ *
6
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ * https://openapi-generator.tech
8
+ * Do not edit the class manually.
9
+ */
10
+ /**
11
+ * Post update to the service info
12
+ */
13
+ export interface UpdateServiceInfo {
14
+ /**
15
+ * The service instance name
16
+ */
17
+ name?: string;
18
+ /**
19
+ * The service instance description
20
+ */
21
+ description?: string;
22
+ }
@@ -0,0 +1,22 @@
1
+ /**
2
+ * Time-addressable Media Store
3
+ *
4
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
5
+ *
6
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ * https://openapi-generator.tech
8
+ * Do not edit the class manually.
9
+ */
10
+ /**
11
+ * The display aspect ratio. i.e. display_width / display_height
12
+ */
13
+ export interface VideoFlowEssenceParametersAspectRatio {
14
+ /**
15
+ * numerator
16
+ */
17
+ numerator: number;
18
+ /**
19
+ * denominator
20
+ */
21
+ denominator: number;
22
+ }
@@ -0,0 +1,22 @@
1
+ /**
2
+ * Time-addressable Media Store
3
+ *
4
+ * Contact: cloudfit-opensource@rd.bbc.co.uk
5
+ *
6
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ * https://openapi-generator.tech
8
+ * Do not edit the class manually.
9
+ */
10
+ /**
11
+ * The fixed number of frames per second. If this parameter is unset, the frame_rate is either unknown or variable.
12
+ */
13
+ export interface VideoFlowEssenceParametersFrameRate {
14
+ /**
15
+ * numerator
16
+ */
17
+ numerator: number;
18
+ /**
19
+ * denominator
20
+ */
21
+ denominator?: number;
22
+ }