ambiser
/
openvidu
mirror of https://github.com/OpenVidu/openvidu.git
8
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

openvidu-browser: better Stream.typeOfVideo documentation

pull/540/head
pabloFuente 2020-08-25 11:35:13 +02:00
parent 81fb623a93
commit 6f976246b4
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
openvidu-browser/src/OpenVidu/Stream.ts
View File

@ -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;