feat: add Live Stream API channel clip samples and tests

media/livestream/createChannel.js

@@ -1,10 +1,11 @@
 /**
- * Copyright 2022, Google, Inc.
+ * Copyright 2024 Google LLC
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *    http://www.apache.org/licenses/LICENSE-2.0
+ *     https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -93,10 +94,17 @@ function main(projectId, location, channelId, inputId, outputUri) {
           {
             fileName: 'manifest.m3u8',
             type: 'HLS',
+            key: 'manifest_hls',
             muxStreams: ['mux_video', 'mux_audio'],
             maxSegmentCount: 5,
           },
         ],
+        // Optional, but required for VOD clips
+        retentionConfig: {
+          retentionWindowDuration: {
+            seconds: 86400,
+          },
+        },
       },
     };
 

media/livestream/createChannelClip.js

@@ -0,0 +1,91 @@
+/**
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+function main(projectId, location, channelId, clipId, outputUri) {
+  // [START livestream_create_channel_clip]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // projectId = 'my-project-id';
+  // location = 'us-central1';
+  // channelId = 'my-channel';
+  // clipId = 'my-channel-clip';
+  // outputUri = 'gs://my-bucket/my-output-folder';
+
+  // Imports the Livestream library
+  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;
+
+  // Instantiates a client
+  const livestreamServiceClient = new LivestreamServiceClient();
+
+  async function createChannelClip() {
+    // Create a 20 second clip starting 40 seconds ago
+    const recent = new Date();
+    recent.setSeconds(recent.getSeconds() - 20);
+    const earlier = new Date();
+    earlier.setSeconds(earlier.getSeconds() - 40);
+
+    // Construct request
+    const request = {
+      parent: livestreamServiceClient.channelPath(
+        projectId,
+        location,
+        channelId
+      ),
+      clipId: clipId,
+      clip: {
+        outputUri: outputUri,
+        slices: [
+          {
+            timeSlice: {
+              markinTime: {
+                seconds: Math.floor(earlier.getTime() / 1000),
+                nanos: earlier.getMilliseconds() * 1000000,
+              },
+              markoutTime: {
+                seconds: Math.floor(recent.getTime() / 1000),
+                nanos: recent.getMilliseconds() * 1000000,
+              },
+            },
+          },
+        ],
+        clipManifests: [
+          {
+            manifestKey: 'manifest_hls',
+          },
+        ],
+      },
+    };
+
+    // Run request
+    const [operation] = await livestreamServiceClient.createClip(request);
+    const response = await operation.promise();
+    const [clip] = response;
+    console.log(`Channel clip: ${clip.name}`);
+  }
+
+  createChannelClip();
+  // [END livestream_create_channel_clip]
+}
+
+// node createChannelClip.js <projectId> <location> <channelId> <clipId> <outputUri>
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+main(...process.argv.slice(2));

media/livestream/createInput.js

@@ -1,10 +1,11 @@
 /**
- * Copyright 2022, Google, Inc.
+ * Copyright 2024 Google LLC
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *    http://www.apache.org/licenses/LICENSE-2.0
+ *     https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -45,6 +46,7 @@ function main(projectId, location, inputId) {
     const response = await operation.promise();
     const [input] = response;
     console.log(`Input: ${input.name}`);
+    console.log(`Uri: ${input.uri}`);
   }
 
   createInput();

media/livestream/deleteChannelClip.js

@@ -0,0 +1,61 @@
+/**
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+function main(projectId, location, channelId, clipId) {
+  // [START livestream_delete_channel_clip]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // projectId = 'my-project-id';
+  // location = 'us-central1';
+  // channelId = 'my-channel';
+  // clipId = 'my-channel-clip';
+
+  // Imports the Livestream library
+  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;
+
+  // Instantiates a client
+  const livestreamServiceClient = new LivestreamServiceClient();
+
+  async function deleteChannelClip() {
+    // Construct request
+    const request = {
+      name: livestreamServiceClient.clipPath(
+        projectId,
+        location,
+        channelId,
+        clipId
+      ),
+    };
+
+    // Run request
+    const [operation] = await livestreamServiceClient.deleteClip(request);
+    await operation.promise();
+    console.log('Deleted channel clip');
+  }
+
+  deleteChannelClip();
+  // [END livestream_delete_channel_clip]
+}
+
+// node deleteChannelClip.js <projectId> <location> <channelId> <clipId>
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+main(...process.argv.slice(2));

media/livestream/getChannelClip.js

@@ -0,0 +1,58 @@
+/**
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+function main(projectId, location, channelId, clipId) {
+  // [START livestream_get_channel_clip]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // projectId = 'my-project-id';
+  // location = 'us-central1';
+  // channelId = 'my-channel';
+  // clipId = 'my-channel-clip';
+
+  // Imports the Livestream library
+  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;
+
+  // Instantiates a client
+  const livestreamServiceClient = new LivestreamServiceClient();
+
+  async function getChannelClip() {
+    // Construct request
+    const request = {
+      name: livestreamServiceClient.clipPath(
+        projectId,
+        location,
+        channelId,
+        clipId
+      ),
+    };
+    const [clip] = await livestreamServiceClient.getClip(request);
+    console.log(`Channel clip: ${clip.name}`);
+  }
+
+  getChannelClip();
+  // [END livestream_get_channel_clip]
+}
+
+// node getChannelClip.js <projectId> <location> <channelId> <clipId>
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+main(...process.argv.slice(2));

media/livestream/listChannelClips.js

@@ -0,0 +1,57 @@
+/**
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+function main(projectId, location, channelId) {
+  // [START livestream_list_channel_clips]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // projectId = 'my-project-id';
+  // location = 'us-central1';
+  // channelId = 'my-channel';
+
+  // Imports the Livestream library
+  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;
+
+  // Instantiates a client
+  const livestreamServiceClient = new LivestreamServiceClient();
+
+  async function listChannelClips() {
+    const iterable = await livestreamServiceClient.listClipsAsync({
+      parent: livestreamServiceClient.channelPath(
+        projectId,
+        location,
+        channelId
+      ),
+    });
+    console.info('Channel clips:');
+    for await (const response of iterable) {
+      console.log(response.name);
+    }
+  }
+
+  listChannelClips();
+  // [END livestream_list_channel_clips]
+}
+
+// node listChannelClips.js <projectId> <location> <channelId>
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+main(...process.argv.slice(2));

media/livestream/package.json

@@ -13,9 +13,10 @@
     "test": "c8 mocha -p -j 2 --timeout 600000 test/*.js"
   },
   "dependencies": {
-    "@google-cloud/livestream": "^1.0.0"
+    "@google-cloud/livestream": "^1.4.0"
   },
   "devDependencies": {
+    "@google-cloud/storage": "^7.0.0",
     "c8": "^10.0.0",
     "chai": "^4.5.0",
     "mocha": "^10.1.0",