Package com.apizee.apiRTC

Types

open class BaseFileEmitter( invitation: BaseSentInvitation, conversationCall: ConversationCall, dataChannel: DataChannel)

BaseSentInvitation

open class BaseSentInvitation( val session: Session, var id: String, fileInfo: Session.FileInfo, val data: ByteArray) : Invitation

Contact

class Contact( session: Session, id: String, userData: UserData = UserData(JSONObject())) : Emitter

Creates a new contact

Conversation

class Conversation(session: Session, name: String) : Emitter

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

ConversationCall

class ConversationCall( factory: PeerConnectionFactory?, name: String, session: Session, conversation: Conversation?, type: ConversationCall.Type, callId: String = Random.nextLong(1000000, 9000000000000000).toString())

Represents a call within the context of a conversation/conference.

Emitter

open class Emitter

The event emitter which is ported from the JavaScript module.

FileEmitter

open class FileEmitter( invitation: SentInvitation, conversationCall: ConversationCall, dataChannel: DataChannel) : BaseFileEmitter

FileReceiver

class FileReceiver(invitation: ReceivedFileTransferInvitation, uuid: String)

Invitation

open class Invitation(val session: Session, var id: String = Utils.randomString(22)) : Emitter

Promise

class Promise

ReceivedFileTransferInvitation

class ReceivedFileTransferInvitation( val session: Session, sender: Contact, var id: String, fileInfo: Session.FileInfo) : ReceivedInvitation

ReceivedInvitation

open class ReceivedInvitation( val session: Session, sender: Contact, var id: String) : Invitation

SentInvitation

open class SentInvitation( val session: Session, destination: Contact, var id: String, fileInfo: Session.FileInfo, val data: ByteArray) : BaseSentInvitation

Session

class Session( userAgent: UserAgent, options: UserAgent.RegisterInformation, ccs: String, apiKey: String?, val context: Context, apiRTCVersionName: String) : Emitter

Session represent the connected environment of an UA. It's created after UA registration.

Stream

class Stream( userAgent: UserAgent, createStreamOptions: UserAgent.CreateStreamOptions?, remoteMediaStream: MediaStream? = null)

A stream.

UserAgent

class UserAgent(val context: Context, options: UserAgent.UserAgentOptions)

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

UserData

class UserData(data: JSONObject)

The user data is used to define information specific to a contact. For example, information of contact environment, his webrtc capabilities or his profile information.

Properties

debug

const val debug: Boolean = false