BUNDLE_POLICY
CANDIDATE_GENERATION_STATE
CANDIDATE_PROCESSING_STATE
CHUNK_FILE_SIZE
DATA_CHANNEL_STATE
DATA_CHANNEL_TYPE
DATA_CHANNEL_MESSAGE_ERROR
DATA_TRANSFER_STATE
DATA_TRANSFER_DATA_TYPE
DT_PROTOCOL_VERSION
DATA_TRANSFER_DIRECTION
DATA_TRANSFER_SESSION_TYPE
EVENTS
GET_CONNECTION_STATUS_STATE
GET_PEERS_STATE
HANDSHAKE_PROGRESS
ICE_CONNECTION_STATE
LOG_LEVEL
MEDIA_ACCESS_FALLBACK_STATE
MEDIA_SOURCE
MEDIA_STATUS
MEDIA_TYPE
MEDIA_STATE
PEER_CERTIFICATE
PEER_CONNECTION_STATE
READY_STATE_CHANGE_ERROR
READY_STATE_CHANGE
RTCP_MUX_POLICY
RTMP_STATE
RECORDING_STATE
SDP_SEMANTICS
SOCKET_ERROR
SOCKET_FALLBACK
SYSTEM_ACTION
SYSTEM_ACTION_REASON
SM_PROTOCOL_VERSION
TURN_TRANSPORT
VIDEO_RESOLUTION
VIDEO_QUALITY
- Source:
Members
(static, constant) BUNDLE_POLICY :Object
Learn more about how ICE works in this article here.The list of available Peer connection bundle policies.
Properties:
Name | Type | Description |
---|---|---|
MAX_COMPAT |
String |
Value |
MAX_BUNDLE |
String |
Value |
BALANCED |
String |
Value |
NONE |
String |
Value |
- Since:
-
- 0.6.18
- Source:
(static, constant) CANDIDATE_GENERATION_STATE :Object
Learn more about how ICE works in this article here.The list of Peer connection ICE gathering states.
Properties:
Name | Type | Description |
---|---|---|
GATHERING |
String |
Value |
COMPLETED |
String |
Value |
- Since:
-
- 0.4.1
- Source:
(static, constant) CANDIDATE_PROCESSING_STATE :Object
Learn more about how ICE works in this article here.The list of Peer connection remote ICE candidate processing states for trickle ICE connections.
Properties:
Name | Type | Description |
---|---|---|
RECEIVED |
String |
Value |
DROPPED |
String |
Value |
BUFFERED |
String |
Value |
PROCESSING |
String |
Value |
PROCESS_SUCCESS |
String |
Value |
PROCESS_ERROR |
String |
Value |
- Since:
-
- 0.6.16
- Source:
(static, constant) DATA_CHANNEL_MESSAGE_ERROR :object
The list of Datachannel sending message error types.
Properties:
Name | Type | Description |
---|---|---|
MESSAGE |
String |
Value |
TRANSFER |
String |
Value |
- Since:
-
- 0.6.16
- Source:
(static, constant) DATA_CHANNEL_STATE :object
The list of Datachannel connection states.
Properties:
Name | Type | Description |
---|---|---|
CONNECTING |
String |
Value |
OPEN |
String |
Value |
CLOSING |
String |
Value |
CLOSED |
String |
Value |
ERROR |
String |
Value |
CREATE_ERROR |
String |
Value |
BUFFERED_AMOUNT_LOW |
String |
Value |
SEND_MESSAGE_ERROR |
String |
Value |
- Since:
-
- 0.1.0
- Source:
(static, constant) DATA_CHANNEL_TYPE :object
The list of Datachannel types.
Properties:
Name | Type | Description |
---|---|---|
MESSAGING |
String |
Value |
DATA |
String |
[UNAVAILABLE] Value |
- Since:
-
- 0.6.1
- Source:
(static, constant) DATA_TRANSFER_DATA_TYPE :Object
The list of supported data transfer data types.
Properties:
Name | Type | Description |
---|---|---|
BINARY_STRING |
String |
Value |
ARRAY_BUFFER |
String |
Value |
BLOB |
String |
Value |
STRING |
String |
Value |
- Since:
-
- 2.0.0
- Source:
(static, constant) DATA_TRANSFER_DIRECTION :Object
The list of data transfers directions.
Properties:
Name | Type | Description |
---|---|---|
UPLOAD |
String |
Value |
DOWNLOAD |
String |
Value |
- Since:
-
- 2.2.5
- Source:
(static, constant) DATA_TRANSFER_SESSION_TYPE :Object
The list of data transfers session types.
Properties:
Name | Type | Description |
---|---|---|
BLOB |
String |
Value |
DATA_URL |
String |
Value |
- Since:
-
- 0.1.0
- Source:
(static, constant) DATA_TRANSFER_STATE :Object
The list of data transfer states.
Properties:
Name | Type | Description |
---|---|---|
UPLOAD_REQUEST |
String |
Value |
UPLOAD_STARTED |
String |
Value |
DOWNLOAD_STARTED |
String |
Value |
REJECTED |
String |
Value |
USER_REJECTED |
String |
Value |
UPLOADING |
String |
Value |
DOWNLOADING |
String |
Value |
UPLOAD_COMPLETED |
String |
Value |
DOWNLOAD_COMPLETED |
String |
Value |
CANCEL |
String |
Value |
ERROR |
String |
Value |
- Since:
-
- 0.4.0
- Source:
(static, constant) GET_CONNECTION_STATUS_STATE :Object
The list of Skylink#getConnectionStatus
retrieval states.
Properties:
Name | Type | Description |
---|---|---|
RETRIEVING |
number |
Value |
RETRIEVE_SUCCESS |
number |
Value |
RETRIEVE_ERROR |
number |
Value |
- Since:
-
- 0.1.0
- Source:
(static, constant) GET_PEERS_STATE :Object
Note that this feature requiresThe list of"isPrivileged"
flag to be enabled for the App Key provided in SkylinkinitOptions
, as only Users connecting using the App Key with this flag enabled (which we call privileged Users / Peers) can retrieve the list of Peer IDs from Rooms within the same App space. Read more about privileged App Key feature here.
getPeers
method retrieval states.
Properties:
Name | Type | Description |
---|---|---|
ENQUIRED |
String |
Value |
RECEIVED |
String |
Value |
- Since:
-
- 0.6.1
- Source:
(static, constant) HANDSHAKE_PROGRESS :Object
The list of Peer connection states.
Properties:
Name | Type | Description |
---|---|---|
ENTER |
String |
Value |
WELCOME |
String |
Value |
OFFER |
String |
Value |
ANSWER |
String |
Value |
ANSWER_ACK |
string |
Value |
ERROR |
string |
Value |
- Since:
-
- 0.1.0
- Source:
(static, constant) ICE_CONNECTION_STATE :Object
Learn more about how ICE works in this article here.The list of Peer connection ICE connection states.
Properties:
Name | Type | Description |
---|---|---|
CHECKING |
String |
Value |
CONNECTED |
String |
Value |
COMPLETED |
String |
Value |
FAILED |
String |
Value |
DISCONNECTED |
String |
Value |
CLOSED |
String |
Value |
- Since:
-
- 0.1.0
- Source:
(static, constant) LOG_LEVEL :Object
The list of the SDK console
API log levels.
Properties:
Name | Type | Description |
---|---|---|
DEBUG |
number |
Value |
LOG |
number |
Value |
INFO |
number |
Value |
WARN |
number |
Value |
ERROR |
number |
Value |
NONE |
number |
Value |
- Since:
-
- 0.5.4
- Source:
(static, constant) MEDIA_ACCESS_FALLBACK_STATE :Object
The list of getUserMedia
or
shareScreen
Stream fallback states.
Properties:
Name | Type | Description |
---|---|---|
FALLBACKING |
Object |
Value |
FALLBACKED |
Object |
Value |
ERROR |
Object |
Value |
- Since:
-
- 0.6.14
- Source:
(static, constant) MEDIA_SOURCE :Object
The list of available screensharing media sources configured in the
shareScreen
.
Properties:
Name | Type | Description |
---|---|---|
SCREEN |
String |
Value |
WINDOW |
String |
Value |
TAB |
String |
Value |
TAB_AUDIO |
String |
Value |
APPLICATION |
String |
Value |
BROWSER |
String |
Value |
CAMERA |
String |
Value |
- Since:
-
- 0.5.10
- Source:
(static, constant) MEDIA_STATE
The state of the media.
Properties:
Name | Type | Description |
---|---|---|
MUTED |
String |
The state when the MediaTrack enabled flag is set to false. The MediaTrack is sending black frames. |
ACTIVE |
String |
The state when the MediaTrack enabled flag and active flag is set to true. The MediaTrack is sending frames with content. |
STOPPED |
String |
The state when the MediaTrack active flag is false. The MediaTrack is not sending any frames. |
UNAVAILABLE |
String |
The state when the MediaTrack is no longer available or has been disposed. |
- Since:
-
- 2.0
- Source:
(static, constant) MEDIA_STATUS :Object
The status of media on the stream.
Properties:
Name | Type | Description |
---|---|---|
MUTED |
number |
Value |
ACTIVE |
number |
Value |
UNAVAILABLE |
number |
Value |
- Since:
-
- 1.0
- Source:
(static, constant) MEDIA_TYPE
The list of media types.
Properties:
Name | Type | Description |
---|---|---|
AUDIO_MIC |
String |
Audio from a microphone. |
VIDEO_CAMERA |
String |
Video from a Camera of any type. |
VIDEO_SCREEN |
String |
Video of the Screen captured for screen sharing. |
VIDEO_OTHER |
String |
Video from source other than Camera. |
AUDIO |
String |
Audio from an unspecified MediaType. |
VIDEO |
String |
Video from an unspecified MediaType. |
- Since:
-
- 2.0
- Source:
(static, constant) PEER_CERTIFICATE :Object
Learn more about how ICE works in this article here.The list of available Peer connection certificates cryptographic algorithm to use.
Properties:
Name | Type | Description |
---|---|---|
RSA |
String |
Value |
ECDSA |
String |
Value |
AUTO |
String |
Value |
- Since:
-
- 0.6.18
- Source:
(static, constant) PEER_CONNECTION_STATE :Object
Learn more about how ICE works in this article here.The list of Peer connection session description exchanging states.
Properties:
Name | Type | Description |
---|---|---|
STABLE |
String |
Value |
HAVE_LOCAL_OFFER |
String |
Value |
HAVE_REMOTE_OFFER |
String |
Value |
CLOSED |
String |
Value |
CONNECTING |
String |
Value |
CONNECTED |
String |
Value |
FAILED |
String |
Value |
DISCONNECTED |
String |
Value |
- Since:
-
- 0.5.0
- Source:
(static, constant) READY_STATE_CHANGE :Object
The list of Skylink initOptions
ready states.
Properties:
Name | Type | Description |
---|---|---|
INIT |
number |
Value |
LOADING |
number |
Value |
COMPLETED |
number |
Value |
ERROR |
number |
Value |
- Since:
-
- 0.1.0
- Source:
(static, constant) READY_STATE_CHANGE_ERROR :Object
The list of Skylink initOptions
ready state failure codes.
Properties:
Name | Type | Description |
---|---|---|
API_INVALID |
number |
Value |
API_DOMAIN_NOT_MATCH |
number |
Value |
API_CORS_DOMAIN_NOT_MATCH |
number |
Value |
API_CREDENTIALS_INVALID |
number |
Value |
API_CREDENTIALS_NOT_MATCH |
number |
Value |
API_INVALID_PARENT_KEY |
number |
Value |
API_NO_MEETING_RECORD_FOUND |
number |
Value |
API_OVER_SEAT_LIMIT |
number |
Value |
API_RETRIEVAL_FAILED |
number |
Value |
API_WRONG_ACCESS_DOMAIN |
number |
Value |
XML_HTTP_REQUEST_ERROR |
number |
Value |
XML_HTTP_NO_REPONSE_ERROR |
number |
Value |
NO_SOCKET_IO |
number |
Value |
NO_XMLHTTPREQUEST_SUPPORT |
number |
Value |
NO_WEBRTC_SUPPORT |
number |
Value |
NO_PATH |
number |
Value |
ADAPTER_NO_LOADED |
number |
Value |
PARSE_CODECS |
number |
Value |
- Since:
-
- 0.4.0
- Source:
(static, constant) RECORDING_STATE :Object
The list of recording states.
Properties:
Name | Type | Description |
---|---|---|
START |
number |
Value |
STOP |
number |
Value |
LINK |
number |
Value |
ERROR |
number |
Value |
- Since:
-
- 0.6.16
- Source:
(static, constant) RTCP_MUX_POLICY :Object
Learn more about how ICE works in this article here.The list of available Peer connection RTCP mux policies.
Properties:
Name | Type | Description |
---|---|---|
REQUIRE |
String |
Value |
NEGOTIATE |
String |
Value |
- Since:
-
- 0.6.18
- Source:
(static, constant) RTMP_STATE :Object
The list of RTMP states.
Properties:
Name | Type | Description |
---|---|---|
START |
number |
Value |
STOP |
number |
Value |
ERROR |
number |
Value |
- Since:
-
- 0.6.34
- Source:
(static, constant) SDP_SEMANTICS :Object
The options available for SDP sematics while create a PeerConnection.
Properties:
Name | Type | Description |
---|---|---|
PLAN_B |
String |
The value of option to prefer plan-b sdp. |
UNIFIED |
String |
The value of option to prefer unified-plan sdp. |
- Since:
-
- 0.6.32
- Source:
(static, constant) SM_PROTOCOL_VERSION :string
Note that this is used only for SDK developer purposes.The value of the current version of the Signaling socket message protocol.
Current version:2.1.0
- Since:
-
- 0.6.0
- Source:
(static, constant) SOCKET_ERROR :Object
The list of joinRoom
socket connection failure states.
Properties:
Name | Type | Description |
---|---|---|
CONNECTION_FAILED |
number |
Value |
RECONNECTION_FAILED |
number |
Value |
CONNECTION_ABORTED |
number |
Value |
RECONNECTION_ABORTED |
number |
Value |
RECONNECTION_ATTEMPT |
number |
Value |
- Since:
-
- 0.5.6
- Source:
(static, constant) SOCKET_FALLBACK :Object
The list of joinRoom
socket connection reconnection states.
Properties:
Name | Type | Description |
---|---|---|
NON_FALLBACK |
String |
Value |
FALLBACK_PORT |
String |
Value |
FALLBACK_PORT_SSL |
String |
Value |
LONG_POLLING |
String |
Value |
LONG_POLLING_SSL |
String |
Value |
- Since:
-
- 0.5.6
- Source:
(static, constant) SYSTEM_ACTION :Object
The list of Signaling server reaction states during joinRoom
.
Properties:
Name | Type | Description |
---|---|---|
WARNING |
String |
Value |
REJECT |
String |
Value |
LOCKED |
String |
Value |
- Since:
-
- 0.5.1
- Source:
(static, constant) SYSTEM_ACTION_REASON :Object
The list of Signaling server reaction states reason of action code during
joinRoom
.
Properties:
Name | Type | Description |
---|---|---|
CREDENTIALS_EXPIRED |
String |
Value |
CREDENTIALS_ERROR |
String |
Value |
DUPLICATED_LOGIN |
String |
Value |
ROOM_NOT_STARTED |
String |
Value |
EXPIRED |
String |
Value |
ROOM_LOCKED |
String |
Value |
FAST_MESSAGE |
String |
Value |
ROOM_CLOSING |
String |
Value |
ROOM_CLOSED |
String |
Value |
SERVER_ERROR |
String |
Value |
KEY_ERROR |
String |
Value |
- Since:
-
- 0.5.2
- Source:
(static, constant) TURN_TRANSPORT :Object
Note that configuring the protocol may not necessarily result in the desired network transports protocol
used in the actual TURN network traffic as it depends which protocol the browser selects and connects with.
This simply configures the TURN ICE server urls query option when constructing
the Peer connection. When all protocols are selected, the ICE servers urls are duplicated with all protocols.
The list of TURN network transport protocols options when constructing Peer connections
configured in Skylink initOptions
.
Example .urls
inital input: ["turn:server.com?transport=tcp"
,
"turn:server1.com:3478"
, "turn:server.com?transport=udp"
]
Properties:
Name | Type | Description |
---|---|---|
TCP |
String |
Value |
UDP |
String |
Value |
ANY |
String |
Value |
NONE |
String |
Value |
ALL |
String |
Value |
- Since:
-
- 0.5.4
- Source:
(static, constant) VIDEO_QUALITY :Object
The options available for video and audio bitrates (kbps) quality.
Properties:
Name | Type | Description |
---|---|---|
HD |
Object |
Value |
HQ |
Object |
Value |
SQ |
Object |
Value |
LQ |
Object |
Value |
- Since:
-
- 0.6.32
- Source:
(static, constant) VIDEO_RESOLUTION :Object
Note that currently getUserMedia
method only configures
the maximum resolution of the Stream due to browser interopability and support.
The list of
video resolutions sets configured in the getUserMedia
method.
Properties:
Name | Type | Description |
---|---|---|
QQVGA |
Object |
Value |
HQVGA |
Object |
Value |
QVGA |
Object |
Value |
WQVGA |
Object |
Value |
HVGA |
Object |
Value |
VGA |
Object |
Value |
WVGA |
Object |
Value |
FWVGA |
Object |
Value |
SVGA |
Object |
Value |
DVGA |
Object |
Value |
WSVGA |
Object |
Value |
HD |
Object |
Value |
HDPLUS |
Object |
Value |
FHD |
Object |
Value |
QHD |
Object |
Value |
WQXGAPLUS |
Object |
Value |
UHD |
Object |
Value |
UHDPLUS |
Object |
Value |
FUHD |
Object |
Value |
QUHD |
Object |
Value |
- Since:
-
- 0.5.6
- Source:
Type Definitions
DT_PROTOCOL_VERSION :string
Note that this is used only for SDK developer purposes.The value of the current version of the data transfer protocol.
Current version:0.1.3
- Since:
-
- 2.0.0
- Source: