feat(client-mediapackagev2): Added support for ClipStartTime on the F…

…ilterConfiguration object on OriginEndpoint manifest settings objects. Added support for EXT-X-START tags on produced HLS child playlists.
aws · Oct 3, 2024 · efe9775 · efe9775
1 parent 9060d22
commit efe9775
Show file tree

Hide file tree

Showing 6 changed files with 192 additions and 6 deletions.
diff --git a/clients/client-mediapackagev2/src/commands/CreateOriginEndpointCommand.ts b/clients/client-mediapackagev2/src/commands/CreateOriginEndpointCommand.ts
@@ -82,13 +82,18 @@ export interface CreateOriginEndpointCommandOutput extends CreateOriginEndpointR
  *       ScteHls: { // ScteHls
  *         AdMarkerHls: "DATERANGE",
  *       },
+ *       StartTag: { // StartTag
+ *         TimeOffset: Number("float"), // required
+ *         Precise: true || false,
+ *       },
  *       ManifestWindowSeconds: Number("int"),
  *       ProgramDateTimeIntervalSeconds: Number("int"),
  *       FilterConfiguration: { // FilterConfiguration
  *         ManifestFilter: "STRING_VALUE",
  *         Start: new Date("TIMESTAMP"),
  *         End: new Date("TIMESTAMP"),
  *         TimeDelaySeconds: Number("int"),
+ *         ClipStartTime: new Date("TIMESTAMP"),
  *       },
  *     },
  *   ],
@@ -99,13 +104,18 @@ export interface CreateOriginEndpointCommandOutput extends CreateOriginEndpointR
  *       ScteHls: {
  *         AdMarkerHls: "DATERANGE",
  *       },
+ *       StartTag: {
+ *         TimeOffset: Number("float"), // required
+ *         Precise: true || false,
+ *       },
  *       ManifestWindowSeconds: Number("int"),
  *       ProgramDateTimeIntervalSeconds: Number("int"),
  *       FilterConfiguration: {
  *         ManifestFilter: "STRING_VALUE",
  *         Start: new Date("TIMESTAMP"),
  *         End: new Date("TIMESTAMP"),
  *         TimeDelaySeconds: Number("int"),
+ *         ClipStartTime: new Date("TIMESTAMP"),
  *       },
  *     },
  *   ],
@@ -118,6 +128,7 @@ export interface CreateOriginEndpointCommandOutput extends CreateOriginEndpointR
  *         Start: new Date("TIMESTAMP"),
  *         End: new Date("TIMESTAMP"),
  *         TimeDelaySeconds: Number("int"),
+ *         ClipStartTime: new Date("TIMESTAMP"),
  *       },
  *       MinUpdatePeriodSeconds: Number("int"),
  *       MinBufferTimeSeconds: Number("int"),
@@ -204,6 +215,11 @@ export interface CreateOriginEndpointCommandOutput extends CreateOriginEndpointR
  * //         Start: new Date("TIMESTAMP"),
  * //         End: new Date("TIMESTAMP"),
  * //         TimeDelaySeconds: Number("int"),
+ * //         ClipStartTime: new Date("TIMESTAMP"),
+ * //       },
+ * //       StartTag: { // StartTag
+ * //         TimeOffset: Number("float"), // required
+ * //         Precise: true || false,
  * //       },
  * //     },
  * //   ],
@@ -222,6 +238,11 @@ export interface CreateOriginEndpointCommandOutput extends CreateOriginEndpointR
  * //         Start: new Date("TIMESTAMP"),
  * //         End: new Date("TIMESTAMP"),
  * //         TimeDelaySeconds: Number("int"),
+ * //         ClipStartTime: new Date("TIMESTAMP"),
+ * //       },
+ * //       StartTag: {
+ * //         TimeOffset: Number("float"), // required
+ * //         Precise: true || false,
  * //       },
  * //     },
  * //   ],
@@ -235,6 +256,7 @@ export interface CreateOriginEndpointCommandOutput extends CreateOriginEndpointR
  * //         Start: new Date("TIMESTAMP"),
  * //         End: new Date("TIMESTAMP"),
  * //         TimeDelaySeconds: Number("int"),
+ * //         ClipStartTime: new Date("TIMESTAMP"),
  * //       },
  * //       MinUpdatePeriodSeconds: Number("int"),
  * //       MinBufferTimeSeconds: Number("int"),

diff --git a/clients/client-mediapackagev2/src/commands/GetOriginEndpointCommand.ts b/clients/client-mediapackagev2/src/commands/GetOriginEndpointCommand.ts
@@ -99,6 +99,11 @@ export interface GetOriginEndpointCommandOutput extends GetOriginEndpointRespons
  * //         Start: new Date("TIMESTAMP"),
  * //         End: new Date("TIMESTAMP"),
  * //         TimeDelaySeconds: Number("int"),
