com.apizee.apiRTC

Class UserAgent

com.apizee.apiRTC.UserAgent

public class UserAgent

The UserAgent serves as the base to use apiRTC. A user agent can be authenticated or not. For an Apizee cloud user, the uri is prefixed with 'apizee:'. He can be anonymous if it's a client of an Apizee enterprise and use prefix apzkey: as uri. Once registered, its Session object can be used to communicate with other contacts using the platform on the same API key and CCS server

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserAgent.Companion
static class	UserAgent.CreateStreamOptions
static class	UserAgent.DisconnectOptions
static class	UserAgent.MediaDeviceList
static class	UserAgent.RegisterInformation
static class	UserAgent.UserAgentOptions

Field Summary

Fields

Modifier and Type	Field and Description
static UserAgent.Companion	Companion

Constructor Summary

Constructors

Constructor and Description
UserAgent(android.content.Context context, UserAgent.UserAgentOptions options)

Method Summary

Modifier and Type	Method and Description
UserAgent	createStream(UserAgent.CreateStreamOptions options, kotlin.jvm.functions.Function2<? super com.apizee.apiRTC.UserAgent.Result,? super com.apizee.apiRTC.Stream,kotlin.Unit> callback) Initialize stream
android.content.Context	getContext() Application context
UserAgent.MediaDeviceList	getUserMediaDevices() return user media devices
UserAgent	register(UserAgent.RegisterInformation options, kotlin.jvm.functions.Function2<? super com.apizee.apiRTC.UserAgent.Result,? super com.apizee.apiRTC.Session,kotlin.Unit> callback) Register a UA to the server.
void	unregister(UserAgent.DisconnectOptions options) Unregisters this UserAgent

Field Detail

Companion

public static UserAgent.Companion Companion

Constructor Detail

UserAgent

public UserAgent(android.content.Context context,
                 UserAgent.UserAgentOptions options)

Parameters:

context - Application context

options - all user connection options

options - all user connection options

Method Detail

register

public UserAgent register(UserAgent.RegisterInformation options,
                          kotlin.jvm.functions.Function2<? super com.apizee.apiRTC.UserAgent.Result,? super com.apizee.apiRTC.Session,kotlin.Unit> callback)

Register a UA to the server.

Parameters:

options - all user connection options

callback - Callback with the connected Session as argument

Returns:

a reference to this object

createStream

public UserAgent createStream(UserAgent.CreateStreamOptions options,
                              kotlin.jvm.functions.Function2<? super com.apizee.apiRTC.UserAgent.Result,? super com.apizee.apiRTC.Stream,kotlin.Unit> callback)

Initialize stream

Parameters:

options -

callback - Callback to call when operation is terminated

Returns:

a reference to this object

unregister

public void unregister(UserAgent.DisconnectOptions options)

Unregisters this UserAgent

Parameters:

options -

getUserMediaDevices

public UserAgent.MediaDeviceList getUserMediaDevices()

return user media devices

getContext

public android.content.Context getContext()

Application context