Skip navigation links
A C D E G H I J L M O P R S T U 

A

attachToElement(videoView) - Method in class com.apizee.apiRTC.Stream
Attaches stream to SurfaceViewRenderer element

C

call() - Method in interface com.apizee.apiRTC.Emitter.Listener
 
com.apizee.apiRTC - package com.apizee.apiRTC
 
Companion - Static variable in class com.apizee.apiRTC.Conversation
 
Companion - Static variable in class com.apizee.apiRTC.ConversationCall
 
Companion - Static variable in class com.apizee.apiRTC.Session
 
Companion - Static variable in class com.apizee.apiRTC.Stream
 
Companion - Static variable in class com.apizee.apiRTC.UserAgent
 
component1() - Method in class com.apizee.apiRTC.Conversation.EventStreamHangup
 
component1() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
Event type
component1() - Method in class com.apizee.apiRTC.UserAgent.CreateStreamOptions
video input device id
component1() - Method in class com.apizee.apiRTC.CreateStreamOptions.Constraints
false to diasble audio
component1() - Method in class com.apizee.apiRTC.UserAgent.DisconnectOptions
 
component1() - Method in class com.apizee.apiRTC.UserAgent.MediaDeviceList
 
component1() - Method in class com.apizee.apiRTC.MediaDeviceList.MediaDevice
 
component1() - Method in class com.apizee.apiRTC.UserAgent.RegisterInformation
Registration apizee cloud url
component1() - Method in class com.apizee.apiRTC.UserAgent.UserAgentOptions
Registration URI,
component2() - Method in class com.apizee.apiRTC.Conversation.EventStreamHangup
 
component2() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
Whether the stream belongs to a contact
component2() - Method in class com.apizee.apiRTC.UserAgent.CreateStreamOptions
audio and video constraints
component2() - Method in class com.apizee.apiRTC.CreateStreamOptions.Constraints
false to disable video
component2() - Method in class com.apizee.apiRTC.UserAgent.MediaDeviceList
 
component2() - Method in class com.apizee.apiRTC.MediaDeviceList.MediaDevice
 
component2() - Method in class com.apizee.apiRTC.UserAgent.RegisterInformation
Set a predefined id for the session instead of the cloud id or a random id
component3() - Method in class com.apizee.apiRTC.Conversation.EventStreamHangup
 
component3() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
Stream identifier.
component3() - Method in class com.apizee.apiRTC.UserAgent.MediaDeviceList
 
component4() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
Call ID.
component5() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
Either
component6() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
 
component7() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
 
component8() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
 
component9() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
 
Constraints(audio, video) - Constructor for class com.apizee.apiRTC.CreateStreamOptions.Constraints
 
Constraints() - Constructor for class com.apizee.apiRTC.CreateStreamOptions.Constraints
 
Conversation - Class in com.apizee.apiRTC
Users are able to interact with each other by entering a conversation in a N-N fashion. The client is able to listen to conversation events that will be fired once the conversation is joined
Conversation(session, name) - Constructor for class com.apizee.apiRTC.Conversation
Users are able to interact with each other by entering a conversation in a N-N fashion. The client is able to listen to conversation events that will be fired once the conversation is joined
Conversation.Companion - Class in com.apizee.apiRTC
 
Conversation.EventStreamHangup - Class in com.apizee.apiRTC
 
Conversation.Result - Enum in com.apizee.apiRTC
 
Conversation.StreamInfo - Class in com.apizee.apiRTC
 
ConversationCall - Class in com.apizee.apiRTC
Represents a call within the context of a conversation/conference.
ConversationCall(factory, session, conversation) - Constructor for class com.apizee.apiRTC.ConversationCall
Represents a call within the context of a conversation/conference.
ConversationCall.Companion - Class in com.apizee.apiRTC
 
copy(from, reason, streamId) - Method in class com.apizee.apiRTC.Conversation.EventStreamHangup
 
copy(listEventType, isRemote, streamId, callId, type, name, callType, roomId, callerId) - Method in class com.apizee.apiRTC.Conversation.StreamInfo
 
copy(audio, video) - Method in class com.apizee.apiRTC.CreateStreamOptions.Constraints
 
copy(videoInputId, constraints) - Method in class com.apizee.apiRTC.UserAgent.CreateStreamOptions
 
copy(unused) - Method in class com.apizee.apiRTC.UserAgent.DisconnectOptions
 
copy(audioinput, audiooutput, videoinput) - Method in class com.apizee.apiRTC.UserAgent.MediaDeviceList
 
