Skip to content

Commit

Permalink
Merge pull request #309 from apivideo/metadata-desc-update
Browse files Browse the repository at this point in the history
Metadata desc update
  • Loading branch information
szekelyzol authored Oct 19, 2023
2 parents 254c0de + e0ea8ac commit eab833b
Show file tree
Hide file tree
Showing 13 changed files with 50 additions and 56 deletions.
4 changes: 3 additions & 1 deletion templates/documentation/delivery-analytics/ads.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "In-stream ads"
title: api.video In-stream ads
metadata:
description: Leverage the power of api.video to insert in-stream, VAST, VPAID and VMAP ads into your videos.
---

In-stream ads
Expand Down
5 changes: 2 additions & 3 deletions templates/documentation/delivery-analytics/analytics.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
title: "Analytics & data"
slug: "analytics"
title: Analytics & data
metadata:
description: "Learn how you can get data insights for your videos and live streams using api.video's Analytics solution."
description: Learn how you can get data insights for your videos and live streams using api.video's Analytics solution.
---

# Analytics & data
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Delivery and Analytics with api.video"
excerpt: "Set up the api.video player and start working with video analytics in 5 minutes"
title: Delivery and Analytics with api.video
metadata:
description: Set up the api.video player and start working with video analytics in 5 minutes
---

# Getting started with delivery and analytics
Expand Down
6 changes: 3 additions & 3 deletions templates/documentation/delivery-analytics/domain-referrer.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Domain Referrer Restriction"
excerpt: "Secure your videos and live streams by restricting from where the content is being consumed"
title: Video Domain Restriction
metadata:
description: Secure your videos and live streams by restricting from where the content is being consumed
---

# Domain Referrer

Domain referrer restrictions are a great way to make sure that your videos or live streams are secure and being consumed specifically through your domain or subdomains.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
title: "Player customization"
slug: "player-customization"
title: api.video Player customization
metadata:
description: This guide explains the customization options for the api.video player. You can define your brand's color scheme, include your company logo with their player, and define the available player controls for your users.
description: Take control of your brand and player behavior by implementing the api.video player customization features.
---

Player customization
==========================
# Player customization

api.video enables you to customize the api.video player and match your brand's color scheme, as well as include your company logo with the player.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: "Private video delivery with api.video players"
title: Private video playback and delivery
metadata:
description: "Private videos are a way to giving access to videos only to certain users and making sure that privacy concerns are covered. This section will provide a detailed explanation on how you can deliver private videos with api.video's player."
description: Manage and control the access of users to the videos that you publish.
---

Private video delivery with api.video players
=============================================
# Private video delivery with api.video players

The recommended way and easiest way to deliver private videos is with our in-house player. This method will allow you to delivery the private videos without additional coding efforts and without handling any extra parameters.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Private video delivery with MP4 built-in players"
title: Private mp4 video playback and delivery
metadata:
description: "Private videos are a way to giving access to videos only to certain users and making sure that privacy concerns are covered. This section will provide a detailed explanation on how you can deliver private videos with MP4 built-in players."
description: Manage and control the access to mp4 videos that you publish with api.video.
---

Private Video Delivery With Mp4 Built In Players
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Get started with private videos"
metadata:
description: The quickest and simplest way to take control and manage the access to videos you've published with api.video
---

Get started with private videos
===========================================================
# Get started with private videos

This article explains how to secure and limit access to videos.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: "Private video delivery with HLS built-in players"
slug: "private-video-on-hls-or-external-players"
title: Private video delivery with HLS built-in players
metadata:
description: "Private videos are a way to giving access to videos only to certain users and making sure that privacy concerns are covered. This section will provide a detailed explanation on how you can deliver private videos with HLS built-in players."
description: Manage and control the access to mp4 videos that you publish with api.video.
---
Private Video On Hls Or External Players
========================================

# Private Video On Hls Or External Players

{% capture content %}
api.video recommends that you read [Private Videos](/delivery-analytics/video-privacy-access-management) to ensure that you understand the concept of private videos before proceeding.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: "Private Video Session Tokens"
title: Private Video Session Tokens
metadata:
description: "Private videos are a way to giving access to videos only to certain users and making sure that privacy concerns are covered. This section will provide a detailed explanation on how private video session tokens work."
description: Control the access of users to secured and private videos while retraining the browser session.
---

Private Video Session Tokens
============================
# Private Video Session Tokens

In order to preserve the session and give the ability to make requests to multiple endpoints while opening the private videos. The session preservation is done via session token. When you are building your own player or you would like to consume multiple assets in the same session, like the thumbnail, you will have to use the session token to retain the session.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: "Private videos with custom players & session retention"
title: Private video session retention on custom players
metadata:
description: "Private videos are a way to giving access to videos only to certain users and making sure that privacy concerns are covered. This section will provide a detailed explanation on how you can deliver private videos with custom players, and how session retention works."
description: Retain a private video session on custom player with api.video.
---