+ * //         ClipStartTime: new Date("TIMESTAMP"),
+ * //       },
+ * //       StartTag: { // StartTag
+ * //         TimeOffset: Number("float"), // required
+ * //         Precise: true || false,
  * //       },
  * //     },
  * //   ],
@@ -117,6 +122,11 @@ export interface GetOriginEndpointCommandOutput extends GetOriginEndpointRespons
  * //         Start: new Date("TIMESTAMP"),
  * //         End: new Date("TIMESTAMP"),
  * //         TimeDelaySeconds: Number("int"),
+ * //         ClipStartTime: new Date("TIMESTAMP"),
+ * //       },
+ * //       StartTag: {
+ * //         TimeOffset: Number("float"), // required
+ * //         Precise: true || false,
  * //       },
  * //     },
  * //   ],
@@ -130,6 +140,7 @@ export interface GetOriginEndpointCommandOutput extends GetOriginEndpointRespons
  * //         Start: new Date("TIMESTAMP"),
  * //         End: new Date("TIMESTAMP"),
  * //         TimeDelaySeconds: Number("int"),
+ * //         ClipStartTime: new Date("TIMESTAMP"),
  * //       },
  * //       MinUpdatePeriodSeconds: Number("int"),
  * //       MinBufferTimeSeconds: Number("int"),

diff --git a/clients/client-mediapackagev2/src/commands/UpdateOriginEndpointCommand.ts b/clients/client-mediapackagev2/src/commands/UpdateOriginEndpointCommand.ts
@@ -82,13 +82,18 @@ export interface UpdateOriginEndpointCommandOutput extends UpdateOriginEndpointR
  *       ScteHls: { // ScteHls
  *         AdMarkerHls: "DATERANGE",
  *       },
+ *       StartTag: { // StartTag
+ *         TimeOffset: Number("float"), // required
+ *         Precise: true || false,
+ *       },
  *       ManifestWindowSeconds: Number("int"),
  *       ProgramDateTimeIntervalSeconds: Number("int"),
  *       FilterConfiguration: { // FilterConfiguration
  *         ManifestFilter: "STRING_VALUE",
  *         Start: new Date("TIMESTAMP"),
  *         End: new Date("TIMESTAMP"),
  *         TimeDelaySeconds: Number("int"),
+ *         ClipStartTime: new Date("TIMESTAMP"),
  *       },
  *     },
  *   ],
@@ -99,13 +104,18 @@ export interface UpdateOriginEndpointCommandOutput extends UpdateOriginEndpointR
  *       ScteHls: {
  *         AdMarkerHls: "DATERANGE",
  *       },
+ *       StartTag: {
+ *         TimeOffset: Number("float"), // required
+ *         Precise: true || false,
+ *       },
  *       ManifestWindowSeconds: Number("int"),
  *       ProgramDateTimeIntervalSeconds: Number("int"),
  *       FilterConfiguration: {
  *         ManifestFilter: "STRING_VALUE",
  *         Start: new Date("TIMESTAMP"),
  *         End: new Date("TIMESTAMP"),
  *         TimeDelaySeconds: Number("int"),
+ *         ClipStartTime: new Date("TIMESTAMP"),
  *       },
  *     },
  *   ],
@@ -118,6 +128,7 @@ export interface UpdateOriginEndpointCommandOutput extends UpdateOriginEndpointR
  *         Start: new Date("TIMESTAMP"),
  *         End: new Date("TIMESTAMP"),
  *         TimeDelaySeconds: Number("int"),
+ *         ClipStartTime: new Date("TIMESTAMP"),
  *       },
  *       MinUpdatePeriodSeconds: Number("int"),
  *       MinBufferTimeSeconds: Number("int"),
@@ -202,6 +213,11 @@ export interface UpdateOriginEndpointCommandOutput extends UpdateOriginEndpointR
  * //         Start: new Date("TIMESTAMP"),
  * //         End: new Date("TIMESTAMP"),
  * //         TimeDelaySeconds: Number("int"),
+ * //         ClipStartTime: new Date("TIMESTAMP"),
+ * //       },
+ * //       StartTag: { // StartTag
+ * //         TimeOffset: Number("float"), // required
+ * //         Precise: true || false,
  * //       },
  * //     },
  * //   ],
@@ -220,6 +236,11 @@ export interface UpdateOriginEndpointCommandOutput extends UpdateOriginEndpointR
  * //         Start: new Date("TIMESTAMP"),
  * //         End: new Date("TIMESTAMP"),
  * //         TimeDelaySeconds: Number("int"),
+ * //         ClipStartTime: new Date("TIMESTAMP"),
+ * //       },
+ * //       StartTag: {
+ * //         TimeOffset: Number("float"), // required
+ * //         Precise: true || false,
  * //       },
  * //     },
  * //   ],
