diff --git a/README.md b/README.md index 02626eb7..086d755c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ --- +title: Guides, references, libraries & SDKs hide_navigation: false toc: false breadcrumbs: false diff --git a/analytics/README.md b/analytics/README.md index 930e14e2..0bef75ff 100644 --- a/analytics/README.md +++ b/analytics/README.md @@ -1,5 +1,5 @@ --- -title: Analytics overview +title: Video and live stream analytics toc: false breadcrumbs: false meta: diff --git a/analytics/migration.md b/analytics/migration.md index 6954181e..39fdaab5 100644 --- a/analytics/migration.md +++ b/analytics/migration.md @@ -1,5 +1,5 @@ --- -title: Analytics migration guide +title: Video and live stream analytics migration guide meta: description: This guide helps you migrate the player and analytics library components in your product to the latest version. Migrating enables you to get detailed data insights for your videos and live streams using api.video's Analytics solution. --- diff --git a/analytics/overview.md b/analytics/overview.md index 8fca2d04..11f8923e 100644 --- a/analytics/overview.md +++ b/analytics/overview.md @@ -1,6 +1,6 @@ --- -title: Analytics -breadcrums: false +title: Video and live stream analytics overview +breadcrumbs: false meta: description: Learn how you can get data insights for your videos and live streams using api.video's Analytics solution. --- diff --git a/delivery/README.md b/delivery/README.md index d23a181d..587b8fde 100644 --- a/delivery/README.md +++ b/delivery/README.md @@ -1,5 +1,5 @@ --- -title: "Delivery overview" +title: Video and live stream delivery overview toc: false breadcrumbs: false meta: diff --git a/delivery/ads.md b/delivery/ads.md index c6a786ee..23228808 100644 --- a/delivery/ads.md +++ b/delivery/ads.md @@ -1,5 +1,5 @@ --- -title: api.video In-stream ads +title: In-stream ads in videos and live streams meta: description: Leverage the power of api.video to insert in-stream, VAST, VPAID and VMAP ads into your videos. --- diff --git a/delivery/quickstart.md b/delivery/quickstart.md index 6997235b..3b4f51cc 100644 --- a/delivery/quickstart.md +++ b/delivery/quickstart.md @@ -1,6 +1,6 @@ --- -title: Delivery with api.video -breadcrums: false +title: Video content delivery with api.video +breadcrumbs: false meta: description: Set up the api.video player and start delivering in 5 minutes --- diff --git a/delivery/using-custom-domains.md b/delivery/using-custom-domains.md index 0840c388..664bfc90 100644 --- a/delivery/using-custom-domains.md +++ b/delivery/using-custom-domains.md @@ -1,5 +1,5 @@ --- -title: Using custom domains +title: Host videos and live streams on custom domains meta: description: api.video enables you to deliver video content and provide live streams using your own custom domains. This guide explains how you can utilize the feature. --- diff --git a/get-started/migration-guides.md b/get-started/migration-guides.md index 26fd5ddf..fedcc416 100644 --- a/get-started/migration-guides.md +++ b/get-started/migration-guides.md @@ -1,6 +1,5 @@ --- -title: "Migration guides" -slug: "migration-guides" +title: Video platform migration guides guides toc: false meta: description: This page gets users started on how to migrate to api.video from other platforms using the Import tool. diff --git a/get-started/wistia-migration.md b/get-started/wistia-migration.md index 2d163120..0065db49 100644 --- a/get-started/wistia-migration.md +++ b/get-started/wistia-migration.md @@ -1,6 +1,5 @@ --- -title: "Wistia migration guide" -slug: "wistia-migration" +title: Wistia video content migration guide meta: description: This page gets users started on how to migrate from Wistia to api.video. --- diff --git a/live-streaming/README.md b/live-streaming/README.md index 337ef977..bacc2ba9 100644 --- a/live-streaming/README.md +++ b/live-streaming/README.md @@ -1,5 +1,5 @@ --- -title: Live stream overview +title: Live streaming API overview toc: false breadcrumbs: false meta: diff --git a/live-streaming/list-live-streams.md b/live-streaming/list-live-streams.md index 049a7eeb..4c428e35 100644 --- a/live-streaming/list-live-streams.md +++ b/live-streaming/list-live-streams.md @@ -1,5 +1,5 @@ --- -title: List Live Streams +title: List or filter all live stream containers meta: description: This guide explains how you can list live streams via API at at api.video. --- diff --git a/live-streaming/restreams.md b/live-streaming/restreams.md index 4315ec16..57c36304 100644 --- a/live-streaming/restreams.md +++ b/live-streaming/restreams.md @@ -1,5 +1,5 @@ --- -title: Restreaming +title: Set up restreaming with the API meta: description: This guide explains how you can set up Restreaming to broadcast to multiple destinations simultaneously with api.video. --- diff --git a/reference/README.md b/reference/README.md index ba8940c7..41e382bb 100644 --- a/reference/README.md +++ b/reference/README.md @@ -1,5 +1,5 @@ --- -title: API reference +title: Video and live stream API reference toc: true breadcrumbs: false meta: @@ -56,7 +56,7 @@ Follow these best practices to secure your API keys: api.video limits the number of accepted API requests **per minute**. The limitation that the API applies to your calls depends on these factors: * the [API environment](https://docs.api.video/reference#environments) you send your calls in -* your [pricing plan](https://api.video/pricing) +* your [pricing plan](https://api.video/pricing/) * the request method that your calls use | | Sandbox | Production | diff --git a/reference/admin-api-overview.md b/reference/admin-api-overview.md index 01e9bc20..7246a144 100644 --- a/reference/admin-api-overview.md +++ b/reference/admin-api-overview.md @@ -1,5 +1,5 @@ --- -title: Admin API +title: Admin API management tool overview meta: description: This guide introduces and explains the usage of api.video's Admin API. breadcrumbs: false diff --git a/reference/attribute-required.md b/reference/attribute-required.md index 13e2dc21..047ce6aa 100644 --- a/reference/attribute-required.md +++ b/reference/attribute-required.md @@ -1,5 +1,5 @@ --- -title: Attribute required +title: Attribute required error documentation meta: description: This guide explains the cause and the possible solutions for the Attribute required error. --- diff --git a/reference/basic-authentication.md b/reference/basic-authentication.md index ba9e45c7..fb2a86bc 100644 --- a/reference/basic-authentication.md +++ b/reference/basic-authentication.md @@ -1,5 +1,5 @@ --- -title: Basic authentication +title: Basic authentication for api.video REST API meta: description: This guide explains the basic authentication method for api.video's API. --- diff --git a/reference/create-and-manage-webhooks.md b/reference/create-and-manage-webhooks.md index 58d339af..2692293c 100644 --- a/reference/create-and-manage-webhooks.md +++ b/reference/create-and-manage-webhooks.md @@ -1,5 +1,5 @@ --- -title: Webhooks +title: Create, manange, and verify webhooks meta: description: api.video provides webhook notifications in the form of `POST` requests, with a JSON payload that contains detailed event data. Webhooks can push notifications directly to your server, saving you the need to poll api.video for changes. This guide goes over how to create and manage your webhooks. --- diff --git a/reference/postman-collection.md b/reference/postman-collection.md index 463464d4..f62ec961 100644 --- a/reference/postman-collection.md +++ b/reference/postman-collection.md @@ -1,5 +1,5 @@ --- -title: Postman Collection +title: api.video Postman collection meta: description: This guide explains how you can fork the official api.video Postman collection. --- diff --git a/reference/uploaded-file-multiple-files.md b/reference/uploaded-file-multiple-files.md index e535b7a0..61af003b 100644 --- a/reference/uploaded-file-multiple-files.md +++ b/reference/uploaded-file-multiple-files.md @@ -18,7 +18,7 @@ You can't attach multiple videos to the same upload request. One video or chunk ### Tutorials -* [Private video upload with a public token](https://api.video/blog/product-updates/video-access-management-how-to-create-deliver-and-manage-private-videos-and-what//) +* [Private video upload with a public token](https://api.video/blog/product-updates/video-access-management-how-to-create-deliver-and-manage-private-videos-and-what/) * [Video upload](https://api.video/blog/tutorials/video-upload-tutorial/) ### Tools diff --git a/reference/video-content-range-by-part-part-too-high-total.md b/reference/video-content-range-by-part-part-too-high-total.md index 2a359fd1..dedf72b8 100644 --- a/reference/video-content-range-by-part-part-too-high-total.md +++ b/reference/video-content-range-by-part-part-too-high-total.md @@ -1,5 +1,5 @@ --- -title: Part Too High Total +title: Part Too High Total error documentation meta: description: This guide explains the cause for the Part Too High Total error. --- diff --git a/reference/video-upload-errors.md b/reference/video-upload-errors.md index 2f60cbdd..e5e85e0e 100644 --- a/reference/video-upload-errors.md +++ b/reference/video-upload-errors.md @@ -1,5 +1,5 @@ --- -title: Video Upload Errors +title: Video Upload error documentation meta: description: This guide lists all the possible Video Upload Errors that you may encounter when using api.vide. --- diff --git a/sdks/README.md b/sdks/README.md index 4c321006..635111db 100644 --- a/sdks/README.md +++ b/sdks/README.md @@ -2,6 +2,7 @@ hide_navigation: false toc: false breadcrumbs: false +title: Video, live stream, and analytics libraries and SDKs meta: description: Cloud-based video hosting and live streaming platform with analytics. Mobile and web SDKs for VOD, live streaming, and player for NodeJS, Javascript, Typescript, Python, Go, PHP, C#, Swift, and Kotlin. --- diff --git a/sdks/api-clients/README.md b/sdks/api-clients/README.md index 8b64bda1..63c74356 100644 --- a/sdks/api-clients/README.md +++ b/sdks/api-clients/README.md @@ -1,5 +1,5 @@ --- -title: API client libraries +title: API client libraries for server-side or mobile toc: false breadcrumbs: false meta: diff --git a/sdks/livestream/README.md b/sdks/livestream/README.md index 22777e12..678024dd 100644 --- a/sdks/livestream/README.md +++ b/sdks/livestream/README.md @@ -1,5 +1,5 @@ --- -title: Live stream SDKs +title: Live streaming SDKs for mobile toc: false breadcrumbs: false meta: diff --git a/sdks/nocode/README.md b/sdks/nocode/README.md index c49f81b4..fbd414b9 100644 --- a/sdks/nocode/README.md +++ b/sdks/nocode/README.md @@ -1,5 +1,5 @@ --- -title: No-code solutions +title: No-code solutions, plugins, and integrations toc: false breadcrumbs: false meta: diff --git a/sdks/nocode/all-live-events.md b/sdks/nocode/all-live-events.md index ff3fe513..207e0c74 100644 --- a/sdks/nocode/all-live-events.md +++ b/sdks/nocode/all-live-events.md @@ -1,5 +1,5 @@ --- -title: All live events +title: All live events - Zapier integration meta: description: Zapier lets you connect APIs and applications together without coding. The all live events Zapier trigger is a combination of 3 alerts - live stream created, live stream ended, and video source recorded. --- diff --git a/sdks/nocode/bubbleio-api-calls.md b/sdks/nocode/bubbleio-api-calls.md index 724c94b2..f63407b2 100644 --- a/sdks/nocode/bubbleio-api-calls.md +++ b/sdks/nocode/bubbleio-api-calls.md @@ -1,5 +1,5 @@ --- -title: Bubble.io API calls +title: Bubble.io plugin - API calls meta: description: You can use the api.video Bubble plugin as a bridge between your Bubble application and the api.video API. --- diff --git a/sdks/nocode/bubbleio-player-element.md b/sdks/nocode/bubbleio-player-element.md index 49a8a8e6..fc163afa 100644 --- a/sdks/nocode/bubbleio-player-element.md +++ b/sdks/nocode/bubbleio-player-element.md @@ -1,5 +1,5 @@ --- -title: Bubble.io player element +title: Bubble.io no-code plugin player element meta: description: Bubble is a no-code tool that lets you build SaaS platforms, marketplaces and CRMs without code. You use the player element to set up video players on your site. --- diff --git a/sdks/nocode/bubbleio-plugin.md b/sdks/nocode/bubbleio-plugin.md index db5b3d52..c51a34ea 100644 --- a/sdks/nocode/bubbleio-plugin.md +++ b/sdks/nocode/bubbleio-plugin.md @@ -1,5 +1,5 @@ --- -title: Bubble.io plugin +title: Bubble.io no-code solution plugin meta: description: The api.video plugin for Bubble.io facilitate the use of api.video services in your Bubble applications. --- diff --git a/sdks/nocode/bubbleio-uploader.md b/sdks/nocode/bubbleio-uploader.md index e4ee3eed..fb69b85c 100644 --- a/sdks/nocode/bubbleio-uploader.md +++ b/sdks/nocode/bubbleio-uploader.md @@ -1,5 +1,5 @@ --- -title: Bubble.io uploader element +title: Bubble.io no-code plugin uploader element metadata: description: Bubble is a no-code tool that lets you build SaaS platforms, marketplaces and CRMs without code. You use the uploader element to upload videos from your web application to api.video. --- diff --git a/sdks/nocode/contentful.md b/sdks/nocode/contentful.md index 56bbabef..a87b4d69 100644 --- a/sdks/nocode/contentful.md +++ b/sdks/nocode/contentful.md @@ -1,5 +1,5 @@ --- -title: Contentful +title: Contentful integration, no-code solution meta: description: The official plugin to facilitate the upload, hosting, and sharing of your videos in your Contentful applications. --- diff --git a/sdks/nocode/create-video.md b/sdks/nocode/create-video.md index dfb21998..f9c310d9 100644 --- a/sdks/nocode/create-video.md +++ b/sdks/nocode/create-video.md @@ -1,5 +1,5 @@ --- -title: Create video +title: Create video - Zapier integration meta: description: Zapier lets you connect APIs and applications together without coding. With the Create video action you can create a video on demand file at api.video. --- diff --git a/sdks/nocode/live-stream-created.md b/sdks/nocode/live-stream-created.md index dd89ebc4..ea216fe3 100644 --- a/sdks/nocode/live-stream-created.md +++ b/sdks/nocode/live-stream-created.md @@ -1,5 +1,5 @@ --- -title: Live stream created +title: Live stream created - Zapier integration meta: description: Zapier lets you connect APIs and applications together without coding. The Live stream created Zapier trigger will fire whenever a new live stream is created at api.video. --- diff --git a/sdks/nocode/live-stream-ended.md b/sdks/nocode/live-stream-ended.md index 9796cbfa..707ac325 100644 --- a/sdks/nocode/live-stream-ended.md +++ b/sdks/nocode/live-stream-ended.md @@ -1,5 +1,5 @@ --- -title: Live stream ended +title: Live stream ended - Zapier integration meta: description: Zapier lets you connect APIs and applications together without coding. The live stream ended webhook will fire when the live-stream.broadcast.ended webhook alert is sent. --- diff --git a/sdks/nocode/live-stream-started.md b/sdks/nocode/live-stream-started.md index 18cbfa45..575eaa1b 100644 --- a/sdks/nocode/live-stream-started.md +++ b/sdks/nocode/live-stream-started.md @@ -1,5 +1,5 @@ --- -title: Live stream started +title: Live stream started - Zapier integration meta: description: Zapier lets you connect APIs and applications together without coding. The live stream started webhook will fire when the live-stream.broadcast.started webhook alert is sent. --- diff --git a/sdks/nocode/strapi.md b/sdks/nocode/strapi.md index 47fe95e8..c0ae70c1 100644 --- a/sdks/nocode/strapi.md +++ b/sdks/nocode/strapi.md @@ -1,5 +1,5 @@ --- -title: Strapi +title: Strapi no-code video plugin meta: description: With the api.video Strapi plugin you can upload and embed your videos into your Strapi website effortlessly. --- diff --git a/sdks/nocode/video-created.md b/sdks/nocode/video-created.md index 3c924b11..63b81876 100644 --- a/sdks/nocode/video-created.md +++ b/sdks/nocode/video-created.md @@ -1,5 +1,5 @@ --- -title: Video created +title: Video created - Zapier integration meta: description: Zapier lets you connect APIs and applications together without coding. The Video Created Zapier trigger will fire whenever a new video is created at api.video. --- diff --git a/sdks/player/README.md b/sdks/player/README.md index 40f33e75..1a69e4cf 100644 --- a/sdks/player/README.md +++ b/sdks/player/README.md @@ -1,5 +1,5 @@ --- -title: Player & analytics SDKs +title: Video player and video analytics SDKs toc: false breadcrumbs: false meta: diff --git a/sdks/security/README.md b/sdks/security/README.md index 3e047745..55f36f02 100644 --- a/sdks/security/README.md +++ b/sdks/security/README.md @@ -1,5 +1,5 @@ --- -title: Security best practices +title: Video API security best practices meta: description: Best practices on SDK and API security that will help secure your application and protect your users. --- diff --git a/sdks/vod/README.md b/sdks/vod/README.md index 60177641..f3b89f7e 100644 --- a/sdks/vod/README.md +++ b/sdks/vod/README.md @@ -1,5 +1,5 @@ --- -title: VOD SDKs +title: VOD SDKs for web and mobile upload toc: false breadcrumbs: false meta: diff --git a/vod/README.md b/vod/README.md index 8e16cc1c..1992dd58 100644 --- a/vod/README.md +++ b/vod/README.md @@ -1,5 +1,5 @@ --- -title: VOD overview +title: VOD overview - upload, host, and share toc: false breadcrumbs: false meta: diff --git a/vod/add-a-permanent-watermark.md b/vod/add-a-permanent-watermark.md index 453bb166..7b806501 100644 --- a/vod/add-a-permanent-watermark.md +++ b/vod/add-a-permanent-watermark.md @@ -1,5 +1,5 @@ --- -title: Watermarks +title: Add permanent watermarks meta: description: Learn how to apply permanent watermarks programmatically to videos uploaded to api.video. --- diff --git a/vod/add-captions.md b/vod/add-captions.md index ae322dcf..a233cc61 100644 --- a/vod/add-captions.md +++ b/vod/add-captions.md @@ -1,5 +1,5 @@ --- -title: Adding captions +title: Adding captions to videos via the API meta: description: This page gets users started on how to add captions to their videos using the api.video Captions endpoint. --- diff --git a/vod/clip-a-video.md b/vod/clip-a-video.md index 692d9a7f..050d947f 100644 --- a/vod/clip-a-video.md +++ b/vod/clip-a-video.md @@ -8,7 +8,7 @@ meta: In some cases, you just need to upload a smaller piece of a video, but you would like to do that programmatically, without resorting to editing programs. -[api.video](http://api.video) allows you to clip a video to upload only specific parts of the video. You will be able to specify the start and end time of the clip before you upload the source video to api.video. +[api.video](https://api.video) allows you to clip a video to upload only specific parts of the video. You will be able to specify the start and end time of the clip before you upload the source video to api.video. A diagram that shows the process of clipping a video @@ -18,7 +18,7 @@ The videos are clipped by the definition of the object. When you create a video ## Usage -You can use one of the API clients offered by [api.video](http://api.video). You can find the list of clients in the [api.video API Client catalog](https://docs.api.video/sdks/api-clients). +You can use one of the API clients offered by [api.video](https://api.video). You can find the list of clients in the [api.video API Client catalog](https://docs.api.video/sdks/api-clients). You can also find more information on the `/videos` endpoints on the [API reference page](https://docs.api.video/reference/api/Videos#create-a-video-object). diff --git a/vod/delegated-upload-tokens.md b/vod/delegated-upload-tokens.md index 5470f187..0280d63e 100644 --- a/vod/delegated-upload-tokens.md +++ b/vod/delegated-upload-tokens.md @@ -1,5 +1,5 @@ --- -title: Delegated upload tokens +title: Delegated video upload tokens meta: description: This guide explains how to create, list, retrieve, and delete delegated upload tokens, and how to upload videos with them. --- diff --git a/vod/delete-a-video.md b/vod/delete-a-video.md index ab2cfbc7..4758b60c 100644 --- a/vod/delete-a-video.md +++ b/vod/delete-a-video.md @@ -1,5 +1,5 @@ --- -title: Delete a video +title: Delete and restore videos meta: description: This guide walks you through the different ways of manually and programmatically removing videos and introduces the Video Restore feature. --- diff --git a/vod/demo-loom-clone.md b/vod/demo-loom-clone.md index 6dd4fa6a..2b70cfd0 100644 --- a/vod/demo-loom-clone.md +++ b/vod/demo-loom-clone.md @@ -1,5 +1,5 @@ --- -title: Loom mockup +title: Loom clone demo, VOD app template meta: description: This guide explains how to create a Loom-like application with api.video. --- diff --git a/vod/demo-youtube-clone.md b/vod/demo-youtube-clone.md index 90d1cb85..720722bb 100644 --- a/vod/demo-youtube-clone.md +++ b/vod/demo-youtube-clone.md @@ -1,5 +1,5 @@ --- -title: YouTube clone +title: YouTube clone - Template and demo meta: description: This guide explains how to create a YouTube-like application with api.video. --- diff --git a/vod/demos-airbnb-clone.md b/vod/demos-airbnb-clone.md index fdca8fa2..bed25d73 100644 --- a/vod/demos-airbnb-clone.md +++ b/vod/demos-airbnb-clone.md @@ -1,5 +1,5 @@ --- -title: Airbnb clone +title: Airbnb clone - Template and demo meta: description: This guide explains how to create an Airbnb-like application with api.video. --- diff --git a/vod/demos-template-overview.md b/vod/demos-template-overview.md index f3942bc4..06a6e955 100644 --- a/vod/demos-template-overview.md +++ b/vod/demos-template-overview.md @@ -1,5 +1,5 @@ --- -title: Demos & templates +title: Video app examples, demos, and templates meta: description: This page lists demo applications and templates that you can use to develop your own video solution using api.video. --- diff --git a/vod/demos-tiktok-clone.md b/vod/demos-tiktok-clone.md index 6661be46..4a175d45 100644 --- a/vod/demos-tiktok-clone.md +++ b/vod/demos-tiktok-clone.md @@ -1,5 +1,5 @@ --- -title: TikTok clone +title: TikTok clone - Template and demo meta: description: This guide explains how to create a TikTok-like application with api.video. --- diff --git a/vod/demos-udemy-clone.md b/vod/demos-udemy-clone.md index 88ac1b5a..036a8d4f 100644 --- a/vod/demos-udemy-clone.md +++ b/vod/demos-udemy-clone.md @@ -1,5 +1,5 @@ --- -title: Udemy clone +title: Udemy clone demo, VOD app template meta: description: This guide explains how to create a Udemy-like application with api.video. --- diff --git a/vod/demos-video-uploader.md b/vod/demos-video-uploader.md index cd516096..9d6cf251 100644 --- a/vod/demos-video-uploader.md +++ b/vod/demos-video-uploader.md @@ -1,5 +1,5 @@ --- -title: Video uploader +title: Video uploader - Template and demo meta: description: This guide explains how to create a backend application than can handle video uploads with api.video. --- diff --git a/vod/encoding-transcoding.md b/vod/encoding-transcoding.md index 1c6f1343..ba362c15 100644 --- a/vod/encoding-transcoding.md +++ b/vod/encoding-transcoding.md @@ -4,16 +4,16 @@ meta: description: This guide explains what video encoding and transcoding means and how api.video enables you to provide your users high quality videos via encoding and transcoding. --- -## Encoding +# Encoding The term encoding is used to describe the process of converting content into a different form. In the context of video - encoding technically only happens when the video is being recorded, and taken from the camera's raw format and saved into a [codec](https://api.video/what-is/codec/). Any further manipulations of the video file (say changing the format, or changing compression values) is transcoding. But, in practice, these two terms are used interchangeably to describe the process of converting a video file from one format to another. -### Why encode a video? +## Why encode a video? Video files are inherently large, so using a codec to compress the video ensures that the file will be much smaller. As codecs get better at compression, we are able to transmit higher quality video for the same amount of data. For that reason, there is a lot of research into new codecs. There are other considerations to undertake when choosing how to encode your video. The [H264](https://api.video/what-is/h-264/), while older and not the best compression, does support the highest browser support - making it a common encoding choice. Newer codecs like [H265](https://api.video/what-is/h-265/), VP9, and AVIF have better compression, but suffer slightly in the realm of browser support for playback. -### Encoding settings +## Encoding settings When using a tool like FFMPEG, you can set the video quality. This determines how much compression there will be/how good the video will look. Higher compression leads to smaller files, but also higher [loss](https://api.video/what-is/lossy-compression/). FFMPEG uses the Constant Rate Factor for encoding quality (values of 0 are lossless, 51 is high compression.) The default value for CRF is 23, and generally creates a video that offers a high compression/quality ratio: ``` @@ -28,7 +28,7 @@ Every video uploaded to api.video is encoded/transcoded into an H264 MP4 and an Transcoding is the process of taking already encoded (or transcoded) content, decompressing it and then using different codecs to alter or recompress it. It's labor intensive because you are taking every part of your video and audio and recompressing it. During this process, depending on what codecs you use, you may lose data. -### What types of transcoding are there? +## What types of transcoding are there? There are three types of transcoding you will encounter: @@ -36,7 +36,7 @@ There are three types of transcoding you will encounter: - Lossless-to-lossy - This is where you take a codec that preserves every detail of a video and transfer it to one that loses data. The trade off results in something useful like faster decompression for playback, or a smaller file. - Lossy-to-lossless - You cannot regain lost quality, so when transcoding in this situation, you retain all the data that was in the lossy compression without further degradation of the file. -### What are the goals of transcoding? +## What are the goals of transcoding? The goals of transcoding are dependent upon your use case. The main reason to transcode video is because you want to use it in a new scenario with a codec that's optimized for that new scenario. For example, say you want to edit a video. You would probably want a codec that's good quality, but which lets you easily move backwards and forwards through the video so you can quickly find the parts of the video you want to clip and edit. A great example of a codec for this purpose would be ProRes. This codec doesn't work for playback with a lot of devices though. So after you're done editing, you would want to transcode to another codec that works for playback. Other scenarios might be something like wanting to store a video for later use. When you store a video, if it's for a project, you might want to store the highest quality possible. Then when you get the video out later to edit again or use in a project, it's got as much information available as possible. Or, maybe you're storing a video just for reference purposes and you don't have a lot of space. Then you might want a codec that compresses efficiently but the video quality is lower. That would be enough for reference later. diff --git a/vod/list-videos-2.md b/vod/list-videos-2.md index b887833e..294530eb 100644 --- a/vod/list-videos-2.md +++ b/vod/list-videos-2.md @@ -1,5 +1,5 @@ --- -title: List videos +title: List or filter video object meta: description: This guide walks through the different options for retrieving videos and covers a method for searching for them using your dashboard. --- diff --git a/vod/show-video-details.md b/vod/show-video-details.md index b06b997a..8b85a698 100644 --- a/vod/show-video-details.md +++ b/vod/show-video-details.md @@ -1,5 +1,5 @@ --- -title: Show video details +title: Retrieve video details via the API meta: description: This guide explains how retrieve video details programmatically and through the api.video dashboard. --- diff --git a/vod/show-video-upload-status.md b/vod/show-video-upload-status.md index c1df4ae2..dbe4d984 100644 --- a/vod/show-video-upload-status.md +++ b/vod/show-video-upload-status.md @@ -1,5 +1,5 @@ --- -title: Video status & details +title: Get video status and details via the API meta: description: This guide explains how retrieve the video upload and encoding status programmatically via the API and through webhooks. --- diff --git a/vod/update-video-details.md b/vod/update-video-details.md index 5209d31c..604a2be2 100644 --- a/vod/update-video-details.md +++ b/vod/update-video-details.md @@ -1,5 +1,5 @@ --- -title: Update video details +title: Update video details through the API meta: description: This guide explains the two methods you can use to update videos - programmatically and through the dashboard. --- diff --git a/vod/upload-a-video-regular-upload.md b/vod/upload-a-video-regular-upload.md index 65c0a68d..a0708f80 100644 --- a/vod/upload-a-video-regular-upload.md +++ b/vod/upload-a-video-regular-upload.md @@ -1,5 +1,5 @@ --- -title: Regular video upload +title: Regular video upload via API meta: description: This guide walks through how to upload videos under 200MiB in size programmatically with api.video. --- diff --git a/vod/video-best-practices.md b/vod/video-best-practices.md index 73a3e275..37ed3a7b 100644 --- a/vod/video-best-practices.md +++ b/vod/video-best-practices.md @@ -1,5 +1,5 @@ --- -title: Video best practices +title: Video management best practices meta: description: This guide provides best practices, limitations, and recommendations on how to work with video on demand via api.video. --- diff --git a/vod/video-download.md b/vod/video-download.md index 3e726a33..45add860 100644 --- a/vod/video-download.md +++ b/vod/video-download.md @@ -6,27 +6,27 @@ meta: # Video Download -After videos have been transcoded on [api.video](http://api.video), it’s natural that you want to give your users the ability to download their videos, or just download the video for your own use, possibly for backup. +After videos have been transcoded on [api.video](https://api.video), it’s natural that you want to give your users the ability to download their videos, or just download the video for your own use, possibly for backup. -[api.video](http://api.video) allows you and your users to download videos directly from the player or programmatically through the API. +[api.video](https://api.video) allows you and your users to download videos directly from the player or programmatically through the API. A diagram that shows the process of video download -## Download a video from [api.video](http://api.video) player +## Download a video from [api.video](https://api.video) player -The video object can be created or updated with the `mp4Support` tag. The tag will make the video downloadable and display a button on the [api.video](http://api.video) player. +The video object can be created or updated with the `mp4Support` tag. The tag will make the video downloadable and display a button on the [api.video](https://api.video) player. ![](/_assets/vod/video-download/download-video-1.png) ![](/_assets/vod/video-download/download-video-2.png) -* By default, the `mp4Support` tag is set to `true`, hence the video is downloadable. If you want to disable the download ability from the [api.video](http://api.video) player, you have to set the `mp4Support` tag to `false` +* By default, the `mp4Support` tag is set to `true`, hence the video is downloadable. If you want to disable the download ability from the [api.video](https://api.video) player, you have to set the `mp4Support` tag to `false` * If you don’t want the user to be able to download the video, do not serve the mp4 asset. ## Disabling download -You can use one of the API clients offered by [api.video](http://api.video). You can find the list of clients in the [api.video API Client catalog](https://docs.api.video/sdks/api-clients). +You can use one of the API clients offered by [api.video](https://api.video). You can find the list of clients in the [api.video API Client catalog](https://docs.api.video/sdks/api-clients). You can also find more information on the `/videos` endpoints on the [API reference page](https://docs.api.video/reference/api/Videos#create-a-video-object). @@ -347,7 +347,7 @@ func main() { Most players support download, however, if you would like to add a download button to a custom player that doesn’t have a download button, it’s also possible. -By leveraging the API, you can create a request to [api.video](http://api.video), which will get the video id and then render a download button serving the mp4 asset. +By leveraging the API, you can create a request to [api.video](https://api.video), which will get the video id and then render a download button serving the mp4 asset. In this example, you will learn how to create a custom download button with React and Node.js backend @@ -384,7 +384,7 @@ const serverHostname = "localhost:5500" const handleClick = async (sourceVideoId) => { try { // replace the server hostname with your - const response = await fetch(`http://${serverHostname}/download?videoId=${sourceVideoId}`, { + const response = await fetch(`https://${serverHostname}/download?videoId=${sourceVideoId}`, { method: 'GET', }); if (!response.ok) { @@ -473,7 +473,7 @@ $ npm init Now edit the index.js file that you’ve created, and copy this code. -Make sure that you copy your API key from the [api.video](http://api.video) dashboard and replace the port to the port you would like to run the server on. +Make sure that you copy your API key from the [api.video](https://api.video) dashboard and replace the port to the port you would like to run the server on. diff --git a/vod/video-management-basics.md b/vod/video-management-basics.md index 7e9efecf..92b363e6 100644 --- a/vod/video-management-basics.md +++ b/vod/video-management-basics.md @@ -1,5 +1,5 @@ --- -title: Video management basics +title: Video management - basic operations meta: description: This page serves as a foundational guide to the different operations using api.video's solutions for video on demand (VOD). These are list videos, show and update video details, add thumbnail to videos, and delete videos. --- diff --git a/vod/video-object.md b/vod/video-object.md index 543bcc6e..bf3c0547 100644 --- a/vod/video-object.md +++ b/vod/video-object.md @@ -1,5 +1,5 @@ --- -title: What is a video object? +title: Video object - creation and parameters meta: description: Short guide to explain what api.video video objects are. ---