Private Videos With Custom Players Session Retention
====================================================
# Private Videos With Custom Players Session Retention


There are quite a few cases where you would want to include other assets in the session where you play your video. In example:
* Displaying a clickable thumbnail that redirects to your video
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
title: "Using custom domains"
slug: "using-custom-domains"
title: Using custom domains
slug: using-custom-domains
hidden: false
metadata:
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."
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.
---
Using Custom Domains
====================
# Using Custom Domains

api.video enables you to deliver video content and provide live streams using your own custom domains. You can decide what custom URL or subdomain you use in your implementation, for example `live.mycustomdomain.com`.

Expand Down
28 changes: 13 additions & 15 deletions templates/documentation/sdks/nocode/contentful.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
---
title: "Contentful"
slug: "contentful"
excerpt: "The official plugin to facilitate the use of api.video in your Contentful applications."
metadata:
title: "Contentful • Plugins • api.video Documentation"
description: "The official plugin to facilitate the upload, hosting and sharing of your videos in your Contentful applications."
description: "The official plugin to facilitate the upload, hosting, and sharing of your videos in your Contentful applications."
---
# Contentful

Contentful Empower creative teams to visually craft captivating content experiences - without writing a single line of code, and now you can easily add and deliver videos from your Contentful page with few simple steps using api.video.
Contentful empowers creative teams to visually craft captivating content experiences - without writing a single line of code, and now you can easily add and deliver videos from your Contentful page with few simple steps using api.video.

## Getting started with Contentful

Expand All @@ -25,43 +23,43 @@ If you need help with getting started with Contentful, you can follow the [Conte

Log into your Contentful account and add the [api.video app](https://www.contentful.com/marketplace/app/api-video/) by clicking Apps -> Marketplace

![](/_assets/nocode/contentful/contentful-marketplace.png)
![Entering the Contentful Marketplace](/_assets/nocode/contentful/contentful-marketplace.png)

Select the Featured tab and search for the api.video plugin in the search bar

![](/_assets/nocode/contentful/contentful-search.png)
![Searching for the api.video plugin on the Contentful Marketplace](/_assets/nocode/contentful/contentful-search.png)

Once you've found the api.video plugin, click on the icon. You will get a new page where you see the ability to install the plugin, click on Install and authorize the access for api.video
Once you've found the api.video plugin, click on the icon. You will get a new page where you can install the plugin. Click on Install and authorize the access for api.video

![](/_assets/nocode/contentful/contentful-auth.png)
![Authorizing access to api.video](/_assets/nocode/contentful/contentful-auth.png)

Enter your [api.video API key](https://docs.api.video/reference/authentication-guide#retrieve-your-apivideo-api-key) an click Install

![](/_assets/nocode/contentful/contentful-apikey.png)
![Entering your api.video API key](/_assets/nocode/contentful/contentful-apikey.png)

Congratulations! you have installed the api.video plugin successfully!

## Usage

After a successful installation, we can to the fun part of adding videos to our content. All you have to do is create a JSON object with the api.video video appearance type.
After a successful installation, you cannow add videos to your content. All you have to do is create a JSON object with the api.video `video appearance` type.

### Adding api.video to the Content Model

1. Create or edit an existing Content Model
2. Add a new field with a JSON object type
![](/_assets/nocode/contentful/contentful-select-object.png)
![Selecting the JSON object](/_assets/nocode/contentful/contentful-select-object.png)
3. Give the new JSON object a name and api key
![](/_assets/nocode/contentful/contentful-field-name.png)
![Naming the JSON field](/_assets/nocode/contentful/contentful-field-name.png)
4. Click on Add and Configure
5. On the configuration page, scroll down to Appearance and select api.video and save the settings
![](/_assets/nocode/contentful/contentful-appearance.png)
![Selecting the field appearance](/_assets/nocode/contentful/contentful-appearance.png)
6. Now that you have a video JSON object, you can create or edit an entry in the Content and add a video.

### Adding videos to your content

1. In the Content menu, click on add an entry or edit an previous entry (to which you've added the JSON object)
2. Select the Content type that you want to use (the one you've added the JSON object to)
3. Now you will see that you can either upload a video or select from existing videos that you've uploaded to api.video
![](/_assets/nocode/contentful/contentful-new-entry.png)
![Adding an entry with video content](/_assets/nocode/contentful/contentful-new-entry.png)
4. Once you've selected the video you want to add, you will see the video appearing in the content editor
![](/_assets/nocode/contentful/contentful-selected-video.png)
![Showing the video preview for the selected video](/_assets/nocode/contentful/contentful-selected-video.png)

0 comments on commit eab833b

Please sign in to comment.