ApiRTC iOS SDK Documentation Beta

Classes

Api​RTC
Call

Designates a P2P call with another contact. During a call, both the user and the contact may publish and subscribe to each other's streams.

Contact​Message
Group​Chat​Message
Cloud​Api
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

Contact

Designates another user which may or may not be currently connected

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​Call

Represents a call within the context of a Conversation/Conference

Enterprise

This class refers to the user's enterprise

Invitation
Received​Call​Invitation

Defines an invitation received by this client for a call

Received​Conversation​Invitation

Defines an invitation received by this client for a conversation

Received​Conversation​Join​Request
Received​Invitation

Defines an invitation received by current user

Sent​Invitation

Defines an invitation sent by current user

Media
Media​Conv
Media​Uploaded
Media​Stream
Audio​Track
Media​Track
Video​Track
Observable

Observable object

Session

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

Stream
User​Agent

The UserAgent serves as the base to use apiRTC. A user can be authenticated or not. For an Apizee cloud user UserAgentOptions.uri is UserAgentURI.apizee(_:) . User can be anonymous if it's a client of an Apizee enterprise and use UserAgentURI.apzkey(_:) 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

Camera​View

Ready view handling local capture

Video​View

Ready view handling WebRTC video stream

Drawing​Element
Whiteboard​Client

WhiteboardClient using to control whiteboard tools, colors, views etc

Whiteboard​View

Whiteboard view

Structures

Agent
Answer​Options
Call​Options
Contact​List​Update

Represents useful information about changes in the group

Disconnect​Options
Enterprise​Information
Enterprise​Tag
Fetch​Enterprise​Information​Options
Fetch​Site​Agents​Options
Join​Options
Private​Conference​Creation​Options
Publish​Options
Register​Information
Room​Member​Update
Stream​Info
Stream​Mute​State​Change
Stream​Update
Subscribe​Options
User​Agent​Options
User​Data

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

Enumerations

External​Camera​State
Call​Event

Represents Call events

Call​Status

Represents Call status

Contact​Message​Event
Group​Chat​Message​Event
Contact​Event

Represents Contact events

Contact​Call​State

Represents Contact call state

Conversation​Event

Represents Conversation events

Conversation​Status

Represents Conversation status

Conversation​User​Role
Conversation​Access
Conversation​Call​Status

Represents ConversationCall status

Invitation​Status

Represents Invitation status

Invitation​Event

Represents Invitation event

Media​Track​Type

Represents MediaTrack type

Session​Connection​State

Represents Session connection states

Session​Event

Represents Session events

Stream​Event

Represents Stream event

Stream​Type

Represents Stream type

Stream​Muting​Line​Type

Represents Stream muting type

Stream​Media​Restriction

Represents Stream media restriction

Stream​Direction

Represents Stream direction

Contact​List​Update​Type

Represents type of ContactListUpdateType

Room​Member​Update​Type

Represents RoomMemberUpdate type

Stream​Info​Type
User​Agent​URI

Represents UserAgent URI types

Renderer​Type

Represents renderer type

Drawing​Element​Type

Represents DrawingElement type

Whiteboard​Event

Represents WhiteboardClient events

Whiteboard​Tool

Represents WhiteboardClient drawing tools

Whiteboard​View​Mode

Represents WhiteboardView mode

Err
Err.​User​Agent
Err.​Sesssion
Err.​Network
Err.​Contact
Err.​Token
Err.​Stream
Err.​Stream​Info
Err.​Cloud​Request
Err.​Cloud​Message
Err.​Cloud​Api
Err.​Preferred​CSSCloud​Message
Err.​Check​Token​Cloud​Message
Err.​Conference​Info
Err.​User​Info​Cloud​Message
Err.​Enterprise​Info​Cloud​Message
Err.​Enterprise​Users​List​Cloud​Message
Err.​Enterprise​Tags​Cloud​Message
Err.​Enterprise​Create​Conference​Cloud​Message
Err.​Enterprise​Upload​File​Cloud​Message
Err.​Conversation​Check​Access​Cloud​Message
Err.​Conversation​Get​OrCreate​Cloud​Message
Err.​Media​List​Cloud​Message
Err.​Media​Cloud​Message
Err.​Media​Upload​Cloud​Message
Err.​Utils
Err.​Socket
Err.​Socket​Message
Err.​Presence​Socket​Message
Err.​Call
Err.​Call​Manager
Err.​RTCClient
Err.​RTCSocket​Message
Err.​RTCInvite​Socket​Message
Err.​RTCAnswer​Socket​Message
Err.​RTCCandidate​Socket​Message
Err.​RTCBye​Socket​Message
Err.​RTCUpdate​Socket​Message
Err.​RTCAnswer​Update​Socket​Message
Err.​SDP
Err.​RTCCandidate
Err.​Conversation
Err.​Conversation​Call
Err.​Conversation​Manager
Err.​Conversation​Join​Answer​Socket​Message
Err.​Conversation​Available​Streams​Socket​Message
Err.​Conversation​Remove​Stream​Socket​Message
Err.​Room​Socket​Message
Err.​Room​Creation​Socket​Message
Err.​Room​Join​Answer​Socket​Message
Err.​Room​Invite​Status​Socket​Message
Err.​Room​Invitation​Socket​Message
Err.​Room​Member​Update​Socket​Message
Err.​Room​Message​Socket​Message
Err.​Data​Socket​Message
Err.​Invitation​Answer​Data​Socket​Message
Err.​Conversation​Invitation​Data​Socket​Message
Err.​Stream​Track​Changed​Data​Socket​Message
Err.​Command​Data​Socket​Message
Err.​Join​Access​Command​Data​Socket​Message
Err.​Join​Access​New​Command​Data​Socket​Message
Err.​Whiteboard​Manager
Err.​Drawing​Element
Err.​Text​Element
Err.​Invitation
Err.​Received​Conversation​Invitation
Err.​Enterprise
Err.​Agent
Err.​Enterprise​Tag
Err.​Chat​Socket​Message
Err.​Group​Chat​Message
Err.​New​Conversation​Created
Err.​Group​Chat​Member​Update​Socket​Message
Log​Type

Represents SDK log types.

Protocols

Event
E