feat(swift5): use Basic auth instead of Bearer

Author: ThibaultBee

sdks/livestream/apivideo-android-livestream-module.md

@@ -3,14 +3,12 @@ title: Android live stream module
 meta: 
   description: The official Android live stream module for api.video. [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.
 ---
-<!--
-THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT!
- IF YOU NEED TO CHANGE THIS FILE,  CREATE A PR IN THE SOURCE REPOSITORY.
--->
 
 # api.video Android Live stream module
 
-[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.
+[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.
 
 ## Project description
 
@@ -26,7 +24,7 @@ On build.gradle add the following code in dependencies:
 
 ```groovy
 dependencies {
-    implementation 'video.api:android-live-stream:1.3.1'
+    implementation 'video.api:android-live-stream:1.0.2'
 }
 ```
 

sdks/livestream/apivideo-flutter-livestream.md

@@ -3,14 +3,12 @@ title: Flutter RTMP live stream client
 meta: 
   description: The official Flutter RTMP live stream client for api.video. [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.
 ---
-<!--
-THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT!
- IF YOU NEED TO CHANGE THIS FILE,  CREATE A PR IN THE SOURCE REPOSITORY.
--->
 
 # Flutter RTMP Live stream Client
 
-[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.
+[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.
 
 ## Project description
 
@@ -24,7 +22,7 @@ In your pubspec.yaml file, add the following:
 
 ```yaml
 dependencies:
-  apivideo_live_stream: ^1.1.3
+  apivideo_live_stream: ^1.1.1
 ```
 
 In your dart file, import the package:
@@ -165,5 +163,4 @@ use [issues](https://github.com/apivideo/api.video-flutter-live-stream/issues).
 
 [StreamPack]: <https://github.com/ThibaultBee/StreamPack>
 
-[HaishinKit]: <https://github.com/shogo4405/HaishinKit.swift>
-
+[HaishinKit]: <https://github.com/shogo4405/HaishinKit.swift>

sdks/livestream/react-native-livestream-component.md

@@ -3,107 +3,83 @@ title: React Native live stream component
 meta: 
   description: The official React Native live stream component for api.video. [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.
 ---
-<!--
-THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT!
- IF YOU NEED TO CHANGE THIS FILE,  CREATE A PR IN THE SOURCE REPOSITORY.
--->
 
-# React Native Livestream Component
+React Native Livestream Component
+=================================
 
 [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.
 
 ## Project description
 
-This module is made for broadcasting rtmp live stream from smartphone camera
+This module is made for broadcasting rtmp livestream from smartphone camera
 
 ## Getting started
 
-:warning: **The React Native Live Stream SDK is designed for 0.69.1 version of React Native. Using the SDK with >0.69.1 of React Native can cause unexpected behaviour**
-
-
 ### Installation
 
 ```sh
 npm install @api.video/react-native-livestream
 ```
-
 or
-
 ```sh
 yarn add @api.video/react-native-livestream
 ```
-
 _Note: if you are on iOS, you will need two extra steps:_
-
-1. Don't forget to install the native dependencies with Cocoapods
-
+1) Don't forget to install the native dependencies with Cocoapods
 ```sh
 cd ios && pod install
 ```
-
-1. This project contains swift code, and if it's your first dependency with swift code, you need to create an empty swift file in your project (with the bridging header) from XCode. [Find how to do that](https://github.com/apivideo/api.video-reactnative-live-stream/blob/main/docs/install_swift_dependency.md)
+2) This project contains swift code, and if it's your first dependency with swift code, you need to create an empty swift file in your project (with the bridging header) from XCode. [Find how to do that](https://github.com/apivideo/api.video-reactnative-live-stream/blob/main/docs/install_swift_dependency.md)
 
 ### Permissions
+To be able to broadcast,
 
-To be able to broadcast, you must:
-
-1. On Android: ask for internet, camera and microphone permissions:
+1) On Android you must ask for internet, camera and microphone permissions:
 
-```xml
-<manifest>
+```java
   <uses-permission android:name="android.permission.INTERNET" />
   <uses-permission android:name="android.permission.RECORD_AUDIO" />
   <uses-permission android:name="android.permission.CAMERA" />
-</manifest>
 ```
 
-Your application must dynamically require android.permission.CAMERA and android.permission.RECORD_AUDIO.
-
-2. On iOS: update Info.plist with a usage description for camera and microphone
+2) On iOS, you must update Info.plist with a usage description for camera and microphone
 
 ```xml
+...
 <key>NSCameraUsageDescription</key>
 <string>Your own description of the purpose</string>
 
 <key>NSMicrophoneUsageDescription</key>
 <string>Your own description of the purpose</string>
+...
+	
 ```
-
-3. On react-native you must handle the permissions requests before starting your livestream. If permissions are not accepted you will not be able to broadcast.
+3) On react-native you must handle the permissions requests before starting your livestream. If permissions are not accepted you will not be able to broadcast.
 
 ### Code sample
 
-
 {% raw %}
-
-```jsx
+```js
 import React, { useRef, useState } from 'react';
 import { View, TouchableOpacity } from 'react-native';
-import { LiveStreamView } from '@api.video/react-native-livestream';
+import { LivestreamView } from '@api.video/react-native-livestream';
 
 const App = () => {
   const ref = useRef(null);
   const [streaming, setStreaming] = useState(false);
 
   return (
     <View style={{ flex: 1, alignItems: 'center' }}>
-      <LiveStreamView
+      <LivestreamView
         style={{ flex: 1, backgroundColor: 'black', alignSelf: 'stretch' }}
         ref={ref}
-        camera="back"
-        enablePinchedZoom={true}
         video={{
           fps: 30,
           resolution: '720p',
-          bitrate: 2*1024*1024, // # 2 Mbps
-          gopDuration: 1, // 1 second
-        }}
-        audio={{
-          bitrate: 128000,
-          sampleRate: 44100,
-          isStereo: true,
+          camera: 'front',
+          orientation: 'portrait',
         }}
-        isMuted={false}
+        liveStreamKey="your-livestrem-key"
         onConnectionSuccess={() => {
           //do what you want
         }}
@@ -127,7 +103,7 @@ const App = () => {
               ref.current?.stopStreaming();
               setStreaming(false);
             } else {
-              ref.current?.startStreaming('YOUR_STREAM_KEY');
+              ref.current?.startStreaming();
               setStreaming(true);
             }
           }}
@@ -139,127 +115,74 @@ const App = () => {
 
 export default App;
 ```
-
 {% endraw %}
 
 ## Documentation
 
 ### Props & Methods
 
 ```ts
-type LiveStreamProps = {
+type ReactNativeLivestreamProps = {
   // Styles for the view containing the preview
   style: ViewStyle;
-  // camera facing orientation
-  camera?: 'front' | 'back';
+  // Your Streaming key, we will append this to the rtmpServerUrl
+  liveStreamKey: string;
+  // RTMP server url, default: rtmp://broadcast.api.video/s
+  rtmpServerUrl?: string;
   video: {
-    // frame rate
+  // default: 30
     fps: number;
-    // resolution
-    resolution: '240p' | '360p' | '480p' | '720p' | '1080p';
-    // video bitrate. depends on resolutions.
-    bitrate: number;
-    // duration between 2 key frames in seconds
-    gopDuration: number;
+  // default: '720p'
+    resolution: '240p' | '360p' | '480p' | '720p' | '1080p' | '2160p';
+  // If omitted we will infer it from the resolution
+    bitrate?: number;
+  // default: 'back'
+    camera?: 'front' | 'back';
+  // default: 'landscape'
+    orientation?: 'landscape' | 'portrait';
   };
-  audio: {
-    // sample rate. Only for Android. Recommended: 44100
-    sampleRate: 44100;
-    // true for stereo, false for mono. Only for Android. Recommended: true
-    isStereo: true;
-    // audio bitrate. Recommended: 128000
-    bitrate: number;
+  audio?: {
+  // default: false
+    muted?: boolean;
+  // default: 128000
+    bitrate?: number;
   };
-  // Mute/unmute microphone
-  isMuted: false;
-  // Enables/disables the zoom gesture handled natively
-  enablePinchedZoom?: boolean;
   // will be called when the connection is successful
-  onConnectionSuccess?: () => void;
-  // will be called when connection failed
-  onConnectionFailed?: (code: string) => void;
+  onConnectionSuccess?: (event: NativeSyntheticEvent<{ }>) => void;
+  // will be called on connection's error
+  onConnectionFailed?: (event: NativeSyntheticEvent<{ code: string }>) => void;
   // will be called when the live-stream is stopped
-  onDisconnect?: () => void;
+  onDisconnect?: (event: NativeSyntheticEvent<{ }>) => void;
+  
 };
 
-type LiveStreamMethods = {
+type ReactNativeLivestreamMethods = {
   // Start the stream
-  // streamKey: your live stream RTMP key
-  // url: RTMP server url, default: rtmp://broadcast.api.video/s
-  startStreaming: (streamKey: string, url?: string) => void;
+  startStreaming: () => void;
   // Stops the stream
   stopStreaming: () => void;
-  // Sets the zoomRatio
-  // Intended for use with React Native Gesture Handler, a slider or similar.
-  setZoomRatio: (zoomRatio) => void;
 };
 ```
 
-## Example App
-
-You can try our [example app](https://github.com/apivideo/api.video-reactnative-live-stream/tree/main/example), feel free to test it.
-
-### Setup
-
-Be sure to follow the [React Native installation steps](https://reactnative.dev/docs/environment-setup) before anything.
-
-1. Open a new terminal
-2. Clone the repository and go into it
-
-```shell
-git clone https://github.com/apivideo/api.video-reactnative-live-stream.git livestream_example_app && cd livestream_example_app
-```
-
-#### Android
-
-Install the packages and launch the application
-
-```shell
-yarn && yarn example android
-```
-
-#### iOS
-
-1. Install the packages
-
-```shell
-yarn install
-```
-
-2. Go into `/example/ios` and install the Pods
-
-```shell
-cd /example/ios && pod install
-```
-
-3. Sign your application
-
-Open Xcode, click on "Open a project or file" and open the `Example.xcworkspace` file.
-<br />You can find it in `YOUR_PROJECT_NAME/example/ios`.
-<br />Click on Example, go in `Signin & Capabilities` tab, add your team and create a unique
-bundle identifier.
-
-4. Launch the application, from the root of your project
-
-```shell
-yarn example ios
-```
-
 ## Plugins
 
-api.video live stream library is using external native library for broadcasting
+API.Video LiveStream module is using external native library for broadcasting
 
-| Plugin     | README       |
-| ---------- | ------------ |
-| StreamPack | [StreamPack] |
+| Plugin | README |
+| ------ | ------ |
+| rtmp-rtsp-stream-client-java | [rtmp-rtsp-stream-client-java] |
 | HaishinKit | [HaishinKit] |
 
 ## FAQ
-
-If you have any questions, ask us here: https://community.api.video .
+If you have any questions, ask us here:  https://community.api.video .
 Or use [Issues].
 
-[//]: # "These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax"
-[streampack]: https://github.com/ThibaultBee/StreamPack
-[haishinkit]: https://github.com/shogo4405/HaishinKit.swift
-[issues]: https://github.com/apivideo/api.video-reactnative-live-stream/issues
+## Example App
+You can try our [example app](https://github.com/apivideo/api.video-reactnative-live-stream/tree/main/example), feel free to test it. 
+
+
+[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax)
+
+   [rtmp-rtsp-stream-client-java]: <https://github.com/pedroSG94/rtmp-rtsp-stream-client-java>
+   [HaishinKit]: <https://github.com/shogo4405/HaishinKit.swift>
+   [Issues]: <https://github.com/apivideo/api.video-reactnative-live-stream/issues>