Props and Types
Please follow to WebRTCClientProps interface exported from module to check properties types
Available props:
address
string
WSS Url of Signalling
undefined
packageId
string
Id of your project
undefined
shareId
string
Share Id created for your project
undefined
loader
(val: boolean, disconnected?: boolean) => void
Callback for loading status
undefined
videoInitializeCallback
(descriptor) => unknown
This event will be triggered once the video is initialized and ready to play.
undefined
sizeContainer
HTMLElement | string
The root container defines the boundaries of the video and container elements. In case of a string, please provide the ID attribute of the HTML element. If you do so, there is no need to specify the container and videoRef arguments.
undefined
container
HTMLElement
This element will wrap the video so that we can place UI elements that are aligned with the size of the <video>
undefined
videoRef
HTMLVideoElement
<video> element reference
undefined
audioRef
HTMLAudioElement
element reference
undefined
orientationZoom
{
portrait: number;
landscape: number;
}
This is the zoom level to send to the UE4 application when switching from portrait to landscape mode, and vice versa.
undefined
forceVideoToFitContainer
boolean
Try to fit sizeContainer
true
extmapAllowMixed
boolean
Should be false if UE version is less than 4.27
true
applicationResponse
(response: string) => unknown
This is the callback that will be triggered if the UE application sends a text response.
undefined
autoplay
{
video: boolean;
audio: boolean;
}
Autoplay for video and audio
{
video: true,
audio: true,
}
playOverlay
boolean
Overlay with play button
false
updateQueueData
{
updateQueueData: (queueData: Queue) => void;
// triggered when you are not in a queue anymore
hideQueueDialog: () => void; }
Callback to update the queue dialog state
undefined
sendResolutionOnResize
boolean
enable / disable sendResolution when window is resized
true
sendLetter
(letter: string) => unknown
These are the information messages from the signaling system about the current connection status.
undefined
Last updated
