voximplant library

Copyright (c) 2011-2020, Zingaya, Inc. All rights reserved.

Classes

VIAudioDeviceManager
Manages audio devices. [...]
VIAuthResult
Represents the result of successful login.
VICall
Represents a call.
VICallError
VICallSettings
Call settings with additional parameters for a call, such as preferred video codec, custom data, video directions and extra headers.
VICameraManager
Manages cameras.
VIClient
Interface that may be used to connect, login to the Voximplant CLoud, make and receive audio and video calls.
VIClientConfig
Configuration information for VIClient instance.
VIClientError
VIConversation
Interface that may be used to manage a conversation.
VIConversationConfig
Configuration either to create a new conversation or restore a previously created conversation: [...]
VIConversationEvent
Interface that represents messenger events related to conversations such as create, edit, remove, etc. [...]
VIConversationListEvent
Interface that represents messenger events related to conversation enumeration. [...]
VIConversationParticipant
Class that represents a participant of the conversation. [...]
VIConversationServiceEvent
Interface that represents messenger events such as typing, isRead. [...]
VIEndpoint
Represents a remote call participant.
VILoginTokens
Authentication parameters that may be used for login with access token.
VIMessage
Interface that represents message within a conversation.
VIMessageEvent
Interface that represents messenger events related to messages (send, update, remove). [...]
VIMessagingError
VIMessenger
Interface that may be used to control messaging functions.
VIMessengerEvent
Base interface that represents all messenger events provided via VIMessenger callbacks or as a result of method calls.
VIRetransmitEvent
Interface that represents the messenger events for the following methods call result: [...]
VIStatusEvent
Interface that represents the messenger events related to user status changes. [...]
VISubscriptionEvent
Interface that represents the messenger events related to subscriptions. [...]
VIUser
Interface that represents user information. Voximplant users are created via the Voximplant control panel or HTTP API.
VIUserEvent
Interface that represents messenger events related to users, such as get or edit user. [...]
VIVideoFlags
Specifies video direction for a call.
VIVideoStream
Represents local or remote video stream within a call.
VIVideoView
Stateful widget to render local or remote video represented via VIVideoStream. [...]
VIVideoViewController
A controller for a video view.
Voximplant
The entry point of the Voximplant Flutter SDK.

Enums

VIAudioDevice
Represents supported audio device types.
VICameraType
Represents supported camera types.
VIClientState
Represents client states.
VILogLevel
Log levels for iOS. [...]
VIMessengerAction
Enum that represents actions that trigger messenger events. Each action is the reason for every triggered event. [...]
VIMessengerEventType
Enum that represents types of messenger events.
VIMessengerNotification
Enum that represents events available for push notification subscriptions. [...]
VIRequestAudioFocusMode
Request audio focus mode for Android. [...]
VIVideoCodec
Represents supported video codecs.
VIVideoRotation
Represents supported video rotations.
VIVideoStreamType
Represents video stream types.

Typedefs

