It is the wrapper for the HTMLMediaElement and its MediaStream. You can get this object on the HardwareEvents.MediaRendererAdded and HardwareEvents.MediaRendererRemoved for local media. For remote media sources, you can get an instance of this object from Endpoint or EndpointEvents.RemoteMediaAdded or EndpointEvents.RemoteMediaRemoved
render(container: HTMLElement): void
Render (display) current instance of MediaRenderer to the HTMLElement in the DOM tree. If the container paramater is not specified, the method will append rendering to the body element. The method allows to render manually in cases of:
- Default rendering was turned off. If you subscribe to the EndpointEvents.RemoteMediaAdded event, Web SDK will no longer render remote audio/video stream automatically so you have to call this method with optional container parameter.
- default rendering is active, but you want to change rendering container. Call the method with the specified HTMLElement.
place for rendering.
setVolume(level: number): void
Set current MediaRenderer output volume. The range is from 0 to 1.
useAudioOutput(id: string): void
Set the output audio device for current MediaRenderer. ID can be retrieved via the AudioDeviceManager.getOutputDevices method.
HTML element where rendering is executed.
Unique ID of MediaRender
Source of the media stream. Set to "true" for the local streams, "false" for the remote streams.
Describe the tag and type of media, which are placed in this container.
- Kind "audio" means <audio> HTML element and sound-only media stream
- Kind "video" means <video> HTML element and either video-only or audio plus video media stream
- Kind "sharing" the same as kind "video", but literally tell you "This is screen sharing"
A source stream sended from/to some Endpoint. The type of a stream is specified via the kind property. You can use the property for modifying and filtering source streams. E.g. for face masks and CV (computer vision).