Skip to main content

WebRTC JS Client Options

IClientOptions IClientOptions

Table of contents

Properties

Properties

debug

Optional debug: boolean

Enable debug mode for this client. This will gather WebRTC debugging information.


debugOutput

Optional debugOutput: "file" | "socket"

Debug output option


login

Optional login: string

The username to authenticate with your SIP Connection. login and password will take precedence over login_token for authentication.


login_token

Optional login_token: string

The JSON Web Token (JWT) to authenticate with your SIP Connection. This is the recommended authentication strategy. See how to create one.


password

Optional password: string

The password to authenticate with your SIP Connection.


prefetchIceCandidates

Optional prefetchIceCandidates: boolean

Enable or disable prefetching ICE candidates.


ringbackFile

Optional ringbackFile: string

A URL to a wav/mp3 ringback file that will be used when you disable "Generate Ringback Tone" in your SIP Connection.


ringtoneFile

Optional ringtoneFile: string

A URL to a wav/mp3 ringtone file.