diff --git a/docusaurus/video/docusaurus/docs/api/recording/storage.mdx b/docusaurus/video/docusaurus/docs/api/recording/storage.mdx index 4facbad5..e998b61f 100644 --- a/docusaurus/video/docusaurus/docs/api/recording/storage.mdx +++ b/docusaurus/video/docusaurus/docs/api/recording/storage.mdx @@ -29,9 +29,9 @@ Alternatively, you can also have the storage configured and use it for specific + ```js // 1. create a new storage with all the required parameters - await serverSideClient.createExternalStorage({ bucket: 'my-bucket', name: 'my-s3', @@ -43,17 +43,14 @@ await serverSideClient.createExternalStorage({ s3_secret: 'my-secret', }, }); - // 2. update the call type to use the new storage await serverSideClient.updateCallType('my-call-type', { external_storage: "my-s3", }); - // 3. alternative, specify the storage when starting call recording await call.startRecording({ recording_external_storage: "my-s3", }); - ``` @@ -62,37 +59,37 @@ await call.startRecording({ ``` + ```bash -curl -X POST \ - https://video.stream-io-api.com/video/external_storage?api_key=${API_KEY} \ - -H "Authorization: ${JWT_TOKEN}" -H "stream-auth-type: jwt" \ - -d '{ - "name": "my-storage", - "storage_type": "s3", - "bucket": "my-bucket", - "custom_folder": "my-folder", - "aws_s3": { - "s3_region": "us-east-1", - "s3_api_key": "my-api-key", - "s3_secret": "my-secret" - } +curl -X POST https://video.stream-io-api.com/video/external_storage?api_key=${API_KEY} \ +-H "Authorization: ${JWT_TOKEN}" \ +-H "stream-auth-type: jwt" \ +-d '{ + "name": "my-storage", + "storage_type": "s3", + "bucket": "my-bucket", + "custom_folder": "my-folder", + "aws_s3": { + "s3_region": "us-east-1", + "s3_api_key": "my-api-key", + "s3_secret": "my-secret" + } }' -curl -X PATCH \ - https://video.stream-io-api.com/video/call_types/${CALL_TYPE_ID}?api_key=${API_KEY} \ - -H "Authorization: ${JWT_TOKEN}" -H "stream-auth-type: jwt" \ - -d '{ - "external_storage": "my-storage" - }' +curl -X PATCH https://video.stream-io-api.com/video/call_types/${CALL_TYPE_ID}?api_key=${API_KEY} \ +-H "Authorization: ${JWT_TOKEN}" -H "stream-auth-type: jwt" \ +-d '{ + "external_storage": "my-storage" +}' -curl -X POST \ - "https://video.stream-io-api.com/video/call/default/${CALL_ID}/start_recording?api_key=${API_KEY}" \ - -H "Authorization: ${JWT_TOKEN}" -H "stream-auth-type: jwt" \ - -d '{ - "recording_external_storage": "my-storage" - }' +curl -X POST "https://video.stream-io-api.com/video/call/default/${CALL_ID}/start_recording?api_key=${API_KEY}" \ +-H "Authorization: ${JWT_TOKEN}" -H "stream-auth-type: jwt" \ +-d '{ + "recording_external_storage": "my-storage" +}' ``` + @@ -112,41 +109,46 @@ Note: all Stream applications have Stream S3 storage enabled by default. You can + ```js -// TODO: code example for Node // 1. update the call type to use Stream S3 storage + await serverSideClient.updateCallType('my-call-type', { - external_storage: "my-first-storage", + external_storage: "stream-s3", }); // 2. specify Stream S3 storage when starting call recording await call.startRecording({ - recording_external_storage: "my-second-storage", + recording_external_storage: "my-storage", }); ``` + + ```py # TODO: code example for Python ``` + + ```bash -curl -X PATCH \ - https://video.stream-io-api.com/video/call_types/${CALL_TYPE_ID}?api_key=${API_KEY} \ - -H "Authorization: ${JWT_TOKEN}" -H "stream-auth-type: jwt" \ - -d '{ - /// TODO: test current structure - "external_storage": "my-first-storage" - }' - -curl -X POST \ - "https://video.stream-io-api.com/video/call/default/${CALL_ID}/start_recording?api_key=${API_KEY}" \ - -H "Authorization: ${JWT_TOKEN}" -H "stream-auth-type: jwt" \ - -d '{ - "recording_external_storage": "my-second-storage" - }' + +curl -X PATCH https://video.stream-io-api.com/video/call_types/${CALL_TYPE_ID}?api_key=${API_KEY} \ +-H "Authorization: ${JWT_TOKEN}" \ +-H "stream-auth-type: jwt" \ +-d '{ + "external_storage": "my-first-storage" +}' + +curl -X POST "https://video.stream-io-api.com/video/call/default/${CALL_ID}/start_recording?api_key=${API_KEY}" \ +-H "Authorization: ${JWT_TOKEN}" -H "stream-auth-type: jwt" \ +-d '{ + "recording_external_storage": "my-second-storage" +}' ``` + @@ -213,6 +215,7 @@ Note: you can find the JSON service account credentials in the Google Cloud Cons ```js // 1. create a new storage using the service account credentials + await serverSideClient.createExternalStorage({ bucket: 'my-bucket', name: 'my-gcs', @@ -228,12 +231,12 @@ await serverSideClient.createExternalStorage({ ``` + ```bash -curl -X POST \ - curl -X POST \ - https://video.stream-io-api.com/video/external_storage?api_key=${API_KEY} \ - -H "Authorization: ${JWT_TOKEN}" -H "stream-auth-type: jwt" \ - -d '{ + +curl -X POST https://video.stream-io-api.com/video/external_storage?api_key=${API_KEY} \ +-H "Authorization: ${JWT_TOKEN}" -H "stream-auth-type: jwt" \ +-d '{ "name": "my-storage", "storage_type": "gcs", "bucket": "my-bucket", @@ -242,6 +245,7 @@ curl -X POST \ }' ``` +