WEBRTC
EDGE IOT
DEVELOPER
CASES
PRICING
BLOG
Try now
Login
Overview
WebRTC
Edge
Cloud API
WebRTC Guides
WebRTC SDKs
WebRTC API Reference
CLIENTS
JS WebRTC Client
Introduction
Signaling Client
SignalingClientOptions
SignalingClientOptions.productId
SignalingClientOptions.deviceId
SignalingClientOptions.requireOnline
SignalingClientOptions.endpointUrl
SignalingClientOptions.accessToken
SignalingClient
SignalingClient.start
SignalingClient.close
SignalingClient.checkAlive
SignalingClient.sendMessage
SignalingClient.sendError
SignalingClient.requestIceServers
SignalingClient.connectionState
SignalingClient.channelState
SignalingClient.on
SignalingClient.off
SignalingClient.channelId
createSignalingClient
SignalingConnectionState
SignalingConnectionState.NEW
SignalingConnectionState.CONNECTING
SignalingConnectionState.CONNECTED
SignalingConnectionState.WAIT_RETRY
SignalingConnectionState.FAILED
SignalingConnectionState.connectionstatechange
Signaling Channel
SignalingChannelState
SignalingChannelState.NEW
SignalingChannelState.CONNECTED
SignalingChannelState.DISCONNECTED
SignalingChannelState.FAILED
SignalingChannelState.CLOSED
Signaling Errors
SignalingErrorCodes
SignalingErrorCodes.DECODE_ERROR
SignalingErrorCodes.VERIFICATION_ERROR
SignalingErrorCodes.CHANNEL_CLOSED
SignalingErrorCodes.CHANNEL_NOT_FOUND
SignalingErrorCodes.NO_MORE_CHANNELS
SignalingErrorCodes.ACCESS_DENIED
SignalingErrorCodes.INTERNAL_ERROR
SignalingError
SignalingError.constructor
JS WebRTC Client Util
Introduction
Message Transport
ClientMessageTransportSecurityMode
sharedSecret
keyId
ClientMessageTransportOptions
createClientMessageTransport
DeviceMessageTransportSecurityMode
securityMode
sharedSecretCallback
createDeviceMessageTransport
WebrtcSignalingMessageType
WebrtcSignalingMessageType.DESCRIPTION
WebrtcSignalingMessageType.CANDIDATE
SignalingCandidate
SignalingDescription
WebrtcSignalingMessage
MessageTransportMode
MessageTransport
MessageTransport.mode
MessageTransport.sendWebrtcSignalingMessage
MessageTransport.on
MessageTransport.off
Perfect Negotiation
PerfectNegotiation
Signaling Event Handler
SignalingEventHandler
Android WebRTC Client
Introduction
Signaling Client
SignalingClient
SignalingClient.Observer
SignalingClient.Observer.onConnectionStateChange
SignalingClient.Observer.onMessage
SignalingClient.Observer.onChannelStateChange
SignalingClient.Observer.onConnectionReconnect
SignalingClient.Observer.onError
SignalingClient.AbstractObserver
SignalingClient.start
SignalingClient.getConnectionState
SignalingClient.getChannelState
SignalingClient.sendMessage
SignalingClient.sendError
SignalingClient.checkAlive
SignalingClient.addObserver
SignalingClient.removeObserver
SignalingConnectionState
SignalingClientFactory
SignalingClientFactory.Options
SignalingClientFactory.Options.setEndpointUrl
SignalingClientFactory.Options.setProductId
SignalingClientFactory.Options.setDeviceId
SignalingClientFactory.Options.setRequireOnline
SignalingClientFactory.Options.setAccessToken
SignalingClientFactory.createSignalingClient
Signaling Channel
SignalingChannelState
Signaling Error
SignalingError
SignalingError.DECODE_ERROR
SignalingError.VERIFICATION_ERROR
SignalingError.CHANNEL_CLOSED
SignalingError.CHANNEL_NOT_FOUND
SignalingError.NO_MORE_CHANNELS
SignalingError.ACCESS_DENIED
SignalingError.INTERNAL_ERROR
SignalingError.errorCode
SignalingError.errorMessage
Android WebRTC Client Util
Introduction
Message Transport
createSharedSecretMessageTransport
createNoneMessageTransport
MessageTransport
MessageTransport.sendWebrtcSignalingMessage
MessageTransport.addObserver
MessageTransport.removeObserver
MessageTransport.Observer
MessageTransport.Observer.onWebrtcSignalingMessage
MessageTransport.Observer.onError
MessageTransport.Observer.onSetupDone
MessageTransport.AbstractObserver
WebrtcSignalingMessage
WebrtcSignalingMessage.WebrtcSignalingMessage
WebrtcSignalingMessage.isCandidate
WebrtcSignalingMessage.isDescription
WebrtcSignalingMessage.getCandidate
WebrtcSignalingMessage.getDescription
SignalingCandidate
SignalingCandidate.Candidate
SignalingCandidate.Candidate.candidate
SignalingCandidate.Candidate.sdpMid
SignalingCandidate.Candidate.sdpMLineIndex
SignalingCandidate.Candidate.usernameFragment
SignalingCandidate.SignalingCandidate
SignalingCandidate.withSdpMid
SignalingCandidate.withSdpMLineIndex
SignalingCandidate.withUsernameFragment
SignalingCandidate.toJson
SignalingCandidate.toJsonString
SignalingCandidate.fromJson
SignalingDescription
SignalingDescription.Description
SignalingDescription.Description.type
SignalingDescription.Description.sdp
SignalingDescription.SignalingDescription
SignalingDescription.toJson
SignalingDescription.toJsonString
SignalingDescription.fromJson
SignalingIceServer
SignalingIceServer.List
SignalingIceServer.credential
SignalingIceServer.username
SignalingIceServer.SignalingIceServer
SignalingIceServer.withCredential
SignalingIceServer.withUsername
SignalingIceServer.fromJson
Perfect Negotiation
PerfectNegotiation
PerfectNegotiation.PerfectNegotiation
iOS WebRTC Client
Introduction
Signaling Client
SignalingConnectionState
SignalingChannelState
SignalingClientObserver
SignalingClientObserver.signalingClient
SignalingClientObserver.signalingClientDidConnectionReconnect
SignalingClient
SignalingClient.start
SignalingClient.close
SignalingClient.sendMessage
SignalingClient.sendError
SignalingClient.checkAlive
SignalingClient.addObserver
SignalingClient.removeObserver
SignalingClientError
SignalingClientOptions
createSignalingClient
Signaling Channel
Signaling Error
HttpError
HttpError.deviceIdNotFound
HttpError.poductIdNotFound
HttpError.unknown
DeviceOfflineError
SignalingErrorCode
SignalingError
JSON Value
JSONValue
JSONValueEncoder
JSONValueDecoder
iOS WebRTC Client Util
Introduction
Message Transport
MessageTransportObserver
MessageTransportObserver.messageTransport
MessageTransport
MessageTransport.sendWebrtcSignalingMessage
MessageTransport.addObserver
MessageTransport.removeObserver
ClientMessageTransportOptions
ClientMessageTransportOptions.none
ClientMessageTransportOptions.sharedSecret
createClientMessageTransport
SignalingCandidate
SignalingCandidate.Candidate
SignalingCandidate.Candidate.candidate
SignalingCandidate.Candidate.sdpMid
SignalingCandidate.Candidate.sdpMLineIndex
SignalingCandidate.Candidate.usernameFragment
SignalingCandidate.candidate
SignalingCandidate.init
SignalingCandidate.toJson
SignalingCandidate.fromJson
SignalingDescription
SignalingDescription.Description
SignalingDescription.Description.type
SignalingDescription.Description.sdp
SignalingDescription.description
SignalingDescription.init
SignalingDescription.toJson
SignalingDescription.fromJson
SignalingIceServer
SignalingIceServer.urls
SignalingIceServer.credential
SignalingIceServer.username
SignalingIceServer.init
SignalingIceServer.toJson
SignalingIceServer.fromJson
WebrtcSignalingMessage
WebrtcSignalingMessage.init
Perfect Negotiation
PerfectNegotiation
PerfectNegotiation.init
CAMERAS
C++ WebRTC Camera
Introduction
Signaling Device
SignalingHttpRequest
SignalingHttpRequest.method
SignalingHttpRequest.url
SignalingHttpRequest.headers
SignalingHttpRequest.body
SignalingHttpResponse
SignalingHttpResponse.statusCode
SignalingHttpResponse.headers
SignalingHttpResponse.body
HttpResponseCallback
SignalingHttpClient
SignalingHttpClient.sendRequest
SignalingWebsocket
SignalingWebsocket.send
SignalingWebsocket.close
SignalingWebsocket.onOpen
SignalingWebsocket.onMessage
SignalingWebsocket.onClosed
SignalingWebsocket.onError
SignalingWebsocket.open
SignalingTimerFactory
SignalingTimerFactory.createTimer
SignalingTimer
SignalingTimer.setTimeout
SignalingTimer.cancel
SignalingTokenGenerator
SignalingTokenGenerator.generateToken
SignalingDeviceState
signalingDeviceStateToString
IceServer
IceServer.username
IceServer.credential
IceServer.urls
NewSignalingChannelHandler
SignalingDeviceStateHandler
SignalingReconnectHandler
IceServersResponse
SignalingDeviceConfig
SignalingDeviceConfig.deviceId
SignalingDeviceConfig.productId
SignalingDeviceConfig.tokenProvider
SignalingDeviceConfig.signalingUrl
SignalingDeviceConfig.wsImpl
SignalingDeviceConfig.httpCli
SignalingDeviceConfig.timerFactory
SignalingDeviceFactory
SignalingDeviceFactory.create
SignalingDevice
SignalingDevice.start
SignalingDevice.close
SignalingDevice.checkAlive
SignalingDevice.requestIceServers
SignalingDevice.addNewChannelListener
SignalingDevice.removeNewChannelListener
SignalingDevice.addStateChangeListener
SignalingDevice.removeStateChangeListener
SignalingDevice.addReconnectListener
SignalingDevice.removeReconnectListener
SignalingDevice.version
Signaling Channel
SignalingErrorCode
SignalingError
SignalingError.SignalingError
SignalingError.errorCode
SignalingError.errorMessage
SignalingError.errorCodeToString
SignalingChannelState
signalingChannelStateToString
SignalingMessageHandler
SignalingChannelStateHandler
SignalingErrorHandler
SignalingChannel
SignalingChannel.addMessageListener
SignalingChannel.removeMessageListener
SignalingChannel.addStateChangeListener
SignalingChannel.removeStateChangeListener
SignalingChannel.addErrorListener
SignalingChannel.removeErrorListener
SignalingChannel.sendMessage
SignalingChannel.sendError
SignalingChannel.close
SignalingChannel.getChannelId
C++ WebRTC Camera Util
Introduction
Curl HTTP Client
CurlHttpClient
CurlHttpClient.create
CurlAsyncInvokeCallback
CurlAsync
CurlAsync.create
CurlAsync.stop
CurlAsync.getCurl
CurlAsync.asyncInvoke
CurlAsync.asyncReinvoke
CurlAsync.reinvoke
CurlAsync.reinvokeStatus
Logging
initLogger
Message Transport
MessageTransportSharedSecretHandler
MessageTransportFactory
MessageTransportFactory.createSharedSecretTransport
MessageTransportFactory.createNoneTransport
SignalingDescription
SignalingDescription.SignalingDescription
SignalingDescription.toJson
SignalingDescription.type
SignalingDescription.sdp
SignalingCandidate
SignalingCandidate.SignalingCandidate
SignalingCandidate.setSdpMid
SignalingCandidate.setSdpMLineIndex
SignalingCandidate.setUsernameFragment
SignalingCandidate.toJson
SignalingCandidate.candidate
SignalingCandidate.sdpMid
SignalingCandidate.sdpMLineIndex
SignalingCandidate.usernameFragment
WebrtcSignalingMessage
WebrtcSignalingMessage.fromJson
WebrtcSignalingMessage.WebrtcSignalingMessage
WebrtcSignalingMessage.isDescription
WebrtcSignalingMessage.isCandidate
WebrtcSignalingMessage.getDescription
WebrtcSignalingMessage.getCandidate
SetupDoneHandler
MessageTransportMessageHandler
MessageTransport
MessageTransport.addSetupDoneListener
MessageTransport.removeSetupDoneListener
MessageTransport.addMessageListener
MessageTransport.removeMessageListener
MessageTransport.addErrorListener
MessageTransport.removeErrorListener
MessageTransport.sendMessage
Std Timer
StdTimer
StdTimerFactory
StdTimerFactory.create
Token Generator
NabtoTokenGenerator
NabtoTokenGenerator.create
UUID
generate_uuid_v4
JS WebRTC Camera
Introduction
Signaling Device
SignalingDeviceOptions
SignalingDeviceOptions.endpointUrl
SignalingDeviceOptions.productId
SignalingDeviceOptions.deviceId
SignalingDeviceOptions.tokenGenerator
SignalingDevice
SignalingDevice.onNewSignalingChannel
SignalingDevice.requestIceServers
SignalingDevice.start
SignalingDevice.close
SignalingDevice.checkAlive
SignalingDevice.connectionState
SignalingDevice.on
SignalingDevice.off
createSignalingDevice
SignalingConnectionState
SignalingConnectionState.NEW
SignalingConnectionState.CONNECTING
SignalingConnectionState.CONNECTED
SignalingConnectionState.WAIT_RETRY
SignalingConnectionState.FAILED
SignalingConnectionState.connectionstatechange
Signaling Channel
SignalingChannel
SignalingChannel.sendMessage
SignalingChannel.sendError
SignalingChannel.close
SignalingChannel.channelState
SignalingChannel.on
SignalingChannel.off
SignalingChannel.channelId
SignalingChannelState
SignalingChannelState.NEW
SignalingChannelState.CONNECTED
SignalingChannelState.DISCONNECTED
SignalingChannelState.FAILED
SignalingChannelState.CLOSED
Signaling Errors
SignalingErrorCodes
SignalingErrorCodes.DECODE_ERROR
SignalingErrorCodes.VERIFICATION_ERROR
SignalingErrorCodes.CHANNEL_CLOSED
SignalingErrorCodes.CHANNEL_NOT_FOUND
SignalingErrorCodes.NO_MORE_CHANNELS
SignalingErrorCodes.ACCESS_DENIED
SignalingErrorCodes.INTERNAL_ERROR
SignalingError
SignalingError.constructor
JS WebRTC Camera Util
Introduction
Message Transport
ClientMessageTransportSecurityMode
sharedSecret
keyId
ClientMessageTransportOptions
createClientMessageTransport
DeviceMessageTransportSecurityMode
securityMode
sharedSecretCallback
createDeviceMessageTransport
WebrtcSignalingMessageType
WebrtcSignalingMessageType.DESCRIPTION
WebrtcSignalingMessageType.CANDIDATE
SignalingCandidate
SignalingDescription
WebrtcSignalingMessage
MessageTransportMode
MessageTransport
MessageTransport.mode
MessageTransport.sendWebrtcSignalingMessage
MessageTransport.on
MessageTransport.off
Perfect Negotiation
PerfectNegotiation
Signaling Event Handler
SignalingEventHandler
Token Generator
DeviceTokenGenerator
DeviceTokenGenerator.constructor
DeviceTokenGenerator.generateToken
Connection Timeout
DeviceConnectionTimeout
DeviceConnectionTimeout.constructor
SignalingClient.sendError()
DESCRIPTION
Send an error across to the peer
DECLARATION
func sendError(_ error: SignalingError) async
PARAMETERS
error:
The SignalingError to send
