@axinom/mosaic-messages 0.30.0 → 0.31.0-rc.1

package/src/generated/schemas/payloads/video/commands/import-custom-video-command.json

@@ -0,0 +1,301 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "import_custom_video_command",
+  "description": "Import custom video command schema.",
+  "additionalProperties": false,
+  "required": [
+    "title",
+    "source_location"
+  ],
+  "properties": {
+    "custom_id": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "description": "An identifier for the custom video."
+    },
+    "title": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^$|.*\\S.*",
+      "description": "The string has a minimum length of one character and it cannot consist of only whitespace characters."
+    },
+    "is_protected": {
+      "type": "boolean",
+      "description": "Is video DRM-protected or not."
+    },
+    "source_file_name": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "description": "Source file name of the custom video."
+    },
+    "source_file_extension": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "description": "Source file extension of the custom video."
+    },
+    "source_location": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^$|.*\\S.*",
+      "description": "The string has a minimum length of one character and it cannot consist of only whitespace characters."
+    },
+    "source_size_in_bytes": {
+      "type": [
+        "number",
+        "null"
+      ],
+      "description": "The combined size of all source video, audio, and subtitle files."
+    },
+    "audio_languages": {
+      "type": "array",
+      "description": "An array of audio language values.",
+      "uniqueItems": true,
+      "additionalItems": false,
+      "items": {
+        "type": "string",
+        "description": "An audio language value."
+      }
+    },
+    "subtitle_languages": {
+      "type": "array",
+      "description": "An array of subtitle language values.",
+      "uniqueItems": true,
+      "additionalItems": false,
+      "items": {
+        "type": "string",
+        "description": "A subtitle language  value."
+      }
+    },
+    "caption_languages": {
+      "type": "array",
+      "description": "An array of closed caption language values.",
+      "uniqueItems": true,
+      "additionalItems": false,
+      "items": {
+        "type": "string",
+        "description": "A closed caption language  value."
+      }
+    },
+    "video_bitrates": {
+      "type": "array",
+      "description": "An array of video bitrate values.",
+      "uniqueItems": true,
+      "additionalItems": false,
+      "items": {
+        "type": "number",
+        "description": "A video bitrate value in kilobits per second."
+      }
+    },
+    "hls_size_in_bytes": {
+      "type": [
+        "number",
+        "null"
+      ],
+      "description": "HLS output size in bytes."
+    },
+    "dash_size_in_bytes": {
+      "type": [
+        "number",
+        "null"
+      ],
+      "description": "DASH output size in bytes."
+    },
+    "cmaf_size_in_bytes": {
+      "type": [
+        "number",
+        "null"
+      ],
+      "description": "CMAF output size in bytes."
+    },
+    "hls_manifest_path": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "description": "Path to the HLS manifest in the output storage."
+    },
+    "dash_manifest_path": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "description": "Path to the DASH manifest in the output storage."
+    },
+    "length_in_seconds": {
+      "type": [
+        "number",
+        "null"
+      ],
+      "description": "Video length in seconds."
+    },
+    "finished_date": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "description": "ISO 8601 Datetime when the encoding finished."
+    },
+    "output_format": {
+      "type": "string",
+      "title": "output_format",
+      "enum": [
+        "HLS",
+        "DASH",
+        "DASH_HLS",
+        "CMAF",
+        "DASH_ON_DEMAND"
+      ],
+      "description": "Output format."
+    },
+    "video_streams": {
+      "type": "array",
+      "description": "An array of video stream objects.",
+      "additionalItems": false,
+      "items": {
+        "type": "object",
+        "title": "custom_video_stream",
+        "description": "Information about a video stream.",
+        "additionalProperties": false,
+        "required": [
+          "label",
+          "format",
+          "type"
+        ],
+        "properties": {
+          "label": {
+            "type": "string",
+            "description": "Stream label for grouping streams by the same quality level: audio, sd, hd, uhd1, uhd2."
+          },
+          "format": {
+            "type": "string",
+            "title": "output_format",
+            "enum": [
+              "HLS",
+              "DASH",
+              "DASH_HLS",
+              "CMAF",
+              "DASH_ON_DEMAND"
+            ],
+            "description": "Output format."
+          },
+          "type": {
+            "type": "string",
+            "title": "video_stream_type",
+            "enum": [
+              "VIDEO",
+              "AUDIO",
+              "SUBTITLE",
+              "CLOSED_CAPTION"
+            ],
+            "description": "Stream type"
+          },
+          "file": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "File path to the initialization segment."
+          },
+          "key_id": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "Key ID."
+          },
+          "iv": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "IV."
+          },
+          "bitrate_in_kbps": {
+            "type": [
+              "number",
+              "null"
+            ],
+            "description": "Bitrate in kilobits per second."
+          },
+          "file_template": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "File Template."
+          },
+          "codecs": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "The used codec like H.264 (AVC), H.265 (HEVC), AAC, ..."
+          },
+          "frame_rate": {
+            "type": [
+              "number",
+              "null"
+            ],
+            "description": "Frames per second of the video stream."
+          },
+          "height": {
+            "type": [
+              "integer",
+              "null"
+            ],
+            "description": "Height in pixels of the video stream."
+          },
+          "width": {
+            "type": [
+              "integer",
+              "null"
+            ],
+            "description": "Width in pixels of the video stream."
+          },
+          "display_aspect_ratio": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "The proportional relationship between the width and the height of how to display the video like 16:9, 4:3, 3:2, ..."
+          },
+          "pixel_aspect_ratio": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "This ratio describes how the width of a pixel compares to the height of that pixel e.g. 1:1. But pixels are not always square."
+          },
+          "sampling_rate": {
+            "type": [
+              "integer",
+              "null"
+            ],
+            "description": "The average number of samples in one second for audio streams."
+          },
+          "language_code": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "Language code for for audio, subtitle, or caption streams."
+          },
+          "language_name": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "Language name for audio, subtitle, or caption streams."
+          }
+        }
+      }
+    }
+  }
+}

