setRemoteDisplay(displayId) method

If a call object is added to the program, this method can run on it. It is used to show the video stream coming from the other party. If there is no video stream in the call then no video will be shown. To send a video stream to the other party you need to use the attachCamera(camera)method. The camera parameter of this method is an object of the OzCamera class.


displayId: Type: string. The ID of the html element where the camera stream will be shown to. The default value is 'local'.
e.g. 'myLocalHtmlId'

The setRemoteDisplay(displayId) has a displayId input parameter that shows the ID of the display where the camera stream will be shown, this can be determined by the id parameter given in a html code (Code example 1). To show it on another part of the display you need to create a new display ID for it.

<div id="local">
  <!-- The video will be displayed in this div -->
Code example 1 - Example how to give a display ID in HTML

Only one remote display can be set per call.

Method usage example

In this example we will accept an incoming call and set the video stream to show on the "local" ID created above.

First you need to register to the onIncomingCall event. This is to make sure your incoming knows when it gets an incoming call. If your incoming receives a call then the incoming function is called. This function accepts the incoming call then sets the remote display to "local" (Code example 2).

//registers to the onIncomingCall event

function incoming(incomingCall) {
    incomingCall.accept(); //accepts the call
    incomingCall.setRemoteDisplay("local"); //sets remote display to local
Code example 1 - setRemoteDisplay(displayId) method example

More information