Byn.Awrtc.IAwrtcFactory Interface Reference

Factory to create new Call objects. More...

Inheritance diagram for Byn.Awrtc.IAwrtcFactory:

Public Member Functions
ICall	CreateCall (NetworkConfig config)
	Creates a new call object. Optional with a custom network configuration.
ICall	CreateCall (NetworkConfig config, IBasicNetwork signalingNetwork)
	Experimental. Creates a new call using the given IBasicNetwork interface for signaling.
IMediaNetwork	CreateMediaNetwork (NetworkConfig config)
	Creates a IMediaNetwork using the given network configuration.
IWebRtcNetwork	CreateBasicNetwork (string websocketUrl, IceServer[] urls=null)
	Creates a IBasicNetwork. The implementation details depend on the platform being used.
string[]	GetVideoDevices ()
	Returns an array of video devices. This list might be empty if no device is found or choice of devices is not supported on the platform.
bool	CanSelectVideoDevice ()
	Returns true if the video devices can be selected. False if there is no access (browser).

Detailed Description

Factory to create new Call objects.

See platform dependent documentation to find out how to get a reference to the ICallFactory.

Member Function Documentation

CanSelectVideoDevice()

bool Byn.Awrtc.IAwrtcFactory.CanSelectVideoDevice

(

)

Returns true if the video devices can be selected. False if there is no access (browser).

Returns

CreateBasicNetwork()

IWebRtcNetwork Byn.Awrtc.IAwrtcFactory.CreateBasicNetwork	(	string	websocketUrl,
		IceServer[]	urls = null )

Creates a IBasicNetwork. The implementation details depend on the platform being used.

Parameters

websocketUrl	Url used for signaling. Most start with ws or wss.
urls	Ice Server configuration for webrtc

Returns

Returns the created object or null if it fails (usually means platform not supported)

CreateCall() [1/2]

ICall Byn.Awrtc.IAwrtcFactory.CreateCall

(

NetworkConfig

config

)

Creates a new call object. Optional with a custom network configuration.

Do not forget to call Dispose after you finished the call or the connection might run forever in the background!

Parameters

config

Returns

CreateCall() [2/2]

ICall Byn.Awrtc.IAwrtcFactory.CreateCall	(	NetworkConfig	config,
		IBasicNetwork	signalingNetwork )

Experimental. Creates a new call using the given IBasicNetwork interface for signaling.

Parameters

config
signalingNetwork

Returns

CreateMediaNetwork()

IMediaNetwork Byn.Awrtc.IAwrtcFactory.CreateMediaNetwork

(

NetworkConfig

config

)

Creates a IMediaNetwork using the given network configuration.

Parameters

config

Returns

GetVideoDevices()

string[] Byn.Awrtc.IAwrtcFactory.GetVideoDevices

(

)

Returns an array of video devices. This list might be empty if no device is found or choice of devices is not supported on the platform.

Returns

A list of video devices or null if choice of video devices isn't supported by the current platform.

---

The documentation for this interface was generated from the following file:

• /Volumes/macdev/wrtc/main_new/awrtc/awrtc_cs_common/Byn.Awrtc/IAwrtcFactory.cs