package/src/generated/schemas/payloads/video/commands/index.ts

@@ -1,6 +1,7 @@
 import * as ArchiveVideosCommand from './archive-videos-command.json';
 import * as DeclareCuePointTypesCommand from './declare-cue-point-types-command.json';
 import * as EnsureVideoExistsCommand from './ensure-video-exists-command.json';
+import * as ImportCustomVideoCommand from './import-custom-video-command.json';
 import * as UnarchiveVideosCommand from './unarchive-videos-command.json';
 import * as VideoServiceDisableCommand from './video-service-disable-command.json';
 import * as VideoServiceEnableCommand from './video-service-enable-command.json';
@@ -8,6 +9,7 @@ import * as VideoServiceEnableCommand from './video-service-enable-command.json'
 export const ArchiveVideosCommandSchema = ArchiveVideosCommand;
 export const DeclareCuePointTypesCommandSchema = DeclareCuePointTypesCommand;
 export const EnsureVideoExistsCommandSchema = EnsureVideoExistsCommand;
+export const ImportCustomVideoCommandSchema = ImportCustomVideoCommand;
 export const UnarchiveVideosCommandSchema = UnarchiveVideosCommand;
 export const VideoServiceDisableCommandSchema = VideoServiceDisableCommand;
 export const VideoServiceEnableCommandSchema = VideoServiceEnableCommand;

package/src/generated/schemas/payloads/video/events/index.ts

@@ -5,6 +5,8 @@ import * as EnsureVideoExistsAlreadyExistedEvent from './ensure-video-exists-alr
 import * as EnsureVideoExistsCreationStartedEvent from './ensure-video-exists-creation-started-event.json';
 import * as EnsureVideoExistsFailedEvent from './ensure-video-exists-failed-event.json';
 import * as UnarchiveVideosFinishedEvent from './unarchive-videos-finished-event.json';
+import * as VideoEncodingFailedEvent from './video-encoding-failed-event.json';
+import * as VideoEncodingFinishedEvent from './video-encoding-finished-event.json';
 import * as VideoServiceDisableFailedEvent from './video-service-disable-failed-event.json';
 import * as VideoServiceDisableFinishedEvent from './video-service-disable-finished-event.json';
 import * as VideoServiceEnableFailedEvent from './video-service-enable-failed-event.json';