VIAudioDeviceChanged(VIAudioDeviceManager audioManager, VIAudioDevice device) → void
Signature for callbacks reporting that the active audio device or audio device that will be used for a further call is changed. [...]
VIAudioDeviceListChanged(VIAudioDeviceManager audioManager, List<VIAudioDevice> deviceList) → void
Signature for callbacks reporting that a new audio device is connected or a previously connected audio device is disconnected. [...]
VICallAudioStarted(VICall call) → void
Signature for callbacks reporting that the endpoint answered the call. [...]
VICallConnected(VICall call, Map<String, String> headers) → void
Signature for callbacks reporting that the call is connected. [...]
VICallDisconnected(VICall call, Map<String, String> headers, bool answeredElsewhere) → void
Signature for callbacks reporting that the call is disconnected. [...]
VICallFailed(VICall call, int code, String description, Map<String, String> headers) → void
Signature for callbacks reporting that the call was failed. [...]
VICallRinging(VICall call, Map<String, String> headers) → void
Signature for callbacks reporting when progress signal is received from the endpoint. [...]
VICreateConversation(VIConversationEvent conversationEvent) → void
Signature for callbacks reporting that a conversation was created via VIMessenger.createConversation or analogous methods from other Voximplant SDKs and Messaging API. [...]
VIEditConversation(VIConversationEvent conversationEvent) → void
Signature for callbacks reporting that the conversation properties were modified as the result of: [...]
VIEditMessage(VIMessageEvent messageEvent) → void
Signature for callbacks reporting that a message was edited via VIMessage.update or analogous methods from other Voximplant SDKs and Messaging API. [...]
VIEditUser(VIUserEvent userEvent) → void
Signature for callbacks reporting that an user was edited as the result of VIMessenger.editUser, VIMessenger.managePushNotifications [...]
VIEndpointAdded(VICall call, VIEndpoint endpoint) → void
Signature for callbacks reporting that new endpoint is added to the call. [...]
VIEndpointRemoved(VIEndpoint endpoint) → void
Signature for callbacks reporting that the endpoint removed from a call. [...]
VIEndpointUpdated(VIEndpoint endpoint) → void
Signature for callbacks reporting that the endpoint information such as display name, user name, and SIP URI is updates. [...]
VIICECompleted(VICall call) → void
Signature for callbacks reporting that ICE connection is complete. [...]
VIICETimeout(VICall call) → void
Signature for callbacks reporting that the connection was not established due to a network connection problem between 2 peers. [...]
VIIncomingCall(VIClient client, VICall call, bool video, Map<String, String> headers) → void
Signature for callbacks reporting that there is a new incoming call to the current user. [...]
VIIsRead(VIConversationServiceEvent conversationServiceEvent) → void
Signature for callbacks reporting that the event within a conversatio was marked as read as the result of VIConversation.markAsRead or analogous methods from other Voximplant SDKs and Messaging API. [...]
VILocalVideoStreamAdded(VICall call, VIVideoStream videoStream) → void
Signature for callbacks reporting that local video is added to the call. [...]
VILocalVideoStreamRemoved(VICall call, VIVideoStream videoStream) → void
Signature for callbacks reporting that local video is removed from the call. [...]
VIMessageReceived(VICall call, String message) → void
Signature for callbacks reporting that message is received within the call. [...]
VIPushDidExpire(VIClient client, String uuid) → void
Signature for callbacks reporting that previously received VoIP push notification is expired on iOS. [...]
VIRemoteVideoStreamAdded(VIEndpoint endpoint, VIVideoStream videoStream) → void
Signature for callbacks reporting that the endpoint added the video stream to the call. [...]
VIRemoteVideoStreamRemoved(VIEndpoint endpoint, VIVideoStream videoStream) → void
Signature for callbacks reporting that the endpoint removed the video stream from the call. [...]
VIRemoveConversation(VIConversationEvent conversationEvent) → void
Signature for callbacks reporting that a conversation was removed. [...]
VIRemoveMessage(VIMessageEvent messageEvent) → void
Signature for callbacks reporting that a message was removed via VIMessage.remove or analogous methods from other Voximplant SDKs and Messaging API. [...]
VISendMessage(VIMessageEvent messageEvent) → void
Signature for callbacks reporting that a message was sent via VIConversation.sendMessage or analogous methods from other Voximplant SDKs and Messaging API. [...]
VISetStatus(VIStatusEvent statusEvent) → void
Signature for callbacks reporting that an user changed status via VIMessenger.setStatus or analogous methods from other Voximplant SDKs and Messaging API. [...]
VISIPInfoReceived(VICall call, String type, String content, Map<String, String> headers) → void
Signature for callbacks reporting that INFO message is received. [...]
VISubscribe(VISubscriptionEvent subscriptionEvent) → void
Signature for callbacks reporting that the current user has subscribed to other users changes [...]
VITyping(VIConversationServiceEvent conversationServiceEvent) → void
Signature for callbacks reporting that a participant types a message in a conversation. Information about typing is sent via VIConversation.typing or analogous methods from other Voximplant SDKs and Messaging API. [...]
VIUnsubscribe(VISubscriptionEvent subscriptionEvent) → void
Signature for callbacks reporting that the current user has unsubscribed from other users changes. [...]

Exceptions / Errors

VIException