Documentation

Namespace: Constants

Constants

Members

<static, constant> APIRTC_MEDIA_DEVICE_DETECTION_DELAY :number

The interval between two media device detection for apiRTC media device detection process. Check apiRTCMediaDeviceDetectionEnabled on UserAgent

Type:
  • number

<static, constant> CALL_STATUS_ENDED :Symbol

Call has ended

Type:
  • Symbol

<static, constant> CALL_STATUS_ONGOING :Symbol

Call is ongoing

Type:
  • Symbol

<static, constant> CALL_STATUS_WAITING_FOR_CALLEE :Symbol

Call is waiting for callee to answer

Type:
  • Symbol

<static, constant> CONTACT_DISCONNECTION_DELAY :number

Delay before a contact is actually seen as offline after it disconnected (eg. short reconnection after page switching)

Type:
  • number

<static, constant> CONVERSATION_GROUP_CHAT_MEMBER_UPDATE_DELAY :number

Maximum delay to wait for group chat member update event.

Type:
  • number

<static, constant> CONVERSATION_JOIN_REQUEST_INTERVAL :number

The interval between join request message sendings.

Type:
  • number

<static, constant> CONVERSATION_PARTICIPANT_EJECTION_DELAY :number

Maximum delay to wait for the ejected event.

Type:
  • number

<static, constant> CONVERSATION_RECORDING_STARTED_DELAY :number

Maximum delay to wait for the recording started event.

Type:
  • number

<static, constant> CONVERSATION_RECORDING_STOPPED_DELAY :number

Maximum delay to wait for the recording stopped event.

Type:
  • number

<static, constant> CONVERSATION_STATUS_JOINED :Symbol

Conversation is currently joined

Type:
  • Symbol

<static, constant> CONVERSATION_STATUS_JOINING :Symbol

User agent is currently joining the conversation

Type:
  • Symbol

<static, constant> CONVERSATION_STATUS_NOT_JOINED :Symbol

Conversation is not joined

Type:
  • Symbol

<static, constant> CONVERSATION_STATUS_WAITING :Symbol

User agent is in the conversation's waiting room, waiting for moderator acceptance to join

Type:
  • Symbol

<static, constant> CONVERSATION_STREAMING_STARTED_DELAY :number

Maximum delay to wait for the streaming started event.

Type:
  • number

<static, constant> CONVERSATION_STREAMING_STOPPED_DELAY :number

Maximum delay to wait for the streaming stopped event.

Type:
  • number

<static, constant> CONVERSATION_WHITEBOARD_NOT_STARTED :Symbol

Conversation is not joined

Type:
  • Symbol

<static, constant> CONVERSATION_WHITEBOARD_START_DELAY :number

Maximum delay to wait for whiteboard start.

Type:
  • number

<static, constant> CONVERSATION_WHITEBOARD_STARTED :Symbol

Conversation is currently joined

Type:
  • Symbol

<static, constant> DATACHANNEL_STATUS_ENDED :Symbol

DataChannel session has ended

Type:
  • Symbol

<static, constant> DATACHANNEL_STATUS_ONGOING :Symbol

DataChannel session is ongoing

Type:
  • Symbol

<static, constant> DATACHANNEL_STATUS_WAITING :Symbol

DataChannel session is waiting for callee to answer

Type:
  • Symbol

<static, constant> DATACHANNEL_TYPE_RECEIVE :Symbol

DataChannel session is on receive side only

Type:
  • Symbol

<static, constant> DATACHANNEL_TYPE_SEND :Symbol

DataChannel session is on send side only

Type:
  • Symbol

<static, constant> ERROR_APIRTC_INITIALISATION_FAILED :number

Type:
  • number

<static, constant> ERROR_APIRTC_SESSION_ALREADY_ON :number

Type:
  • number

<static, constant> ERROR_BAD_PARAMETER :number

Type:
  • number

<static, constant> ERROR_HTTP :number

Type:
  • number

<static, constant> ERROR_INVALID_CREDENTIALS :number

Type:
  • number

<static, constant> ERROR_INVITATION_STATE_INVALID :number

Type:
  • number

<static, constant> ERROR_NETWORK_UNAVAILABLE :number

Type:
  • number

<static, constant> ERROR_NOT_ALLOWED :number

Type:
  • number

<static, constant> ERROR_NOT_FOUND :number

Type:
  • number

<static, constant> ERROR_ON_SAVE :number

Type:
  • number

<static, constant> ERROR_OPERATION_CANCELED :number

Type:
  • number

<static, constant> ERROR_OTHER :number

Type:
  • number

<static, constant> ERROR_REGISTRATION_URI_INVALID :number

Type:
  • number

<static, constant> ERROR_SERVER_UNAVAILABLE :number

Type:
  • number

<static, constant> ERROR_STREAM_RECORD :number

Type:
  • number

<static, constant> ERROR_TIMED_OUT :number

Type:
  • number

<static, constant> ERROR_UNAUTHORIZED :number

Type:
  • number

<static, constant> ERROR_WRONG_STATE :number

Type:
  • number

<static, constant> INVITATION_STATUS_ACCEPTED :Symbol

Invitation has been accepted

Type:
  • Symbol

<static, constant> INVITATION_STATUS_CANCELLED :Symbol

Invitation has been cancelled

Type:
  • Symbol

<static, constant> INVITATION_STATUS_DECLINED :Symbol

Invitation has been declined

Type:
  • Symbol

<static, constant> INVITATION_STATUS_ENDED :Symbol

Invitation is ended

Type:
  • Symbol

<static, constant> INVITATION_STATUS_EXPIRED :Symbol

Invitation has expired

Type:
  • Symbol

<static, constant> INVITATION_STATUS_STANDBY :Symbol

Invitation is waiting for a response

Type:
  • Symbol

<static, constant> LOG_LEVEL_DEBUG :number

Type:
  • number

<static, constant> LOG_LEVEL_ERROR :number

Type:
  • number

<static, constant> LOG_LEVEL_INFO :number

Type:
  • number

<static, constant> LOG_LEVEL_OFF :number

Type:
  • number

<static, constant> LOG_LEVEL_TRACE :number

Type:
  • number

<static, constant> LOG_LEVEL_WARN :number

Type:
  • number

<static> LOG_PREFIX

LOGGER

<static, constant> STATE_ACTIVE :Symbol

General purpose state.

Type:
  • Symbol

<static, constant> STATE_IDLE :Symbol

General purpose state.

Type:
  • Symbol

<static, constant> STATE_JOINING :Symbol

General purpose state.

Type:
  • Symbol

<static, constant> STATE_LEAVING :Symbol

General purpose state.

Type:
  • Symbol

<static, constant> STREAM_AUDIO_ANALYSIS_THRESHOLD :Symbol

Threshold applied for detecting voice or noise in the stream audio

Type:
  • Symbol

<static, constant> STREAM_AUDIO_NOISE_REDUCTION_VAI :Symbol

Threshold applied for the Voice Activity Indicator when noise reduction is turned on

Type:
  • Symbol

<static, constant> STREAM_TYPE_AUDIO :Symbol

Stream is audio-only

Type:
  • Symbol

<static, constant> STREAM_TYPE_NO_INPUT :Symbol

Stream has no input

Type:
  • Symbol

<static, constant> STREAM_TYPE_VIDEO :Symbol

Stream has at least a video track

Type:
  • Symbol