diff --git a/theolive/contribution/software-encoders/obs.md b/theolive/contribution/software-encoders/obs.md index bc12bc324c4f..effe19e529b4 100644 --- a/theolive/contribution/software-encoders/obs.md +++ b/theolive/contribution/software-encoders/obs.md @@ -60,7 +60,7 @@ Hit apply on settings, close the window, and click on _Start Streaming_ in the _ Your THEOlive channel must be started in order to receive video ingest from OBS. You can choose to start up your channel before or after you start streaming via OBS. -Starting a channel can be done either [through the API](../../api/start-a-channel-will-start-all-connected-engines.api.mdx) or via [the console](https://console.theo.live/). +Starting a channel can be done either [through the API](../../api/start-channel.api.mdx) or via [the console](https://console.theo.live/). ![Start your channel](../../assets/img/consolechannelstart.png) diff --git a/theolive/contribution/software-encoders/vmix.md b/theolive/contribution/software-encoders/vmix.md index 6214954f188e..54377fde8b73 100644 --- a/theolive/contribution/software-encoders/vmix.md +++ b/theolive/contribution/software-encoders/vmix.md @@ -57,4 +57,4 @@ You can now save and exit out of all the _Streaming Settings_ menus and click th ## 4. Start your THEOlive channel -This can be done either through the [API](../../api/start-a-channel-will-start-all-connected-engines.api.mdx) or via the [management console](https://console.theo.live/). +This can be done either through the [API](../../api/start-channel.api.mdx) or via the [management console](https://console.theo.live/). diff --git a/theolive/contribution/software-encoders/wirecast.md b/theolive/contribution/software-encoders/wirecast.md index 11fe44750b58..816d7c724243 100644 --- a/theolive/contribution/software-encoders/wirecast.md +++ b/theolive/contribution/software-encoders/wirecast.md @@ -68,4 +68,4 @@ Click the "Stream" button. Wirecast will make a connection to the THEOlive RTMP ## 4. Start your THEOlive channel -This can be done either through the [API](../../api/start-a-channel-will-start-all-connected-engines.api.mdx) or via the [management console](https://console.theo.live/). +This can be done either through the [API](../../api/start-channel.api.mdx) or via the [management console](https://console.theo.live/). diff --git a/theolive/contribution/stream-configuration.mdx b/theolive/contribution/stream-configuration.mdx index d31d0fd59501..7db6f176ceaf 100644 --- a/theolive/contribution/stream-configuration.mdx +++ b/theolive/contribution/stream-configuration.mdx @@ -14,7 +14,7 @@ THEOlive offers pre-defined ABR profiles (or "presets") which allows you to adju ## Setting the stream configuration via the `streamConfig` object -The goal is to pass a `streamConfig` object during the [creation](../api/create-a-new-channel.api.mdx) of a channel, or when [updating](../api/update-a-channel-by-id.api.mdx) it. This object consists of: +The goal is to pass a `streamConfig` object during the [creation](../api/create-channel.api.mdx) of a channel, or when [updating](../api/update-channel.api.mdx) it. This object consists of: - `bitrate`: the max bitrate value that will be used in Mbps. - `resolution`: the max resolution that will be used. Possible values: `"1080p"`, `"720p"`, `"576p"`, `"480p"`. diff --git a/theolive/getting-started.mdx b/theolive/getting-started.mdx index 1248ba79c730..8fdd166a50a7 100644 --- a/theolive/getting-started.mdx +++ b/theolive/getting-started.mdx @@ -5,7 +5,7 @@ sidebar_label: Getting started # Backend -THEOlive provides a REST API to manage channels, configure them and start / stop them. Each possible call can be found at our [API Reference](./api/create-a-new-channel.api.mdx). +THEOlive provides a REST API to manage channels, configure them and start / stop them. Each possible call can be found at our [API Reference](./api/create-channel.api.mdx). However, to make things easier for non-developers, we built a management console on top of these API calls which makes it straightforward to perform the basic actions. To be able to create and use a THEOlive channel, you should register for an account and get a token to perform [authenticated requests](./platform/authorization.mdx) to our API. @@ -19,7 +19,7 @@ Once you've entered your username and password, you can already create your firs :::info 📘 API reference -This guide describes how to get started with the THEOlive management console. Please consult the [API reference](./api/create-a-new-channel.api.mdx) and [Authorization](./platform/authorization.mdx) if you would like to work with API calls. +This guide describes how to get started with the THEOlive management console. Please consult the [API reference](./api/create-channel.api.mdx) and [Authorization](./platform/authorization.mdx) if you would like to work with API calls. ::: ## 2. Create your first channel @@ -32,7 +32,7 @@ When hitting 'Create', you will be navigated towards the Details page of your ne ![](assets/img/467abb8-overview.PNG 'Management console: Details page with the possibility to start your channel and options to customize your player.') -A channel can also be created through an API call to the `channels` endpoint, passing an ingest location and a name. It will return an `id` that you can use to start, stop, update or delete the channel later on. Also, a `streamKey` and `rtmpPushUrl` will be returned to stream your content to. More information about the Create channel endpoint and how to pass advanced properties can be found [here](./api/create-a-new-channel.api.mdx). +A channel can also be created through an API call to the `channels` endpoint, passing an ingest location and a name. It will return an `id` that you can use to start, stop, update or delete the channel later on. Also, a `streamKey` and `rtmpPushUrl` will be returned to stream your content to. More information about the Create channel endpoint and how to pass advanced properties can be found [here](./api/create-channel.api.mdx). ```curl curl --location --request POST 'https://api.theo.live/channels' @@ -95,7 +95,7 @@ You can easily start your channel on the channel details page, by clicking on th ![](assets/img/cbe288c-start.PNG) -In the background this will make a `POST` request to the `channels/start` endpoint. You can also start a channel via the Start channel API call, for which you can find more information [here](./api/start-a-channel-will-start-all-connected-engines.api.mdx). As mentioned in the last section, you can optionally pass the `rtmpPullUrl` property in the body of the request for pull-based streaming. Don't forget to stop streaming when you are done! +In the background this will make a `POST` request to the `channels/start` endpoint. You can also start a channel via the Start channel API call, for which you can find more information [here](./api/start-channel.api.mdx). As mentioned in the last section, you can optionally pass the `rtmpPullUrl` property in the body of the request for pull-based streaming. Don't forget to stop streaming when you are done! ```curl curl --location --request POST 'https://api.theo.live/channels/{channel-id}/start' \ @@ -108,7 +108,7 @@ curl --location --request POST 'https://api.theo.live/channels/{channel-id}/star ## 6. Stop the channel -Have you finished your real-time streaming? Make sure to stop your channel by making a request to the `channels/stop` endpoint, either through a [Stop channel](./api/stop-a-channel-will-stop-all-connected-engines.api.mdx) API call or by pressing the red "stop" button in the management console. +Have you finished your real-time streaming? Make sure to stop your channel by making a request to the `channels/stop` endpoint, either through a [Stop channel](./api/stop-channel.api.mdx) API call or by pressing the red "stop" button in the management console. ```curl curl --location --request POST 'https://api.theo.live/channels/{channel-id}/stop' \ diff --git a/theolive/platform/redundancy.md b/theolive/platform/redundancy.md index da968ff5eb5b..9249b590f18d 100644 --- a/theolive/platform/redundancy.md +++ b/theolive/platform/redundancy.md @@ -23,7 +23,7 @@ In what follows, we describe the approach to set a fallback for one channel. ## 1. Create two channels and start them. -You'll need to create two THEOlive channels via the [API](../api/create-a-new-channel.api.mdx) or [management console](https://console.theo.live/). Let's say for example that we have the following channels with fictive IDs: +You'll need to create two THEOlive channels via the [API](../api/create-channel.api.mdx) or [management console](https://console.theo.live/). Let's say for example that we have the following channels with fictive IDs: - Channel `` which is located in the `us-west` region - Channel `` which is located in the `us-east` region @@ -52,7 +52,7 @@ This will work as follows: 5. This process will continue to work this way. If both streams are unavailable, the pre-live settings will be shown (an announcement message and optionally a poster image too). 6. When the primary channel is stopped, all players will stop playing (even if the fallback channel is still streaming). -For more information, please visit our [API Reference](../api/update-a-channel-by-id.api.mdx). +For more information, please visit our [API Reference](../api/update-channel.api.mdx). Note that the fallback can also easily be set in our management console on the Channel Details page. Scroll down to the **Playout Configurations** section and select the _Fallback_ tab. diff --git a/theolive/platform/security/geo-blocking.md b/theolive/platform/security/geo-blocking.md index 65990fe30976..b983c97d6d15 100644 --- a/theolive/platform/security/geo-blocking.md +++ b/theolive/platform/security/geo-blocking.md @@ -8,7 +8,7 @@ Geo-blocking can be configured via the API or the console. ### Main channel -You can enable geo-blocking on a channel by [updating](../../api/update-a-channel-by-id.api.mdx) the `geoBlocking` object within `publicationConfig`. The `mode` of geo-blocking can also be configured: +You can enable geo-blocking on a channel by [updating](../../api/update-channel.api.mdx) the `geoBlocking` object within `publicationConfig`. The `mode` of geo-blocking can also be configured: - `whitelist`: Used by default when no `mode` is passed. This will make the content only available in the countries that have been specified in the `countries` property. Countries not listed in the `countries` property will not receive the stream. - `blacklist`: Blocks the content in the countries that have been specified in the `countries` property. All other countries not specified in the `countries` property will be able to view the content. diff --git a/theolive/platform/security/ip-blocking.md b/theolive/platform/security/ip-blocking.md index 727085d908e3..772a7244a7b9 100644 --- a/theolive/platform/security/ip-blocking.md +++ b/theolive/platform/security/ip-blocking.md @@ -8,7 +8,7 @@ IP-blocking can be configured via the API or the console. ### Main channel -You can enable IP-blocking on a channel by [updating](../../api/update-a-channel-by-id.api.mdx) the `ipBlocking` object within `publicationConfig`. The `mode` of geo-blocking can also be configured: +You can enable IP-blocking on a channel by [updating](../../api/update-channel.api.mdx) the `ipBlocking` object within `publicationConfig`. The `mode` of geo-blocking can also be configured: - `whitelist`: Used by default when no `mode` is passed. This will make the content only available for the CIDRs that have been specified in the `cidrs` property. CIDRs not listed in the `cidrs` property will not receive the stream. - `blacklist`: Blocks the content for the CIDRs that have been specified in the `cidrs` property. All CIDRs not specified in the `cidrs` property will be able to view the content.