From f3173b8c1e801a04d995f14bd50f2e09b2a651c9 Mon Sep 17 00:00:00 2001 From: Zita Szupera Date: Wed, 15 May 2024 10:51:49 +0200 Subject: [PATCH] Add extra info for audio rooms --- .../docusaurus/docs/api/_common_/call-types-overview.mdx | 9 +++++++++ docusaurus/video/docusaurus/docs/api/basics/calls.mdx | 5 +++++ .../video/docusaurus/docs/api/basics/get_started.mdx | 5 +++++ 3 files changed, 19 insertions(+) create mode 100644 docusaurus/video/docusaurus/docs/api/_common_/call-types-overview.mdx diff --git a/docusaurus/video/docusaurus/docs/api/_common_/call-types-overview.mdx b/docusaurus/video/docusaurus/docs/api/_common_/call-types-overview.mdx new file mode 100644 index 00000000..ac9f217b --- /dev/null +++ b/docusaurus/video/docusaurus/docs/api/_common_/call-types-overview.mdx @@ -0,0 +1,9 @@ +Call types provide sensible default settings for different use-cases. We provide the following types out of the box: + +- **Default** (`default`) for 1:1 or group calls that use both video and audio +- **Livestreaming** (`livestream`) to build ultra low latency livestreaming for your app on our global edge network. Broadcast from your phone or RTMP and scale to millions of participants. +- **Audio room** (`audio_room`) to build audio experiences for your app. You can build basic calling or feature rich experience like Twitter spaces. Audio quality, reliability and scalability is far ahead of competing solutions. + +Each of our [SDKs have tutorials specific for each call type](https://getstream.io/video/sdk/). If you want to know the default settings for each of the call types check out the [Built-in call types page](/api/call_types/builtin). + +It's possible to tweak the built-in call types or create new ones. \ No newline at end of file diff --git a/docusaurus/video/docusaurus/docs/api/basics/calls.mdx b/docusaurus/video/docusaurus/docs/api/basics/calls.mdx index 0bfee54b..4790d3f0 100644 --- a/docusaurus/video/docusaurus/docs/api/basics/calls.mdx +++ b/docusaurus/video/docusaurus/docs/api/basics/calls.mdx @@ -16,6 +16,7 @@ import CallMemberFilters from '../../../shared/video/_call-member-filters.mdx'; import CallSort from '../../../shared/video/_call-sort-fields.mdx'; import CallMemberSort from '../../../shared/video/_call-member-sort-fields.mdx'; import OpenApiModels from '../_common_/OpenApiModels'; +import CallTypesSum from '../_common_/call-types-overview.mdx'; ## Creating calls @@ -108,6 +109,10 @@ curl -X POST "https://video.stream-io-api.com/api/v2/video/call/${CALL_TYPE}/${C +## Call types + + + ## Updating calls diff --git a/docusaurus/video/docusaurus/docs/api/basics/get_started.mdx b/docusaurus/video/docusaurus/docs/api/basics/get_started.mdx index bbcc6cab..97e9158e 100644 --- a/docusaurus/video/docusaurus/docs/api/basics/get_started.mdx +++ b/docusaurus/video/docusaurus/docs/api/basics/get_started.mdx @@ -10,6 +10,7 @@ import TabItem from '@theme/TabItem'; import CreateCall from '../_common_/create-call.mdx'; import CallMembers from '../_common_/manage-call-members.mdx'; import UpdateCall from '../_common_/update-call.mdx'; +import CallTypesSum from '../_common_/call-types-overview.mdx'; Stream powers [Chat Messaging](https://getstream.io/chat/), [Video & Audio](https://getstream.io/video/), and [Activity Feeds](https://getstream.io/activity-feeds/) for billions of global end-users across thousands of different apps. @@ -184,6 +185,10 @@ curl -X POST https://video.stream-io-api.com/api/v2/users?api_key=${API_KEY} \ +## Call types + + + ## Call members