Classes
- ApiRTC
- 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.
- ContactMessage
- GroupChatMessage
- CloudApi
- 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
- ConversationCall
-
Represents a call within the context of a
Conversation
/Conference
- Enterprise
-
This class refers to the user's enterprise
- Invitation
- ReceivedCallInvitation
-
Defines an invitation received by this client for a call
- ReceivedConversationInvitation
-
Defines an invitation received by this client for a conversation
- ReceivedConversationJoinRequest
- ReceivedInvitation
-
Defines an invitation received by current user
- SentInvitation
-
Defines an invitation sent by current user
- Media
- MediaConv
- MediaUploaded
- MediaStream
- AudioTrack
- MediaTrack
- VideoTrack
- Observable
-
Observable object
- Session
-
Session represent the connected environment of an UA. It's created after UA registration.
- Stream
- UserAgent
-
The
UserAgent
serves as the base to use apiRTC. A user can be authenticated or not. For an Apizee cloud userUserAgentOptions.uri
isUserAgentURI.apizee(_:)
. User can be anonymous if it's a client of an Apizee enterprise and useUserAgentURI.apzkey(_:)
as uri. Once registeredSession
object can be used to communicate with other contacts using the platform on the same API key and CCS server - CameraView
-
Ready view handling local capture
- VideoView
-
Ready view handling WebRTC video stream
- DrawingElement
- WhiteboardClient
-
WhiteboardClient using to control whiteboard tools, colors, views etc
- WhiteboardView
-
Whiteboard view
Structures
- Agent
- AnswerOptions
- CallOptions
- ContactListUpdate
-
Represents useful information about changes in the group
- DisconnectOptions
- EnterpriseInformation
- EnterpriseTag
- FetchEnterpriseInformationOptions
- FetchSiteAgentsOptions
- JoinOptions
- PrivateConferenceCreationOptions
- PublishOptions
- RegisterInformation
- RoomMemberUpdate
- StreamInfo
- StreamMuteStateChange
- StreamUpdate
- SubscribeOptions
- UserAgentOptions
- UserData
-
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
- ExternalCameraState
- CallEvent
-
Represents
Call
events - CallStatus
-
Represents
Call
status - ContactMessageEvent
- GroupChatMessageEvent
- ContactEvent
-
Represents
Contact
events - ContactCallState
-
Represents
Contact
call state - ConversationEvent
-
Represents
Conversation
events - ConversationStatus
-
Represents
Conversation
status - ConversationUserRole
- ConversationAccess
- ConversationCallStatus
-
Represents
ConversationCall
status - InvitationStatus
-
Represents
Invitation
status - InvitationEvent
-
Represents
Invitation
event - MediaTrackType
-
Represents
MediaTrack
type - SessionConnectionState
-
Represents
Session
connection states - SessionEvent
-
Represents
Session
events - StreamEvent
-
Represents
Stream
event - StreamType
-
Represents
Stream
type - StreamMutingLineType
-
Represents
Stream
muting type - StreamMediaRestriction
-
Represents
Stream
media restriction - StreamDirection
-
Represents
Stream
direction - ContactListUpdateType
-
Represents type of
ContactListUpdateType
- RoomMemberUpdateType
-
Represents
RoomMemberUpdate
type - StreamInfoType
- UserAgentURI
-
Represents UserAgent URI types
- RendererType
-
Represents renderer type
- DrawingElementType
-
Represents
DrawingElement
type - WhiteboardEvent
-
Represents
WhiteboardClient
events - WhiteboardTool
-
Represents
WhiteboardClient
drawing tools - WhiteboardViewMode
-
Represents
WhiteboardView
mode - Err
- Err.UserAgent
- Err.Sesssion
- Err.Network
- Err.Contact
- Err.Token
- Err.Stream
- Err.StreamInfo
- Err.CloudRequest
- Err.CloudMessage
- Err.CloudApi
- Err.PreferredCSSCloudMessage
- Err.CheckTokenCloudMessage
- Err.ConferenceInfo
- Err.UserInfoCloudMessage
- Err.EnterpriseInfoCloudMessage
- Err.EnterpriseUsersListCloudMessage
- Err.EnterpriseTagsCloudMessage
- Err.EnterpriseCreateConferenceCloudMessage
- Err.EnterpriseUploadFileCloudMessage
- Err.ConversationCheckAccessCloudMessage
- Err.ConversationGetOrCreateCloudMessage
- Err.MediaListCloudMessage
- Err.MediaCloudMessage
- Err.MediaUploadCloudMessage
- Err.Utils
- Err.Socket
- Err.SocketMessage
- Err.PresenceSocketMessage
- Err.Call
- Err.CallManager
- Err.RTCClient
- Err.RTCSocketMessage
- Err.RTCInviteSocketMessage
- Err.RTCAnswerSocketMessage
- Err.RTCCandidateSocketMessage
- Err.RTCByeSocketMessage
- Err.RTCUpdateSocketMessage
- Err.RTCAnswerUpdateSocketMessage
- Err.SDP
- Err.RTCCandidate
- Err.Conversation
- Err.ConversationCall
- Err.ConversationManager
- Err.ConversationJoinAnswerSocketMessage
- Err.ConversationAvailableStreamsSocketMessage
- Err.ConversationRemoveStreamSocketMessage
- Err.RoomSocketMessage
- Err.RoomCreationSocketMessage
- Err.RoomJoinAnswerSocketMessage
- Err.RoomInviteStatusSocketMessage
- Err.RoomInvitationSocketMessage
- Err.RoomMemberUpdateSocketMessage
- Err.RoomMessageSocketMessage
- Err.DataSocketMessage
- Err.InvitationAnswerDataSocketMessage
- Err.ConversationInvitationDataSocketMessage
- Err.StreamTrackChangedDataSocketMessage
- Err.CommandDataSocketMessage
- Err.JoinAccessCommandDataSocketMessage
- Err.JoinAccessNewCommandDataSocketMessage
- Err.WhiteboardManager
- Err.DrawingElement
- Err.TextElement
- Err.Invitation
- Err.ReceivedConversationInvitation
- Err.Enterprise
- Err.Agent
- Err.EnterpriseTag
- Err.ChatSocketMessage
- Err.GroupChatMessage
- Err.NewConversationCreated
- Err.GroupChatMemberUpdateSocketMessage
- LogType
-
Represents SDK log types.
Protocols
- Event
- E