From 6f976246b4398b3786391534af312d239e3ed060 Mon Sep 17 00:00:00 2001 From: pabloFuente Date: Tue, 25 Aug 2020 11:35:13 +0200 Subject: [PATCH] openvidu-browser: better Stream.typeOfVideo documentation --- openvidu-browser/src/OpenVidu/Stream.ts | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/openvidu-browser/src/OpenVidu/Stream.ts b/openvidu-browser/src/OpenVidu/Stream.ts index e814f5e0..e4f3cfe5 100644 --- a/openvidu-browser/src/OpenVidu/Stream.ts +++ b/openvidu-browser/src/OpenVidu/Stream.ts @@ -103,7 +103,12 @@ export class Stream extends EventDispatcher { creationTime: number; /** - * `"CAMERA"`, `"SCREEN"` or `"CUSTOM"` (the latter when [[PublisherProperties.videoSource]] is a MediaStreamTrack when calling [[OpenVidu.initPublisher]]). + * Can be: + * - `"CAMERA"`: when the video source comes from a webcam. + * - `"SCREEN"`: when the video source comes from screen-sharing. + * - `"CUSTOM"`: when [[PublisherProperties.videoSource]] has been initialized in the Publisher side with a custom MediaStreamTrack when calling [[OpenVidu.initPublisher]]). + * - `"IPCAM"`: when the video source comes from an IP camera participant instead of a regular participant (see [IP cameras](/en/stable/advanced-features/ip-cameras/)). + * * If [[hasVideo]] is false, this property is undefined */ typeOfVideo?: string;