Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Metadata desc update #309

Merged
merged 3 commits into from
Oct 19, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion templates/documentation/delivery-analytics/ads.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: "In-stream ads"
title: api.video In-stream ads
slug: 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
6 changes: 3 additions & 3 deletions templates/documentation/delivery-analytics/analytics.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Analytics & data"
slug: "analytics"
title: Analytics & data
slug: analytics
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,8 @@
---
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
slug: delivery-analytics-quickstart
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved
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
7 changes: 4 additions & 3 deletions templates/documentation/delivery-analytics/domain-referrer.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: "Domain Referrer Restriction"
excerpt: "Secure your videos and live streams by restricting from where the content is being consumed"
title: Video Domain Restriction
slug: domain-referrer
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved
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,11 @@
---
title: "Player customization"
slug: "player-customization"
title: api.video Player customization
slug: player-customization
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved
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,11 @@
---
title: "Private video delivery with api.video players"
title: Private video playback and delivery
slug: private-video-delivery-web-browser
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved
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,8 @@
---
title: "Private video delivery with MP4 built-in players"
title: Private mp4 video playback and delivery
slug: private-video-delivery-with-mp4-built-in-players
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved
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,10 @@
---
title: "Get started with private videos"
slug: private-video-get-started
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved
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,11 @@
---
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
slug: private-video-on-hls-or-external-players
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved
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,11 @@
---
title: "Private Video Session Tokens"
title: Private Video Session Tokens
slug: private-video-session-tokens
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved
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 a browser session.
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved
---

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,12 @@
---
title: "Private videos with custom players & session retention"
title: Private video session retention on custom players
slug: private-videos-with-custom-players-session-retention
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved
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
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved
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
79 changes: 38 additions & 41 deletions templates/documentation/sdks/nocode/contentful.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,65 +6,62 @@ 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."
---
Contentful
==========
# Contentful

Using [api.video with Contentful](https://www.contentful.com/marketplace/app/api-video/) is easy!
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.
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved

Log into your Contentful account and add the [api.video app](https://www.contentful.com/marketplace/app/api-video/) by clicking "Apps" and then "Manage apps" in the main navigation bar.
## Getting started with Contentful

Input your api.video API key first. You'll also notice that a list of your JSON objects is listed. The api.video app should be connected to JSON object types in Contentful. If you don't see any objects listed, that's ok. We'll add a JSON object in the next step.
If you need help with getting started with Contentful, you can follow the [Contentful getting started guide](https://www.contentful.com/help/contentful-101/).

![Managing your api.video app in Contentful](/_assets/apivideoapp.jpg)
## api.video Contentful plugin features

## Adding api.video to content models
* Upload videos–up to 4k–directly in the Contentful UI; they’ll be quickly encoded and ready for streaming in seconds.
* Search and select previously uploaded videos from your api.video library.
* Update video titles, descriptions, caption & chapter files, and even tags and metadata in the Contentful UI.
* Embed videos with our responsive & fully customizable HTML5 player.

In this section, we'll add api.video to 2 different content models:
## Installing the api.video plugin

1. A new JSON object
2. Add it to the Component:Video Object
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)
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved

### A new JSON object
Select the Featured tab and search for the api.video plugin in the search bar

In the top menu, select "Content Model," and a new page will open with all the models/components in your app. Choose the "Add content type" button on the top right to begin creating a new type:
![](/_assets/nocode/contentful/contentful-search.png)
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved

1. The video field
First, you will name your model, and then the UI will walk you through adding fields. Click the blue button to add a field and add a JSON Object. You'll be asked to name the field - choose a name that reminds you that it is an api.video object that is being added.
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

Click the "Create and Configure" button, and under "Appearance," choose api.video.
![](/_assets/nocode/contentful/contentful-auth.png)
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved

2. Name field:
Create a new field, text, Short text, and when you configure the item, click the "Entry title" button. (If you do not add this step, every object you add will be named "Untitled," which is less than ideal.)
Enter your [api.video API key](https://docs.api.video/reference/authentication-guide#retrieve-your-apivideo-api-key) an click Install

### Modifying the Component:video model
![](/_assets/nocode/contentful/contentful-apikey.png)
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved

Contentful has a built-in video model to which you can add the api.video app. Let's walk through the steps to do that.
Congratulations! you have installed the api.video plugin successfully!

In the "Content Model" section, click on the "Component:Video" model. This will give you a page that shows all the fields in the model. It has 2 fields, the title, and a YouTube Video Id by default. We'll modify this so that you can still use a YouTube video Id, but you can also add an api.video object.
## Usage

#### Add the api.video object
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.
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved

Click the "add field" button on the right. Add a JSON object, and name the field "apivideo" or another term that helps you remember where the videos will be stored. Click the "Create and Configure" button, and then under Appearance, add the api.video app.
### 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)
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved
3. Give the new JSON object a name and api key
![](/_assets/nocode/contentful/contentful-field-name.png)
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved
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)
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved
6. Now that you have a video JSON object, you can create or edit an entry in the Content and add a video.

#### Edit the YouTube object
### Adding videos to your content

The Component:Video model is designed to only work with YouTube, and one of the settings is that the YouTube video Id is required. We're making this model more flexible (YouTube AND api.video), so we need to remove this requirement. Click the settings button, and under "Validation," you'll uncheck the "Required field" checkbox.

## Adding api.video videos to Contentful

The process is very similar - no matter which type of object you created in the last step.

### Using the Content section

In the top menu, choose content, and then pick the model you wish to use (in the screenshots, I've used the Component:Video model.)


The title is 'My Awesome video,' and I'm skipping the YouTube section - it's no longer required! With the api.video app, you can choose a video already uploaded to api.video ("select an existing video") or upload a new video (descriptively named "upload a new video").

![Adding a video component](/_assets/addingavideo.png)

Now publish the content, and you've added the video for playback!

You can also add the content model to a page you are building and follow the same steps to add an api.video to your site.
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)
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved
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)
szekelyzol marked this conversation as resolved.
Show resolved Hide resolved
Loading