copy(id, label) - Method in class com.apizee.apiRTC.MediaDeviceList.MediaDevice
 
copy(cloudUrl, id) - Method in class com.apizee.apiRTC.UserAgent.RegisterInformation
 
copy(uri) - Method in class com.apizee.apiRTC.UserAgent.UserAgentOptions
 
createStream(options, callback) - Method in class com.apizee.apiRTC.UserAgent
Initialize stream
CreateStreamOptions(videoInputId, constraints) - Constructor for class com.apizee.apiRTC.UserAgent.CreateStreamOptions
 
CreateStreamOptions() - Constructor for class com.apizee.apiRTC.UserAgent.CreateStreamOptions
 
CreateStreamOptions.Constraints - Class in com.apizee.apiRTC
 

D

destroyConversation(name) - Method in class com.apizee.apiRTC.Session
 
detachFromElement(videoView) - Method in class com.apizee.apiRTC.Stream
 
DisconnectOptions(unused) - Constructor for class com.apizee.apiRTC.UserAgent.DisconnectOptions
 

E

emit() - Method in class com.apizee.apiRTC.Emitter
Executes each of listeners with the given args.
Emitter - Class in com.apizee.apiRTC
The event emitter which is ported from the JavaScript module. This class is thread-safe.
Emitter.Listener - Interface in com.apizee.apiRTC
 
equals(p) - Method in class com.apizee.apiRTC.Conversation.EventStreamHangup
 
equals(p) - Method in class com.apizee.apiRTC.Conversation.StreamInfo
 
equals(p) - Method in class com.apizee.apiRTC.CreateStreamOptions.Constraints
 
equals(p) - Method in class com.apizee.apiRTC.UserAgent.CreateStreamOptions
 
equals(p) - Method in class com.apizee.apiRTC.UserAgent.DisconnectOptions
 
equals(p) - Method in class com.apizee.apiRTC.UserAgent.MediaDeviceList
 
equals(p) - Method in class com.apizee.apiRTC.MediaDeviceList.MediaDevice
 
equals(p) - Method in class com.apizee.apiRTC.UserAgent.RegisterInformation
 
equals(p) - Method in class com.apizee.apiRTC.UserAgent.UserAgentOptions
 
EVENT_CONNECT - Static variable in class com.apizee.apiRTC.Conversation
 
EVENT_DISCONNECT - Static variable in class com.apizee.apiRTC.Conversation
 
EVENT_ERROR - Static variable in class com.apizee.apiRTC.Conversation
 
EVENT_HANGUP - Static variable in class com.apizee.apiRTC.Conversation
 
EVENT_JOIN - Static variable in class com.apizee.apiRTC.Conversation
 
EVENT_STREAM_ADDED - Static variable in class com.apizee.apiRTC.Conversation
 
EVENT_STREAM_LIST_CHANGED - Static variable in class com.apizee.apiRTC.Conversation
 
EVENT_STREAM_REMOVED - Static variable in class com.apizee.apiRTC.Conversation
 
EventStreamHangup(from, reason, streamId) - Constructor for class com.apizee.apiRTC.Conversation.EventStreamHangup
 

G

getAudio() - Method in class com.apizee.apiRTC.CreateStreamOptions.Constraints
false to diasble audio
getAudioinput() - Method in class com.apizee.apiRTC.UserAgent.MediaDeviceList
 
getAudiooutput() - Method in class com.apizee.apiRTC.UserAgent.MediaDeviceList
 
getCallerId() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
 
getCallId() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
Call ID.
getCallId() - Method in class com.apizee.apiRTC.ConversationCall
Call id of the call represented by this one.
getCallType() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
 
getCloudUrl() - Method in class com.apizee.apiRTC.UserAgent.RegisterInformation
Registration apizee cloud url
getConstraints() - Method in class com.apizee.apiRTC.UserAgent.CreateStreamOptions
audio and video constraints
getContext() - Method in class com.apizee.apiRTC.UserAgent
Application context
getConversation(conversationName) - Method in class com.apizee.apiRTC.Session
Deprecated. 
getConversationCall(stream) - Method in class com.apizee.apiRTC.Conversation
Returns the conversation call handle for a given stream.
getEglBaseContext() - Method in class com.apizee.apiRTC.UserAgent.Companion
 
getFrom() - Method in class com.apizee.apiRTC.Conversation.EventStreamHangup
 
getId() - Method in class com.apizee.apiRTC.MediaDeviceList.MediaDevice
 
getId() - Method in class com.apizee.apiRTC.UserAgent.RegisterInformation
Set a predefined id for the session instead of the cloud id or a random id
getLabel() - Method in class com.apizee.apiRTC.MediaDeviceList.MediaDevice
 