@@ -17,6 +19,8 @@ export const EnsureVideoExistsAlreadyExistedEventSchema = EnsureVideoExistsAlrea
 export const EnsureVideoExistsCreationStartedEventSchema = EnsureVideoExistsCreationStartedEvent;
 export const EnsureVideoExistsFailedEventSchema = EnsureVideoExistsFailedEvent;
 export const UnarchiveVideosFinishedEventSchema = UnarchiveVideosFinishedEvent;
+export const VideoEncodingFailedEventSchema = VideoEncodingFailedEvent;
+export const VideoEncodingFinishedEventSchema = VideoEncodingFinishedEvent;
 export const VideoServiceDisableFailedEventSchema = VideoServiceDisableFailedEvent;
 export const VideoServiceDisableFinishedEventSchema = VideoServiceDisableFinishedEvent;
 export const VideoServiceEnableFailedEventSchema = VideoServiceEnableFailedEvent;

package/src/generated/schemas/payloads/video/events/video-encoding-failed-event.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "video_encoding_failed_event",
+  "description": "Video encoding failed event schema.",
+  "additionalProperties": false,
+  "required": [
+    "video_id",
+    "source_location",
+    "message"
+  ],
+  "properties": {
+    "video_id": {
+      "type": "string",
+      "minLength": 32,
+      "maxLength": 36,
+      "format": "uuid",
+      "description": "A UUID."
+    },
+    "custom_id": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "description": "An identifier for a custom video."
+    },
+    "source_location": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^$|.*\\S.*",
+      "description": "The string has a minimum length of one character and it cannot consist of only whitespace characters."
+    },
+    "message": {
+      "type": "string",
+      "description": "Message that describes the reason for video encoding failure."
+    }
+  }
+}

package/src/generated/schemas/payloads/video/events/video-encoding-finished-event.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "video_encoding_finished_event",
+  "description": "Video encoding finished event schema.",
+  "additionalProperties": false,
+  "required": [
+    "video_id",
+    "source_location"
+  ],
+  "properties": {
+    "video_id": {
+      "type": "string",
+      "minLength": 32,
+      "maxLength": 36,
+      "format": "uuid",
+      "description": "A UUID."
+    },
+    "custom_id": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "description": "An identifier for a custom video."
+    },
+    "source_location": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^$|.*\\S.*",
+      "description": "The string has a minimum length of one character and it cannot consist of only whitespace characters."
+    }
+  }
+}

package/src/generated/types/payloads/video/commands/import-custom-video-command.ts

@@ -0,0 +1,87 @@
+import { CustomVideoStream } from '../types/custom-video-stream';
+import { OutputFormat } from '../types/output-format';
+/**
+ * Import custom video command schema.
+ */
+export interface ImportCustomVideoCommand {
+  /**
+   * An identifier for the custom video.
+   */
+  custom_id?: string | null;
+  /**
+   * The string has a minimum length of one character and it cannot consist of only whitespace characters.
+   */
+  title: string;
+  /**
+   * Is video DRM-protected or not.
+   */
+  is_protected?: boolean;
+  /**
+   * Source file name of the custom video.
+   */
+  source_file_name?: string | null;
+  /**
+   * Source file extension of the custom video.
+   */
+  source_file_extension?: string | null;
+  /**
+   * The string has a minimum length of one character and it cannot consist of only whitespace characters.
+   */
+  source_location: string;
+  /**
+   * The combined size of all source video, audio, and subtitle files.
+   */
+  source_size_in_bytes?: number | null;
+  /**
+   * An array of audio language values.
+   */
+  audio_languages?: string[];
+  /**
+   * An array of subtitle language values.
+   */
+  subtitle_languages?: string[];
+  /**
+   * An array of closed caption language values.
+   */
+  caption_languages?: string[];
+  /**
+   * An array of video bitrate values.
+   */
+  video_bitrates?: number[];
+  /**
+   * HLS output size in bytes.
+   */
+  hls_size_in_bytes?: number | null;
+  /**
+   * DASH output size in bytes.
+   */
+  dash_size_in_bytes?: number | null;
+  /**
+   * CMAF output size in bytes.
+   */
+  cmaf_size_in_bytes?: number | null;
+  /**
+   * Path to the HLS manifest in the output storage.
+   */
+  hls_manifest_path?: string | null;
+  /**
+   * Path to the DASH manifest in the output storage.
+   */
+  dash_manifest_path?: string | null;
+  /**
+   * Video length in seconds.
+   */
+  length_in_seconds?: number | null;
+  /**
+   * ISO 8601 Datetime when the encoding finished.
+   */
+  finished_date?: string | null;
+  /**
+   * Output format.
+   */
+  output_format?: OutputFormat;
+  /**
+   * An array of video stream objects.
+   */
+  video_streams?: CustomVideoStream[];
+}

