Aculab Web Services Wrapper (v1.2.0)
\
Aculab
WebServicesWrapper
VoiceBiometrics
Users

\Aculab\WebServicesWrapperWebRTCClientWebService

WebRTC Client Web Service.

Summary

Methods
Properties
Constants
setWebServicesServer()
setCryptoMethod()
setProxy()
__construct()
getRegisteredClients()
generateToken()
No public properties found
VERSION
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

VERSION

VERSION

The wrapper version.

The wrapper version number.

Methods

setWebServicesServer()

setWebServicesServer(string  $wsserver)

Set the web services server address.

This allows the web service requests to be directed to a specific server. The default is https://ws-<cloud_id>.aculabcloud.net

Parameters

string $wsserver

The base URL of the web services server.

setCryptoMethod()

setCryptoMethod(integer  $method)

Set the crypto method used when connectiing to the web services server.

This allows a specific crypto method to be used when connecting to the web service server. The values should be one of the STREAM_CRYPTO_METHOD_TLSv1_N_CLIENT constants. The default is STREAM_CRYPTO_METHOD_ANY_CLIENT.

Parameters

integer $method

The crypto method to use.

setProxy()

setProxy(string  $proxy, boolean  $request_fulluri)

Configures the proxy server to use when making Web Service requests.

Parameters

string $proxy

URI specifying address of proxy server. (e.g. tcp://proxy.example.com:5100).
boolean $request_fulluri

When set to TRUE, the entire URI will be used when constructing the request. While this is a non-standard request format, some proxy servers require it.

__construct()

__construct(string  $cloud_id, string  $username, string  $access_key)

Create a WebRTCClientWebService object.

Parameters

string $cloud_id

The cloud identifier, such as "1-2-0".
string $username

The cloud account username.
string $access_key

The access key for the cloud account.

getRegisteredClients()

getRegisteredClients() : array

List registered WebRTC clients.

This lists the WebRTC clients that are currently registered for calls.

Throws

\Aculab\WebServicesWrapper\WebServiceException

Returns

array —

Returns an array of RegisteredWebRTCClientDetails objects.

generateToken()

generateToken(string  $client_id, integer  $ttl, boolean  $enable_incoming = null, array|string  $call_client = null) : string

Generate a token for a WebRTC client.

This generates a token for a WebRTC client to use when registering for calls.

Parameters

string $client_id

The client id of the WebRTC client that will be registered. This is the same as the clientId used when creating the WebRTC client.
integer $ttl

The time, in seconds, that the token is valid for. This must be between 600 and 86400 inclusive. Uses the service default if zero.
boolean $enable_incoming

Whether the token will be used for enabling incoming calls or not. Uses the service default if null.
array|string $call_client

An array of Ids or single Id of clients that can be called by the client. For each id, the last character can be a '*' wildcard in which case it matches any client whose Id starts with the string. A single '*' matches all clients. If no value is given the token cannot be used for calling other clients.

Throws

\Aculab\WebServicesWrapper\WebServiceException

Returns

string —

The generated token.