getListEventType() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
Event type
getName() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
 
getOrCreateConversation(name) - Method in class com.apizee.apiRTC.Session
Gets or creates a conversation for a given name.
getReason() - Method in class com.apizee.apiRTC.Conversation.EventStreamHangup
 
getRoomId() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
 
getStreamId() - Method in class com.apizee.apiRTC.Conversation.EventStreamHangup
 
getStreamId() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
Stream identifier.
getType() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
Either
getUnused() - Method in class com.apizee.apiRTC.UserAgent.DisconnectOptions
 
getUri() - Method in class com.apizee.apiRTC.UserAgent.UserAgentOptions
Registration URI,
getUserMediaDevices() - Method in class com.apizee.apiRTC.UserAgent
return user media devices
getVideo() - Method in class com.apizee.apiRTC.CreateStreamOptions.Constraints
false to disable video
getVideoinput() - Method in class com.apizee.apiRTC.UserAgent.MediaDeviceList
 
getVideoInputId() - Method in class com.apizee.apiRTC.UserAgent.CreateStreamOptions
video input device id

H

hashCode() - Method in class com.apizee.apiRTC.Conversation.EventStreamHangup
 
hashCode() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
 
hashCode() - Method in class com.apizee.apiRTC.CreateStreamOptions.Constraints
 
hashCode() - Method in class com.apizee.apiRTC.UserAgent.CreateStreamOptions
 
hashCode() - Method in class com.apizee.apiRTC.UserAgent.DisconnectOptions
 
hashCode() - Method in class com.apizee.apiRTC.UserAgent.MediaDeviceList
 
hashCode() - Method in class com.apizee.apiRTC.MediaDeviceList.MediaDevice
 
hashCode() - Method in class com.apizee.apiRTC.UserAgent.RegisterInformation
 
hashCode() - Method in class com.apizee.apiRTC.UserAgent.UserAgentOptions
 
hasListeners() - Method in class com.apizee.apiRTC.Emitter
Check if this emitter has listeners for the specified event.

I

isRemote() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
Whether the stream belongs to a contact

J

join(callback) - Method in class com.apizee.apiRTC.Conversation
Connects to a conversation if not already joined Once in the conversation, the user will be able to see other contacts inside it, send and receive messages, publish streams and subscribe to conversation's streams

L

leave() - Method in class com.apizee.apiRTC.Conversation
Leaves conversation The user will automatically stop publishing its streams to the conversation and stop subscribing to streams from the conversation. The user will no longer receive events from the conversation The user will no longer see who's within the conversation
listeners() - Method in class com.apizee.apiRTC.Emitter
Returns a list of listeners for the specified event.

M

MediaDevice(id, label) - Constructor for class com.apizee.apiRTC.MediaDeviceList.MediaDevice
 
MediaDeviceList(audioinput, audiooutput, videoinput) - Constructor for class com.apizee.apiRTC.UserAgent.MediaDeviceList
 
MediaDeviceList.MediaDevice - Class in com.apizee.apiRTC
 
muteAudio() - Method in class com.apizee.apiRTC.Stream
Mutes this stream's audio If this stream is published to another contact, the stream will also be muted on the contact's side If this stream is subscribed from another contact, muting the stream will have no impact on the contact's side
muteVideo() - Method in class com.apizee.apiRTC.Stream
Mutes this stream's video If this stream is published to another contact, the stream will also be muted on the contact's side If this stream is subscribed from another contact, muting the stream will have no impact on the contact's side

O

off() - Method in class com.apizee.apiRTC.Emitter
Removes all registered listeners.
off() - Method in class com.apizee.apiRTC.Emitter
Removes all listeners of the specified event.
off() - Method in class com.apizee.apiRTC.Emitter
Removes the listener.
on() - Method in class com.apizee.apiRTC.Emitter
Listens on the event.
once() - Method in class com.apizee.apiRTC.Emitter
Adds a one time listener for the event.

P

publish(stream) - Method in class com.apizee.apiRTC.Conversation
Publish stream to conversation The stream will be able to be subscribed by other contacts within the conversation

R

register(options, callback) - Method in class com.apizee.apiRTC.UserAgent
Register a UA to the server.
RegisterInformation(cloudUrl, id) - Constructor for class com.apizee.apiRTC.UserAgent.RegisterInformation
 
