Skip to content

Commit addfdb6

Browse files
author
Yuqi Huang
committed
updated the readme.md for the new multi-viewer feature
1 parent b96518a commit addfdb6

1 file changed

Lines changed: 23 additions & 2 deletions

File tree

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,28 @@ Once login is successful, you will entering the following channel information to
8989
* Start the web browser using the [Javascript SDK](https://github.com/awslabs/amazon-kinesis-video-streams-webrtc-sdk-js) and start it as `viewer`.
9090
* Verify media showing up from the Android device to the browser.
9191

92-
## 6. ICE Candidate Trickling
92+
93+
## 6. WebRTC Ingestion support
94+
95+
The sample application demonstrates how to connect to the KVS WebRTC storage session as a master or viewer participant.
96+
97+
For more information about WebRTC ingestion, see https://docs.aws.amazon.com/kinesisvideostreams-webrtc-dg/latest/devguide/webrtc-ingestion.html.
98+
99+
### 6.1 Setting up signaling channel and stream
100+
101+
Follow the instructions below to:
102+
103+
### 6.2 Prerequisites
104+
105+
* Ensure H.264 and OPUS codec support is available on the device
106+
107+
Usage:
108+
1. Master with Ingest Media: Check the "Ingest Media" option and ensure both "Send Audio" and "Send Video" are selected. The master will stream audio and video to both connected viewers and Kinesis Video Streams.
109+
110+
2. Viewer with Ingest Media: Check the "Ingest Media" option but only select "Send Audio" (video must be deselected). Multiple viewers(at most three) can connect to the same channel and each will ingest audio-only streams to Kinesis Video Streams.
111+
112+
113+
## 7. ICE Candidate Trickling
93114

94115
Candidate trickling is a technique through which a caller may incrementally provide candidates to the callee after the initial offer has been dispatched; the semantics of "Trickle ICE" are defined in [RFC8838].
95116

@@ -100,7 +121,7 @@ However, in the case that it needs to be disabled, locate the RTCConfiguration p
100121
PeerConnection.RTCConfiguration rtcConfig = new PeerConnection.RTCConfiguration();
101122
rtcConfig.continualGatheringPolicy = PeerConnection.ContinualGatheringPolicy.GATHER_CONTINUALLY;
102123
```
103-
## 7. Testing
124+
## 8. Testing
104125
This SDK has been tested with Java 11, 17 to build the Gradle dependencies and Java 8, 11, and, 17 in the compile options in build.gradle
105126

106127
```agsl

0 commit comments

Comments
 (0)