Returns the current default video stream style which was set using setDefaultVideoStreamStyle method.
This is false by default. When true, the metaData property in videos of videoStreams object will be available. metadata property contains info about the stream's FPS. Important: This should be set to false in production builds to reduce the triggered notifications on change of videoStreams object.
Returns the last successfully applied VideoStreamConfiguration request.
The streams of video being received by the client. Updates on any change of any of the properties of videoStreams Important: There is no guarantee on the ordering of this array, relying on the ordering of this array may result in more layout changes than neccesary.
Attaches a participant video to a view. This will cause the stream of video to be rendered and visible in the given view. Should only be called for videos in the videoStreams array. A video may only be attached to one view at a time. Calling this method on a stream that is already attached will implicitly call the detachParticipantStreamFromView(participantGuid: String) method first.
the unique identifier of the participant whose video you want to attach
the div element where the view should be rendered. Note: This view would be treated as a container where video would be rendered. Please ensure that the view has some height and width and has no other elements inside it
Detaches (removes) the video stream from the view (div) it is attached to. This will stop rendering video to the view.
the unique identifier of the participant whose video you want to detach
Allows observing changes to properties. Provide the property which you are interested in and a callback. Whenever the property value changes, you will be notified via the callback.
Usage:
sdk.meetingService.videoStreamService.observe("videoStreamConfigurations", function() {
console.info("videoStreamConfigurations changed to : ", sdk.meetingService.videoStreamService.videoStreamConfigurations)
});
The name of the property to observe for changes.
on change event for the property.
Sets the value of isDebugMetadataEnabled flag to include/exclude metaData info in videos of videoStreams object.
Sets the default video stream style based on the videoStreamStyle param. Setting the style will only affect views attached after the default style is set.
Requests a configuration of video to be received by the client. Allows specification of the number of streams of video received, the quality of those videos, the priorities of those videos and which participants are included in the streams. Sample request Usage :
sdk.meetingService.videoStreamService.setVideoStreamConfiguration([{participantGuid:"<guid>",streamQuality:"r180p_15fps",streamPriority:"HIGH"},{streamQuality:"r180p_30fps",streamPriority:"MEDIUM"}])
Sets the video stream style based on the videoStreamStyle param for the video element present in the provided view param. The applied styles will be removed once video is removed from the provided view and when re-rendered will have the defaultVideoStreamStyle.
Generated using TypeDoc
An observable collection of Views for every participant video stream that has been attached using the attachParticipantToView method. An observable Map between the participantGuid and View.