release() - Method in class com.apizee.apiRTC.Stream
Release all tracks (either video or audio) used by this stream
replacePublishedStream(newStream, oldStream) - Method in class com.apizee.apiRTC.Conversation
Replaces the currently published stream by a given one.
replacePublishedStream(newStream) - Method in class com.apizee.apiRTC.ConversationCall
Replaces the currently published stream by a given one.
Result() - Constructor for enum com.apizee.apiRTC.Conversation.Result
 
Result() - Constructor for enum com.apizee.apiRTC.UserAgent.Result
 

S

Session - Class in com.apizee.apiRTC
Session represent the connected environment of an UA. It's created after UA registration.
Session(ccs, apiKey) - Constructor for class com.apizee.apiRTC.Session
 
Session.Companion - Class in com.apizee.apiRTC
 
setAudio(p) - Method in class com.apizee.apiRTC.CreateStreamOptions.Constraints
false to diasble audio
setId(p) - Method in class com.apizee.apiRTC.MediaDeviceList.MediaDevice
 
setLabel(p) - Method in class com.apizee.apiRTC.MediaDeviceList.MediaDevice
 
setListEventType(p) - Method in class com.apizee.apiRTC.Conversation.StreamInfo
Event type
setVideo(p) - Method in class com.apizee.apiRTC.CreateStreamOptions.Constraints
false to disable video
setVideoInputId(p) - Method in class com.apizee.apiRTC.UserAgent.CreateStreamOptions
video input device id
Stream - Class in com.apizee.apiRTC
A stream.
Stream(userAgent, createStreamOptions, remoteMediaStream) - Constructor for class com.apizee.apiRTC.Stream
 
Stream.Companion - Class in com.apizee.apiRTC
 
StreamInfo(listEventType, isRemote, streamId, callId, type, name, callType, roomId, callerId) - Constructor for class com.apizee.apiRTC.Conversation.StreamInfo
 
subscribeToStream(streamId, callback) - Method in class com.apizee.apiRTC.Conversation
Subscribes to a stream. The subscription will automatically stop if the contact publishing the stream unpublishes it. The Conversation#streamAdded event will be fired when the stream becomes available The Conversation#streamRemoved event will be fired when the stream is no longer available The Conversation#hangup event will be fired the subscription is terminated.

T

toString() - Method in class com.apizee.apiRTC.Conversation.EventStreamHangup
 
toString() - Method in class com.apizee.apiRTC.Conversation.StreamInfo
 
toString() - Method in class com.apizee.apiRTC.CreateStreamOptions.Constraints
 
toString() - Method in class com.apizee.apiRTC.UserAgent.CreateStreamOptions
 
toString() - Method in class com.apizee.apiRTC.UserAgent.DisconnectOptions
 
toString() - Method in class com.apizee.apiRTC.MediaDeviceList.MediaDevice
 
toString() - Method in class com.apizee.apiRTC.UserAgent.MediaDeviceList
 
toString() - Method in class com.apizee.apiRTC.UserAgent.RegisterInformation
 
toString() - Method in class com.apizee.apiRTC.UserAgent.UserAgentOptions
 

U

unmuteAudio() - Method in class com.apizee.apiRTC.Stream
Unmutes this stream's audio If this stream is published to another contact, the stream will also be unmuted on the contact's side If this stream is subscribed from another contact, unmuting the stream will have no impact on the contact's side, moreover, it will not unmute the stream if it has been muted by the contact
unmuteVideo() - Method in class com.apizee.apiRTC.Stream
Unmutes this stream's video If this stream is published to another contact, the stream will also be unmuted on the contact's side If this stream is subscribed from another contact, muting the stream will have no impact on the contact's side, moreover, it will not unmute the stream if it has been muted by the contact
unregister(options) - Method in class com.apizee.apiRTC.UserAgent
Unregisters this UserAgent
UserAgent - Class in com.apizee.apiRTC
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
UserAgent(context, options) - Constructor for class com.apizee.apiRTC.UserAgent
 
UserAgent.Companion - Class in com.apizee.apiRTC
 
UserAgent.CreateStreamOptions - Class in com.apizee.apiRTC
 
UserAgent.DisconnectOptions - Class in com.apizee.apiRTC
 
UserAgent.MediaDeviceList - Class in com.apizee.apiRTC
 
UserAgent.RegisterInformation - Class in com.apizee.apiRTC
 
UserAgent.Result - Enum in com.apizee.apiRTC
 
UserAgent.UserAgentOptions - Class in com.apizee.apiRTC
 
UserAgentOptions(uri) - Constructor for class com.apizee.apiRTC.UserAgent.UserAgentOptions
 
A C D E G H I J L M O P R S T U 
Skip navigation links