package/src/generated/types/payloads/video/commands/index.ts

@@ -1,6 +1,7 @@
 export * from './archive-videos-command';
 export * from './declare-cue-point-types-command';
 export * from './ensure-video-exists-command';
+export * from './import-custom-video-command';
 export * from './unarchive-videos-command';
 export * from './video-service-disable-command';
 export * from './video-service-enable-command';
@@ -9,6 +10,7 @@ export enum VideoCommandsSchemas {
   ArchiveVideosCommand = 'payloads/video/commands/archive-videos-command.json',
   DeclareCuePointTypesCommand = 'payloads/video/commands/declare-cue-point-types-command.json',
   EnsureVideoExistsCommand = 'payloads/video/commands/ensure-video-exists-command.json',
+  ImportCustomVideoCommand = 'payloads/video/commands/import-custom-video-command.json',
   UnarchiveVideosCommand = 'payloads/video/commands/unarchive-videos-command.json',
   VideoServiceDisableCommand = 'payloads/video/commands/video-service-disable-command.json',
   VideoServiceEnableCommand = 'payloads/video/commands/video-service-enable-command.json'
@@ -18,6 +20,7 @@ export enum VideoCommandsTypes {
   ArchiveVideosCommand = 'ArchiveVideosCommand',
   DeclareCuePointTypesCommand = 'DeclareCuePointTypesCommand',
   EnsureVideoExistsCommand = 'EnsureVideoExistsCommand',
+  ImportCustomVideoCommand = 'ImportCustomVideoCommand',
   UnarchiveVideosCommand = 'UnarchiveVideosCommand',
   VideoServiceDisableCommand = 'VideoServiceDisableCommand',
   VideoServiceEnableCommand = 'VideoServiceEnableCommand'

package/src/generated/types/payloads/video/events/index.ts

@@ -5,6 +5,8 @@ export * from './ensure-video-exists-already-existed-event';
 export * from './ensure-video-exists-creation-started-event';
 export * from './ensure-video-exists-failed-event';
 export * from './unarchive-videos-finished-event';
+export * from './video-encoding-failed-event';
+export * from './video-encoding-finished-event';
 export * from './video-service-disable-failed-event';
 export * from './video-service-disable-finished-event';
 export * from './video-service-enable-failed-event';
@@ -18,6 +20,8 @@ export enum VideoEventsSchemas {
   EnsureVideoExistsCreationStartedEvent = 'payloads/video/events/ensure-video-exists-creation-started-event.json',
   EnsureVideoExistsFailedEvent = 'payloads/video/events/ensure-video-exists-failed-event.json',
   UnarchiveVideosFinishedEvent = 'payloads/video/events/unarchive-videos-finished-event.json',
+  VideoEncodingFailedEvent = 'payloads/video/events/video-encoding-failed-event.json',
+  VideoEncodingFinishedEvent = 'payloads/video/events/video-encoding-finished-event.json',
   VideoServiceDisableFailedEvent = 'payloads/video/events/video-service-disable-failed-event.json',
   VideoServiceDisableFinishedEvent = 'payloads/video/events/video-service-disable-finished-event.json',
   VideoServiceEnableFailedEvent = 'payloads/video/events/video-service-enable-failed-event.json',
@@ -32,6 +36,8 @@ export enum VideoEventsTypes {
   EnsureVideoExistsCreationStartedEvent = 'EnsureVideoExistsCreationStartedEvent',
   EnsureVideoExistsFailedEvent = 'EnsureVideoExistsFailedEvent',
   UnarchiveVideosFinishedEvent = 'UnarchiveVideosFinishedEvent',
+  VideoEncodingFailedEvent = 'VideoEncodingFailedEvent',
+  VideoEncodingFinishedEvent = 'VideoEncodingFinishedEvent',
   VideoServiceDisableFailedEvent = 'VideoServiceDisableFailedEvent',
   VideoServiceDisableFinishedEvent = 'VideoServiceDisableFinishedEvent',
   VideoServiceEnableFailedEvent = 'VideoServiceEnableFailedEvent',

package/src/generated/types/payloads/video/events/video-encoding-failed-event.ts

@@ -0,0 +1,21 @@
+/**
+ * Video encoding failed event schema.
+ */
+export interface VideoEncodingFailedEvent {
+  /**
+   * A UUID.
+   */
+  video_id: string;
+  /**
+   * An identifier for a custom video.
+   */
+  custom_id?: string | null;
+  /**
+   * The string has a minimum length of one character and it cannot consist of only whitespace characters.
+   */
+  source_location: string;
+  /**
+   * Message that describes the reason for video encoding failure.
+   */
+  message: string;
+}

package/src/generated/types/payloads/video/events/video-encoding-finished-event.ts

@@ -0,0 +1,17 @@
+/**
+ * Video encoding finished event schema.
+ */
+export interface VideoEncodingFinishedEvent {
+  /**
+   * A UUID.
+   */
+  video_id: string;
+  /**
+   * An identifier for a custom video.
+   */
+  custom_id?: string | null;
+  /**
+   * The string has a minimum length of one character and it cannot consist of only whitespace characters.
+   */
+  source_location: string;
+}

package/src/generated/types/payloads/video/types/custom-video-stream.ts

@@ -0,0 +1,75 @@
+import { OutputFormat } from './output-format';
+import { VideoStreamType } from './video-stream-type';
+/**
+ * Information about a video stream.
+ */
+export interface CustomVideoStream {
+  /**
+   * Stream label for grouping streams by the same quality level: audio, sd, hd, uhd1, uhd2.
+   */
+  label: string;
+  /**
+   * Output format.
+   */
+  format: OutputFormat;
+  /**
+   * Stream type
+   */
+  type: VideoStreamType;
+  /**
+   * File path to the initialization segment.
+   */
+  file?: string | null;
+  /**
+   * Key ID.
+   */
+  key_id?: string | null;
+  /**
+   * IV.
+   */
+  iv?: string | null;
+  /**
+   * Bitrate in kilobits per second.
+   */
+  bitrate_in_kbps?: number | null;
+  /**
+   * File Template.
+   */
+  file_template?: string | null;
+  /**
+   * The used codec like H.264 (AVC), H.265 (HEVC), AAC, ...
+   */
+  codecs?: string | null;
+  /**
+   * Frames per second of the video stream.
+   */
+  frame_rate?: number | null;
+  /**
+   * Height in pixels of the video stream.
+   */
+  height?: number | null;
+  /**
+   * Width in pixels of the video stream.
+   */
+  width?: number | null;
+  /**
+   * The proportional relationship between the width and the height of how to display the video like 16:9, 4:3, 3:2, ...
+   */
+  display_aspect_ratio?: string | null;
+  /**
+   * This ratio describes how the width of a pixel compares to the height of that pixel e.g. 1:1. But pixels are not always square.
+   */
+  pixel_aspect_ratio?: string | null;
+  /**
+   * The average number of samples in one second for audio streams.
+   */
+  sampling_rate?: number | null;
+  /**
+   * Language code for for audio, subtitle, or caption streams.
+   */
+  language_code?: string | null;
+  /**
+   * Language name for audio, subtitle, or caption streams.
+   */
+  language_name?: string | null;
+}

package/src/generated/types/payloads/video/types/index.ts

@@ -1,4 +1,5 @@
 export * from './cue-point-type';
+export * from './custom-video-stream';
 export * from './encoding-messages';
 export * from './encoding-state';
 export * from './entitlement-webhook-response-payload';