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

feat(doc) add initial content #10

Merged
merged 1 commit into from
Aug 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
150 changes: 131 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,139 @@
[![badge](https://img.shields.io/twitter/follow/api_video?style=social)](https://twitter.com/intent/follow?screen_name=api_video)
  [![badge](https://img.shields.io/github/stars/apivideo/api.video-documentation?style=social)](https://github.com/apivideo/api.video-documentation)
  [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video)
![](https://github.com/apivideo/.github/blob/main/assets/apivideo_banner.png)
<h1 align="center">api.video documentation</h1>
---
hide_navigation: false
hide_side_table_of_contents: true
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#, iOS Swift, Android Kotlin.
---

[api.video](https://api.video) is the video infrastructure for product builders. Lightning fast
video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in
your app.
<div class="hero">

# Table of contents
### New to api.video?

- [Table of contents](#table-of-contents)
- [Project description](#project-description)
- [FAQ](#faq)
# Get started [here](/get-started/start-building.md)!

# Project description
<!-- These are just example buttons, we can remove them:
<div class="links">

This repository contains the markdown files and the OpenAPI description used to generate the
documentation of the api.video.
[Register for free](https://dashboard.api.video/register)

The content of this repository is generated by the api.video API client generator.
</div> -->

# FAQ

If you have any questions, ask us in the [community](https://community.api.video). Or
use [issues](https://github.com/apivideo/api.video-documentation/issues).
</div>

Welcome to the developer documentation of api.video! Our platform empowers developers and businesses to seamlessly integrate video functionality into their applications and services. Whether you're looking to offer video on demand, live streaming, or leverage our player and analytics features, the api.video API is designed to simplify the process.

Check out the products:

<div class="product-grid">

{% capture vod-description %}

api.video's hosting service enables users to upload and store videos, which can then be easily delivered and shared across various devices and platforms.

<br>

{% endcapture %}

{% capture live-stream-description %}

api.video provides you with the possibility to embed live streaming into your application or project seamlessly.

<br>

<br>

{% endcapture %}

{% capture player-analytics-description %}

api.video lets you customize a large part of the delivery, whether it's the player's branding or adding captions, chapters, and watermarks.

<br>

<br>

{% endcapture %}

{% include "_partials/vod-product-grid-item.md" product: "Video", subheading: "on demand", description: vod-description, link: "/vod/README.md" %}
{% include "_partials/live-stream-product-grid-item.md" product: "Live", subheading: "streaming", description: live-stream-description, link: "/live-streaming/README.md" %}
{% include "_partials/player-analytics-product-grid-item.md" product: "Player", subheading: "& analytics", description: player-analytics-description, link: "/delivery-analytics/README.md" %}

</div>

<br>

# Start working with api.video

<div class="quick-links">

{% capture quick-link-table-item-1-description %}

This is where the quick links table will go.

{% endcapture %}

{% include "_partials/quick-link-item.md" table-name: "Quick links", description: quick-link-table-item-1-description, link: "/vod/get-started-in-5-minutes.md" %}
{% include "_partials/quick-link-item.md" table-name: "Quick links", description: quick-link-table-item-1-description, link: "/vod/get-started-in-5-minutes.md" %}

</div>

<br>

# Need help?

<!-- Support cards, CSS should be moved to _assets/style.css -->

<div style="display: flex; flex-direction: row; flex-wrap: wrap; gap: 40px">
<a href="https://help.api.video/en/" target="_self" style="text-decoration: none">

<div
style="
display: flex;
align-items: center;
gap: 24px;
padding: 36px;
width: 472px;
height: 104px;
border-radius: 4px;
background: #fff;
box-shadow: 0px 20px 50px 0 rgba(59, 43, 92, 0.1);
"
>
<div
style="
background-color: #e9dded;
width: 56px;
height: 56px;
border-radius: 2px;
display: flex;
justify-content: center;
align-items: center;
"
>
<div style="width: 32px; height: 32px">
<img
style="object-fit: contain; width: 100%; height: 100%"
src="https://img.api.video/help_center_black_ec703b4744.svg"
alt="logo help center"
/>
</div>
</div>
<span
style="
font-size: 18px;
font-weight: 600;
text-align: left;
color: #414f6e;
flex: 1;
"
>
Browse the Help Center
</span>
<img
style="width: 24px; height: 24px"
src="https://img.api.video/arrow_forward_ios_6206f171e8.svg"
alt="logo arrow"
/>
</div>
</a>
Binary file added _assets/API Keys.png
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.
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.
Binary file added _assets/Create a video flowchart.png
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.
Binary file added _assets/Overview Preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _assets/Production API Key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _assets/SB_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _assets/Screen Shot 2022-02-02 at 9.30.21 PM.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _assets/Screenshot 2021-10-22 at 14.25.03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _assets/Screenshot 2021-10-22 at 20.11.10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _assets/Screenshot 2021-10-22 at 20.41.06.png
Binary file added _assets/Screenshot 2021-10-22 at 21.30.46.png
Binary file added _assets/Screenshot 2021-10-22 at 21.38.17.png
Binary file added _assets/Screenshot 2021-10-22 at 21.41.52.png
Binary file added _assets/Screenshot 2021-10-25 at 13.40.41.png
Binary file added _assets/Screenshot 2023-03-13 at 10.49.30.png
Binary file added _assets/Screenshot 2023-03-13 at 10.53.12.png
Binary file added _assets/Screenshot 2023-03-13 at 10.58.17.png
Binary file added _assets/Screenshot 2023-03-13 at 11.02.36.png
Binary file added _assets/Screenshot 2023-03-13 at 11.07.45.png
Binary file added _assets/Screenshot 2023-03-13 at 11.13.49.png
Binary file added _assets/Screenshot 2023-03-13 at 11.16.25.png
Binary file added _assets/Screenshot 2023-03-13 at 11.20.17.png
Binary file added _assets/Screenshot 2023-03-13 at 11.23.41.png
Binary file added _assets/Screenshot 2023-03-13 at 11.26.03.png
Binary file added _assets/Session Token.jpg
Binary file added _assets/Video Object form.png
Binary file added _assets/Video details.png
Binary file added _assets/add-thumbnail.png
Binary file added _assets/addingavideo.png
Binary file added _assets/api.video-usages-view.png
Binary file added _assets/apivideoapp.jpg
Binary file added _assets/avh-parameter.png
Binary file added _assets/captions_page.png
Binary file added _assets/chapters_page.png
Binary file added _assets/create-a-live-stream.png
Binary file added _assets/create_player_page.png
Binary file added _assets/custom-domains.png
Binary file added _assets/delete-video.png
Binary file added _assets/domain-referrer-fig-1.png
Binary file added _assets/domain-referrer-fig-2.png
Binary file added _assets/favicon.ico
Binary file not shown.
Binary file added _assets/how-api-video-works.jpg
Binary file added _assets/image.png
191 changes: 191 additions & 0 deletions _assets/landing.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
.hero {
text-align: left;
max-width: 42rem;
margin-left: auto;
margin-right: auto;
}

.hero h1 {
font-weight: 200 !important;
font-size: 64px !important;
}

.hero .links {
display: flex;
justify-content: center;
gap: 2rem;
}

.hero .links > p:first-child a {
background: var(--doctave-theme-main);
color: #fff !important;
border-radius: 4px;
padding-left: 1.5rem;
padding-right: 1.5rem;
padding-top: 0.7rem;
padding-bottom: 0.7rem;
}

.dark .hero .links > p:nth-child(2) a {
border: 0px;
}
.hero .links > p:nth-child(2) a {
border: 1px solid var(--doctave-theme-main);
color: var(--doctave-theme-main);
background: #fff !important;
text-decoration: none;
border-radius: 4px;
padding-left: 1.5rem;
padding-right: 1.5rem;
padding-top: 0.7rem;
padding-bottom: 0.7rem;
}

.starter-guides {
padding-top: 4rem;
}

.starter-guides h2 {
margin-top: 0px !important;
font-size: 14px !important;
text-transform: uppercase;
}

.starter-guides p {
margin-top: 0px !important;
}

.starter-guides .starter-guide-link a {
display: block;
text-align: center;
color: #fff !important;
text-decoration: none !important;
width: 100%;
border-radius: 4px;
background: red;
padding: 0.7rem;
background: rgb(211, 188, 74);
background: linear-gradient(
108deg,
rgb(78, 179, 223) 0%,
rgb(140, 117, 201) 100%
);
}

.starter-guides .starter-guide-link a:hover {
text-decoration: underline !important;
text-decoration-color: #fff;
}

.help-center {
padding-top: 4rem;
}

.help-center h2 {
margin-top: 0px !important;
font-size: 14px !important;
}

.help-center p {
margin-top: 0px !important;
}

.help-center .help-center-link a {
display: block;
text-align: center;
color: #fff !important;
text-decoration: none !important;
width: 100%;
border-radius: 4px;
background: red;
padding: 0.7rem;
background: rgb(211, 188, 74);
background: linear-gradient(
108deg,
rgb(78, 179, 223) 0%,
rgb(140, 117, 201) 100%
);
}

.help-center .help-center-link a:hover {
text-decoration: underline !important;
text-decoration-color: #fff;
}

.product-grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(220px, 1fr));
grid-gap: 2rem;
}

.product-grid-item {
box-shadow: rgba(0, 0, 0, 0.1) 0px 4px 12px;
border-radius: 4px;
overflow: hidden;
}

.product-grid-item-header * {
margin: 0 !important;
color: #fff !important;
}
.product-grid-item-header p {
font-weight: 200 !important;
}
.product-grid-item-header {
padding-left: 2rem;
padding-right: 2rem;
padding-top: 5.5rem;
padding-bottom: 2rem;
}

.product-grid-item-header.Video {
background: rgb(211, 74, 191);
background: linear-gradient(
38deg,
rgba(211, 74, 191, 1) 0%,
rgba(253, 187, 45, 1) 100%
);
}

.product-grid-item-header.Live {
background: rgb(201, 74, 211);
background: linear-gradient(
38deg,
rgba(201, 74, 211, 1) 0%,
rgba(102, 45, 253, 1) 100%
);
}

.product-grid-item-header.Player {
background: rgb(201, 74, 211);
background: linear-gradient(
38deg,
rgb(78, 179, 223) 0%,
rgb(140, 117, 201) 100%
);
}

.product-grid-item-body {
padding: 2rem;
}

.product-grid-item-body p {
font-size: 14px;
margin: 0 !important;
}

.product-grid-item-body a {
display: inline-block;
border-radius: 4px;
margin-top: 0.5rem;
background: rgb(250, 91, 48, 0.2);
padding-left: 1rem;
padding-right: 1rem;
padding-top: 0.5rem;
padding-bottom: 0.5rem;
text-decoration: none !important;
}

.product-grid-item-body a:hover {
background: rgb(250, 91, 48, 0.3);
}
Binary file added _assets/link-to-video.png
Binary file added _assets/live stream details.png
Binary file added _assets/live_stream_page.png
Binary file added _assets/live_stream_popup.png
Binary file added _assets/live_stream_recorded.png
17 changes: 17 additions & 0 deletions _assets/logo-dark.svg
Loading