Namespace: Base

Classes

AudioDevice

AudioInputInterface

AudioInterface

AudioOutputInterface

BaseError

Capability

DataRetrieval

DataSet

LoggerInterface

Mask

MediaInterface

MediaServices

Promise

Rect

SettingsFileParser

VideoDevice

VideoInterface

Namespaces

Library

Members

<static, readonly> CapabilityDenialReason :String

Denial reasons for capabilities.

Type:

• String

Properties:

Name	Type	Default	Description
CAPABILITY_NOT_DENIED	String	CAPABILITY_NOT_DENIED
CAPABILITY_INVALID_STATE	String	CAPABILITY_INVALID_STATE
CAPABILITY_NOT_SUPPORTED	String	CAPABILITY_NOT_SUPPORTED
CAPABILITY_CALL_IS_REMOTE	String	CAPABILITY_CALL_IS_REMOTE
CAPABILITY_CALL_IS_NOT_REMOTE	String	CAPABILITY_CALL_IS_NOT_REMOTE
CAPABILITY_CALL_HAS_NO_AUDIO	String	CAPABILITY_CALL_HAS_NO_AUDIO
CAPABILITY_CALL_HAS_NO_VIDEO	String	CAPABILITY_CALL_HAS_NO_VIDEO
CAPABILITY_NOT_ALLOWED	String	CAPABILITY_NOT_ALLOWED
CAPABILITY_NEED_SIGNIN	String	CAPABILITY_NEED_SIGNIN
CAPABILITY_NEED_MODERATOR	String	CAPABILITY_NEED_MODERATOR
CAPABILITY_NEED_SIGNIN_OR_MODERATOR	String	CAPABILITY_NEED_SIGNIN_OR_MODERATOR
CAPABILITY_NOT_INSTALLED	String	CAPABILITY_NOT_INSTALLED
CAPABILITY_NOT_CONFERENCE_OWNER	String	CAPABILITY_NOT_CONFERENCE_OWNER
CAPABILITY_HARDWARE_NOT_SUPPORTED	String	CAPABILITY_HARDWARE_NOT_SUPPORTED
CAPABILITY_BROWSER_NOT_SUPPORTED	String	CAPABILITY_BROWSER_NOT_SUPPORTED
CAPABILITY_WEBGL_NOT_SUPPORTED	String	CAPABILITY_WEBGL_NOT_SUPPORTED
CAPABILITY_HARDWARE_GPU_NOT_AVAILABLE	String	CAPABILITY_HARDWARE_GPU_NOT_AVAILABLE
CAPABILITY_DISABLED_BY_ADMIN	String	CAPABILITY_DISABLED_BY_ADMIN
CAPABILITY_REMOTE_CONTROL_NOT_SUPPORTED	String	CAPABILITY_REMOTE_CONTROL_NOT_SUPPORTED
CAPABILITY_REMOTE_CONTROL_INCOMPATIBLE	String	CAPABILITY_REMOTE_CONTROL_INCOMPATIBLE

<static, readonly> DataRetrievalStatus :String

Data Retrieval statuses.

Type:

• String

Properties:

Name	Type	Default	Description
IN_PROGRESS	String	IN_PROGRESS
DONE	String	DONE
CANCELLED	String	CANCELLED
FAILED	String	FAILED

<static, readonly> DataSetChangeTypes :String

DataSet change types. Used in onDataSetCallback.

Type:

• String

Properties:

Name	Type	Default	Description
ADDED	String	ADDED	Set of elements has been added to the DataSet
REMOVED	String	REMOVED	Set of elements has been removed to the DataSet
UPDATED	String	UPDATED	Set of elements has been updated to the DataSet

<static, readonly> ErrorReasons :String

Type:

• String

Properties:

Name	Type	Default	Description
CAPABILITY_INVALID_STATE	String	Service is in invalid state.	CAPABILITIES
CAPABILITY_NOT_SUPPORTED	String	Feature is not supported.
CAPABILITY_CALL_IS_REMOTE	String
CAPABILITY_CALL_IS_NOT_REMOTE	String
CAPABILITY_CALL_HAS_NO_AUDIO	String
CAPABILITY_CALL_HAS_NO_VIDEO	String
CAPABILITY_NOT_ALLOWED	String	Action is not allowed.
CAPABILITY_NEED_SIGN_IN	String
CAPABILITY_NEED_MODERATOR	String
CAPABILITY_NEED_SIGN_IN_OR_MODERATOR	String
CAPABILITY_NOT_INSTALLED	String	Extension is not installed.
NETWORK_ERROR	String	Failed to perform operation. Network error occurred.	NETWORK
NETWORK_UNAUTHORIZED	String	Failed to perform operation due to authorization failure.
NETWORK_AUTHORIZATION_CANCELED	String	Failed to perform operation due to canceled authentication.
NETWORK_CANCELED	String	Failed to perform operation. Operation was canceled.
SOCKET_CLOSED	String	Failed to perform operation. Socket closed.
ERROR_SENDING	String	Failed to perform operation. Error sending
INTERNAL_ERROR	String	An internal error occurred.	OTHER
TIMEOUT	String	An operation has timed out
LIBRARY_NOT_SUPPORTED	String	Library is not supported.
DEPRECATED	String	Use of deprecated API is not recommended as if this function may be removed in the future.
BACKOFF_ALGORITHM_CANCELLED	String	Backoff Algorithm canceled.

<static> MediaStreamError :string

Enumeration describing MediaStreamErrors.

Type:

• string

Properties:

Name	Type	Default	Description
ABORT	string	AbortError	Although the user and operating system both granted access to the hardware device, and no hardware issues occurred, some problem occurred which prevented the device from being used.
NOT_ALLOWED	string	NotAllowedError	One or more of the requested source devices cannot be used at this time. Possible reasons: browsing context is insecure (HTTP), the user has denied access for the current session/globally.
PERMISSION_DENIED	string	PermissionDeniedError	Similar to NotAllowedError. One or more of the requested source devices cannot be used at this time. Possible reasons: browsing context is insecure (HTTP), the user has denied access for the current session/globally.
NOT_FOUND	string	NotFoundError	No media tracks of the type specified were found that satisfy the given constraints.
NOT_READABLE	string	NotReadableError	Although the user granted permission to use the matching devices, a hardware error occurred at the operating system, browser, or Web page level.
OVERCONSTRAINED	string	OverconstrainedError	The specified constraints resulted in no candidate devices which met the criteria requested.
SECURITY	string	SecurityError	User media support is disabled on the Document on which getUserMedia() was called.
TYPE	string	TypeError	The list of constraints specified is empty, or has all constraints set to false.
DEVICES_NOT_FOUND	string	DevicesNotFoundError	Similar to NotFoundError. No media tracks of the type specified were found that satisfy the given constraints.

<static, readonly> MediaTypes :String

Media types.

Type:

• String

Properties:

Name	Type	Default	Description
AUDIO_INPUT	String	audioinput
AUDIO_OUTPUT	String	audiooutput
VIDEO_INPUT	String	videoinput

Type Definitions

AbsoluteCategoryRating

Helps to indicate the quality of service using Absolute Category Rating method.

Type:

• number