Classes Reference


                    
                    
                    ApiRTC

Undocumented

Declaration

Swift

open class ApiRTC : Observable<ApiRTCEvent>


                    
                    
                    ChatMessage

Declaration

Swift

open class ChatMessage

extension ChatMessage: Equatable


                    
                    
                    CloudApi

Declaration

Swift

open class CloudApi


                    
                    
                    Contact

Represents any user

Declaration

Swift

open class Contact : Observable<ContactEvent>

extension Contact: Equatable


                    
                    
                    Conference

A conference is a type of Conversation that may require privilege to join Conference may only be created if your enterprise has the conference feature enabled on the Apizee platform

Declaration

Swift

open class Conference : Conversation


                    
                    
                    Conversation

Represents conversation N-N communication context

Declaration

Swift

open class Conversation : Observable<ConversationEvent>

extension Conversation: Equatable


                    
                    
                    ConversationCall

Represents a call within Conversation context

Declaration

Swift

open class ConversationCall


                    
                    
                    DataChannel

Declaration

Swift

open class DataChannel


                    
                    
                    Enterprise

Represents UserAgent’s enterprise

Declaration

Swift

open class Enterprise


                    
                    
                    Invitation

Declaration

Swift

open class Invitation : Observable<InvitationEvent>

extension Invitation: Equatable


                    
                    
                    ReceivedCallInvitation

Represents P2P call invitation

Declaration

Swift

open class ReceivedCallInvitation : ReceivedInvitation


                    
                    
                    ReceivedConversationInvitation

Represents conversation invitation

Declaration

Swift

open class ReceivedConversationInvitation : ReceivedInvitation


                    
                    
                    ReceivedConversationJoinRequest

Represents a conversation join request (matters when UA is a moderator)

Declaration

Swift

open class ReceivedConversationJoinRequest : ReceivedInvitation


                    
                    
                    ReceivedInvitation

Declaration

Swift

open class ReceivedInvitation : Invitation


                    
                    
                    SentInvitation

Represents an invitation sent by local user

Declaration

Swift

open class SentInvitation : Invitation


                    
                    
                    CloudMediaInfo

Declaration

Swift

open class CloudMediaInfo

extension CloudMediaInfo: Equatable


                    
                    
                    Media

Declaration

Swift

open class Media


                    
                    
                    MediaStream

Declaration

Swift

open class MediaStream

extension MediaStream: Equatable


                    
                    
                    AudioTrack

Declaration

Swift

open class AudioTrack : MediaTrack


                    
                    
                    MediaTrack

Declaration

Swift

open class MediaTrack


                    
                    
                    VideoTrack

Declaration

Swift

open class VideoTrack : MediaTrack


                    
                    
                    Observable

Observable object supports public API events

Declaration

Swift

open class Observable<T> where T : Event


                    
                    
                    Call

Represents a P2P call with another contact.

Declaration

Swift

open class Call : Observable<CallEvent>

extension Call: Equatable


                    
                    
                    Session

Session represent the connected context of UserAgent.

Declaration

Swift

open class Session : Observable<SessionEvent>

extension Session: Equatable


                    
                    
                    Stream

Declaration

Swift

open class Stream : Observable<StreamEvent>

extension Stream: Equatable


                    
                    
                    UserAgent

The UserAgent serves as the base to use apiRTC. A user agent can be authenticated or not. For an ApiRTC cloud platform user UserAgentOptions.uri is prefixed with UserAgentURI.apirtc(_:). User can be anonymous if it’s a client of an ApiRTC cloud platform enterprise, use prefix UserAgentURI.apiKey(_:) as uri. Once registered Session object can be used to communicate with other contacts using the platform on the same API key and CCS server

Declaration

Swift

open class UserAgent


                    
                    
                    CameraView

Ready view handling local capture

Declaration

Swift

open class CameraView : RTCCameraPreviewView


                    
                    
                    VideoView

Ready view handling WebRTC video stream

Declaration

Swift

open class VideoView : UIView

extension VideoView: RTCVideoViewDelegate


                    
                    
                    DrawingElement

Declaration

Swift

open class DrawingElement


                    
                    
                    WhiteboardClient

WhiteboardClient using to control whiteboard tools, colors, views etc

Declaration

Swift

open class WhiteboardClient : Observable<WhiteboardEvent>

extension WhiteboardClient: Equatable


                    
                    
                    WhiteboardView

Represents whiteboard view

Declaration

Swift

open class WhiteboardView : UIView