Skip to content

Latest commit

 

History

History
88 lines (38 loc) · 2.38 KB

rtcninja.md

File metadata and controls

88 lines (38 loc) · 2.38 KB
Raw

rtcninja Module API

rtcninja() function

By calling the library as a function it performs the WebRTC check in the browser. This function MUST be called before attempting to use the library.

It returns true if the browser supports WebRTC.

rtcninja.hasWebRTC() function

Returns true if the browser supports WebRTC.

rtcninja.called read attribute

Returns true if rtcninja() was already called.

rtcninja.version read attribute

Returns a String with the version of the library.

rtcninja.version

=> "X.Y.Z"

rtcninja.debug

Provides access to the debug module.

rtcninja.mediaDevices object

Provides access to the native navigator.mediaDevices object (if supported), which includes Promise based getUserMedia() and enumerateDevices() methods as the specification defines.

rtcninja.getUserMedia(constraints, successCallback, errorCallback) function

Provides a wrapper over the native navigator.(webkit|moz)getUserMedia() function. As a feature, if WebRTC is not supported this function fires the given errorCallback instead of throwing an error.

rtcninja.getMediaDevices(successCallback) function

Provides a wrapper over the native navigator.getMediaDevices() or MediaStreamTrack.getSources().

NOTE: This method does not exist (rtcninja.getMediaDevices === undefined) if the browser does not support any of the native implementations to get the list of media devices.

rtcninja.RTCPeerConnection class

Provides access to the rtcninja.RTCPeerConnection class, which wrappes a native (webkit|moz)RTCPeerConnection.

rtcninja.RTCSessionDescription class

Wrapper for the native RTCSessionDescription class.

rtcninja.RTCIceCandidate class

Wrapper for the native RTCIceCandidate class.

rtcninja.MediaStreamTrack class

Wrapper for the native MediaStreamTrack class.

rtcninja.attachMediaStream(element, stream) function

Sets the given stream (of type MediaStream) as the source of the <video> or <audio> element pointed by element.

Returns the element itself.

rtcninja.closeMediaStream(stream) function

Closes the given stream (of type MediaStream).

rtcninja.canRenegotiate attribute

Boolean indicating whether SDP renegotiation is properly supported by the current WebRTC engine.