SignalWire ClientClientMethods

dial

View as Markdown

dial

  • dial(params): Promise<Call>

Dials to the address specified in the to parameter, and returns a Call object if successful.

Parameters

params
objectRequired

Dial parameters

params.to
stringRequired

The address of the subscriber to dial (like /private/user1).

params.rootElement
HTMLElement

The HTML container element to inject the Call into.

params.nodeId
string

Optional node ID.

You can manage the DOM yourself by not specifying a rootElement here and using the buildVideoElement function instead.

Also accepts all CallOptions parameters. Parameters passed when dialing will override any matching parameters passed during instantiation.

Returns

Promise<Call>

A Call object that describes the ongoing call, and provides handles for controlling it.