Rate this page:

Config

VoxImplant SDK Configuration

Props

H264first

Copy URL
H264first: 

boolean

Use H264 video codec, if it's available on the target device

enableTrace

Copy URL
enableTrace: 

boolean

Show trace in console. It's false by default.

localVideoContainerId

Copy URL
localVideoContainerId: 

string

Id of HTMLElement that will be used as a default container for local video elements. Local videos are appended to the body element by default

micRequired

Copy URL
micRequired: 

boolean

If it's true a microphone access dialog will be shown and all functions will become available only after user granted access

progressTone

Copy URL
progressTone: 

boolean

Automatically plays progress tone by means of SDK according to specified progressToneCountry. It's true by default.

progressToneCountry

Copy URL
progressToneCountry: 

string

Country code for progress tone generated automatically if progressTone is set to true. Available values are: RU, US

remoteVideoContainerId

Copy URL
remoteVideoContainerId: 

string

Id of HTMLElement that will be used as a default container for remote video elements. Remote videos are appended to the body element by default

rtcStatsCollectionInterval

Copy URL
rtcStatsCollectionInterval: 

number

RTC Stats collection interval (ms)

serverIp

Copy URL
serverIp: 

string[]

|

string

IP address of particular media gateway for connection

showDebugInfo

Copy URL
showDebugInfo: 

boolean

Show debug info in console. It's false by default.

showWarnings

Copy URL
showWarnings: 

boolean

Show warnings. It's false by default.

videoConstraints

Copy URL
videoConstraints: 

VideoSettings

|

boolean

Default constraints that will be applied on the next attachRecordingDevice function call or if micRequired set to true. IMPORTANT: the value has to be the object. Boolean values exist only in order to ensure backward compatibility.

videoContainerId

Deprecated
Copy URL
videoContainerId: 

string

Id of HTMLElement that will be used as a default container for local video elements, i.e. caller could see himself in this container during the conversation. Local videos are appended to the body element by default.