User Agent
class UserAgent(val context: Context, options: UserAgent.UserAgentOptions)
Content copied to clipboard
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
Parameters
options
all user connection options
Constructors
Types
Link copied to clipboard
data class CreateStreamOptions(var videoInputId: String? = null, val constraints: UserAgent.CreateStreamOptions.Constraints = Constraints())
Content copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class MediaDeviceList( val audioinput: List<UserAgent.MediaDeviceList.MediaDevice>, val audiooutput: List<UserAgent.MediaDeviceList.MediaDevice>, val videoinput: List<UserAgent.MediaDeviceList.MediaDevice>)
Content copied to clipboard
Link copied to clipboard
data class RegisterInformation( val cloudUrl: String, val ccsConnectionRetryNb: Int? = null, val ccsConnectionRetryDelay: Long? = null, val id: Long = Random.nextLong(1000000, 9000000000000000), var groups: ArrayList<String>? = null, var subscribeTo: ArrayList<String>? = null, val userData: JSONObject? = null)
Content copied to clipboard
Link copied to clipboard
Functions
Link copied to clipboard
fun createDisplayMediaStream(options: UserAgent.CreateStreamOptions?, videoCapturer: VideoCapturer): Promise
Content copied to clipboard
A promise for creating a screensharing stream object
Link copied to clipboard
A promise for creating a stream object
Link copied to clipboard
Get UserAgent browser name
Link copied to clipboard
Get UserAgent browser version
Link copied to clipboard
Get UserAgent OS version
Link copied to clipboard
return user media devices
Link copied to clipboard
Register a UA to the server.
Link copied to clipboard
fun unregister(options: UserAgent.DisconnectOptions? = DisconnectOptions(null))
Content copied to clipboard
Unregisters this UserAgent