@@ -242,6 +263,7 @@ export interface UpdateOriginEndpointCommandOutput extends UpdateOriginEndpointR
  * //         Start: new Date("TIMESTAMP"),
  * //         End: new Date("TIMESTAMP"),
  * //         TimeDelaySeconds: Number("int"),
+ * //         ClipStartTime: new Date("TIMESTAMP"),
  * //       },
  * //       MinUpdatePeriodSeconds: Number("int"),
  * //       MinBufferTimeSeconds: Number("int"),

diff --git a/clients/client-mediapackagev2/src/models/models_0.ts b/clients/client-mediapackagev2/src/models/models_0.ts
@@ -204,6 +204,7 @@ export class ThrottlingException extends __BaseException {
  */
 export const ValidationExceptionType = {
   CENC_IV_INCOMPATIBLE: "CENC_IV_INCOMPATIBLE",
+  CLIP_START_TIME_WITH_START_OR_END: "CLIP_START_TIME_WITH_START_OR_END",
   CONTAINER_TYPE_IMMUTABLE: "CONTAINER_TYPE_IMMUTABLE",
   DIRECT_MODE_WITH_TIMING_SOURCE: "DIRECT_MODE_WITH_TIMING_SOURCE",
   DRM_SIGNALING_MISMATCH_SEGMENT_ENCRYPTION_STATUS: "DRM_SIGNALING_MISMATCH_SEGMENT_ENCRYPTION_STATUS",
@@ -239,6 +240,7 @@ export const ValidationExceptionType = {
   ROLE_ARN_LENGTH_OUT_OF_RANGE: "ROLE_ARN_LENGTH_OUT_OF_RANGE",
   ROLE_ARN_NOT_ASSUMABLE: "ROLE_ARN_NOT_ASSUMABLE",
   SOURCE_DISRUPTIONS_ENABLED_INCORRECTLY: "SOURCE_DISRUPTIONS_ENABLED_INCORRECTLY",
+  START_TAG_TIME_OFFSET_INVALID: "START_TAG_TIME_OFFSET_INVALID",
   TIMING_SOURCE_MISSING: "TIMING_SOURCE_MISSING",
   TS_CONTAINER_TYPE_WITH_DASH_MANIFEST: "TS_CONTAINER_TYPE_WITH_DASH_MANIFEST",
   UPDATE_PERIOD_SMALLER_THAN_SEGMENT_DURATION: "UPDATE_PERIOD_SMALLER_THAN_SEGMENT_DURATION",
@@ -855,6 +857,12 @@ export interface FilterConfiguration {
    * @public
    */
   TimeDelaySeconds?: number;
+
+  /**
+   * <p>Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL.</p>
+   * @public
+   */
+  ClipStartTime?: Date;
 }
 
 /**
@@ -1088,6 +1096,24 @@ export interface ScteHls {
   AdMarkerHls?: AdMarkerHls;
 }
 
+/**
+ * <p>To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.</p>
+ * @public
+ */
+export interface StartTag {
+  /**
+   * <p>Specify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration.</p>
+   * @public
+   */
+  TimeOffset: number | undefined;
+
+  /**
+   * <p>Specify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES.</p>
+   * @public
+   */
+  Precise?: boolean;
+}
+
 /**
  * <p>Create an HTTP live streaming (HLS) manifest configuration.</p>
  * @public
@@ -1111,6 +1137,12 @@ export interface CreateHlsManifestConfiguration {
    */
   ScteHls?: ScteHls;
 
+  /**
+   * <p>To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.</p>
+   * @public
+   */
+  StartTag?: StartTag;
+
   /**
    * <p>The total duration (in seconds) of the manifest's content.</p>
    * @public
@@ -1157,6 +1189,12 @@ export interface CreateLowLatencyHlsManifestConfiguration {
    */
   ScteHls?: ScteHls;
 
+  /**
+   * <p>To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.</p>
+   * @public
+   */
+  StartTag?: StartTag;
+
   /**
    * <p>The total duration (in seconds) of the manifest's content.</p>
    * @public
@@ -1756,6 +1794,12 @@ export interface GetHlsManifestConfiguration {
    * @public
    */
   FilterConfiguration?: FilterConfiguration;
+
+  /**
+   * <p>To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.</p>
+   * @public
+   */
+  StartTag?: StartTag;
 }
 
 /**
@@ -1808,6 +1852,12 @@ export interface GetLowLatencyHlsManifestConfiguration {
    * @public
    */
   FilterConfiguration?: FilterConfiguration;
+
+  /**
+   * <p>To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.</p>
+   * @public
+   */
+  StartTag?: StartTag;
 }
 
 /**