connectycube_calls library

Classes

AddressBookResult
AndroidAudioConfiguration
AndroidNativeAudioManagement
AppleAudioConfiguration
AppleNativeAudioManagement
AudioOutputOptions
An object that configures what device(s) may be offered in the user prompt.
AutoManagedQuery<T>
BaseAuthQuery<T>
BaseCallSession<S extends BaseSession<dynamic, PeerConnection>>
CallClient<S extends P2PCallSession>
CallType
Candidate
List of candidate fields
ConferenceCallSession
ConferenceClient
ConferenceConfig
ConferenceSession
CreateSessionQuery
CreateUserQuery
CubeContact
CubeEntity
CubeEnvironment
CubeMicLevelEvent
CubePlatform
CubeProvider
CubeSession
CubeSessionManager
CubeSettings
CubeStatsReport
CubeStatsReportsManager
CubeUser
CubeVideoBitrateEvent
DeleteItemsResult
DeleteSessionQuery
DeleteUserQuery
DesktopCapturer
DesktopCapturerSource
FrameCryptor
Frame encryption/decryption.
FrameCryptorFactory
Factory for creating frame Cryptors. For End 2 End Encryption, you need to create a KeyProvider for each peer. And set your key in keyProvider.
GetAddressBookQuery
GetRegisteredUsers
GetSessionQuery
GetUserQuery
GetUsersQuery
GetUsersV2Query
Helper
JanusResponseEventCallback
JanusSignaler
KeyProvider
Shared secret key for frame encryption.
KeyProviderOptions
MediaDeviceInfo
This describe the media input and output devices, such as microphones, cameras, headsets, and so forth.
MediaDevices
MediaRecorder
MediaStream
https://w3c.github.io/mediacapture-main/#mediastream
MediaStreamConstraints
MediaStreamTrack
MediaTrackSupportedConstraints
MediaTrackSupportedConstraints represents the list of constraints controlling the capabilities of a MediaStreamTrack.
NotificationsChannels
NotificationType
OrderType
P2PCallSession
P2PClient
P2PSession
PagedResult<T>
PushEventType
Query<T>
QueryRule
RequestFieldType
RequestFilter
RequestPaginator
RequestSorter
ResetPasswordQuery
RestRequest
RestResponse
RTCConfig
RTCDataChannel
RTCDataChannelInit
RTCDataChannelMessage
A class that represents a datachannel message. Can either contain binary data as a Uint8List or text data as a String.
RTCDTMFSender
RTCFactory
RTCFactoryNative
RTCHeaderExtension
RTCIceCandidate
RTCMediaConfig
RTCPeerConnection
RTCRTCPParameters
RTCRtpCapabilities
RTCRTPCodec
RTCRtpCodecCapability
RTCRtpEncoding
RTCRtpHeaderExtensionCapability
RTCRtpParameters
RTCRtpReceiver
RTCRtpSender
RTCRtpTransceiver
RTCRtpTransceiverInit
RTCSessionDescription
RTCSessionStateCallback<T extends BaseSession<dynamic, PeerConnection>>
RTCTrackEvent
RTCVideoRenderer
RTCVideoValue
RTCVideoView
ScreenSelectDialog
SignalCMD
List of webrtc signals
SignalField
List of signal fields used for XMPP message assembling
SignInQuery
SignOutQuery
SimulcastConfig
StatsReport
ThumbnailSize
ThumbnailWidget
UpdateUserQuery
UploadAddressBookQuery
VideoRenderer
WebRTC

Constants

ADDRESS_BOOK_ENDPOINT → const String
APP_ID → const String
AUTH_ENDPOINT → const String
AUTH_KEY → const String
BLOBS_ENDPOINT → const String
BY_CRITERIA → const String
CALLS_ENDPOINT → const String
CHAT_ENDPOINT → const String
COMPACT → const String
CONTACTS → const String
DATA_ENDPOINT → const String
DIALOG_ENDPOINT → const String
EMAIL → const String
EMPTY_STRING → const String
EVENTS_ENDPOINT → const String
EXTERNAL_ID → const String
EXTERNAL_USER_ID → const String
FILTER_EMAIL → const String
FILTER_FACEBOOK_ID → const String
FILTER_FULL_NAME → const String
FILTER_ID → const String
FILTER_LOGIN → const String
FILTER_PARAM_NAME → const String
FILTER_PHONE → const String
FILTER_PREFIX → const String
FILTER_TAGS → const String
FILTER_TWITTER_ID → const String
FILTER_USER_TAGS → const String
FIREBASE_EMAIL_PROJECT_ID → const String
FIREBASE_EMAIL_TOKEN → const String
FIREBASE_PHONE_PROJECT_ID → const String
FIREBASE_PHONE_TOKEN → const String
FORCE → const String
HEADER_API_VERSION → const String
HEADER_FRAMEWORK_VERSION → const String
HEADER_FRAMEWORK_VERSION_VALUE_PREFIX → const String
HEADER_TOKEN → const String
HEADER_TOKEN_EXPIRATION_DATE → const String
JANUS_PREFIX → const String
JOIN_JANUS_ROLE_PUBLISHER → const String
JOIN_JANUS_ROLE_SUBSCRIBER → const String
KEYS_SECRET → const String
KEYS_TOKEN → const String
LIMIT → const String
MEDIA_TYPE_AUDIO → const String
MEDIA_TYPE_VIDEO → const String
MEETINGS_ENDPOINT → const String
MESSAGE_ENDPOINT → const String
MIC_CORRECTION_COEFFICIENT → const int
NONCE → const String
OFFSET → const String
ORDER_PARAM_NAME → const String
PASSWORD → const String
PREFIX_CHAT_RESOURCE → const String
PROVIDER → const String
REACTIONS_ENDPOINT → const String
REGISTERED_USERS_ENDPOINT → const String
REQUEST_FORMAT → const String
RESET → const String
REST_API_VERSION → const String
SEARCH_CHAT_DATE_FORMAT → const String
SEARCH_ENDPOINT → const String
SIGNATURE → const String
SIGNIN_ENDPOINT → const String
STREAM_KIND_AUDIO → const String
STREAM_KIND_VIDEO → const String
SUBSCRIPTIONS_ENDPOINT → const String
SYSTEM_MESSAGE_ENDPOINT → const String
TIMESTAMP → const String
TOKEN_EXPIRATION_DATE_FORMAT → const String
UDID → const String
USER_EMAIL → const String
USER_FULL_NAME → const String
USER_GUEST → const String
USER_LOGIN → const String
USER_PASSWORD → const String
USER_SESSION_ENDPOINT → const String
USERS_ENDPOINT → const String
USERS_V2_ENDPOINT → const String
WHITEBOARDS_ENDPOINT → const String

Functions

createLocalMediaStream(String label) → Future<MediaStream>
createPeerConnection(Map<String, dynamic> configuration, [Map<String, dynamic> constraints = const {}]) → Future<RTCPeerConnection>
createSession([CubeUser? cubeUser]) → Future<CubeSession>
createSessionUsingFirebase(String projectId, String accessToken) → Future<CubeSession>
createSessionUsingFirebaseEmail(String projectId, String accessToken) → Future<CubeSession>
createSessionUsingFirebasePhone(String projectId, String accessToken) → Future<CubeSession>
createSessionUsingSocialProvider(String socialProvider, String accessToken, [String? accessTokenSecret]) → Future<CubeSession>
degradationPreferenceforString(String? degradation) → RTCDegradationPreference
deleteSession() → Future<void>
deleteSessionsExceptCurrent() → Future<void>
deleteUser(int userId) → Future<void>
deleteUserByExternalId(int externalId) → Future<void>
getAddressBook([String? udid]) → Future<List<CubeContact>?>
getAllUsers() → Future<PagedResult<CubeUser>?>
getAllUsersByIds(Set<int> ids, {RequestPaginator? paginator, RequestSorter? sorter}) → Future<PagedResult<CubeUser>?>
ids - the set of ids of users you want to get paginator - the instance of the helper class RequestPaginator that is representing the pagination parameters in the request. Note: the paginator.page should start from 0. sorter - the instance of the helper class RequestSorter that is representing the sorting parameters in the request. The example can be var sorter = RequestSorter.desc('created_at');
getAudioConfig({String? deviceId}) → dynamic
getQueryString(Map params, {String prefix = '&', bool inRecursion = false}) → String
Returns query parameters string, e.g. application_id=774&auth_key=aY7WwSRmu2-GbfA&nonce=1451135156 This function is more suitable for php API servers. Try the getUriQueryString if the server returns errors related to the syntax of the query string
getRegisteredUsersFromAddressBook(bool compact, [String? udid]) → Future<List<CubeUser>?>
getRtpReceiverCapabilities(String kind) → Future<RTCRtpCapabilities>
getRtpSenderCapabilities(String kind) → Future<RTCRtpCapabilities>
getSession() → Future<CubeSession>
getUriQueryString(Map<String, dynamic> params) → String
Returns query parameters string, e.g. application_id=774&auth_key=aY7WwSRmu2-GbfA&nonce=1451135156 The difference between this function from the getQueryString is that this one is based on the dart specifications
getUserByEmail(String email) → Future<CubeUser?>
getUserByExternalId(int externalId) → Future<CubeUser?>
getUserByExternalUserId(String externalUserId) → Future<CubeUser?>
getUserByFacebookId(String facebookId) → Future<CubeUser?>
getUserById(int id) → Future<CubeUser?>
getUserByIdentifier(String identifierName, dynamic identifierValue, {Map<String, dynamic>? additionalParameters}) → Future<CubeUser?>
getUserByLogin(String login) → Future<CubeUser?>
getUserByPhoneNumber(String phone) → Future<CubeUser?>
getUserByTwitterId(String twitterId) → Future<CubeUser?>
getUsers(Map<String, dynamic> parameters, {RequestPaginator? paginator, RequestSorter? sorter}) → Future<PagedResult<CubeUser>?>
The method returns the list according to the specified list of parameters. The list of available parameters is provided in the Server API documentation by link https://developers.connectycube.com/server/users?id=retrieve-users-v2 paginator - the instance of the helper class RequestPaginator that is representing the pagination parameters in the request. Note: the paginator.page should start from 0. sorter - the instance of the helper class RequestSorter that is representing the sorting parameters in the request. The example can be var sorter = RequestSorter.desc('created_at');
getUsersByFilter(RequestFilter filter) → Future<PagedResult<CubeUser>?>
Returns users by the custom filter. Possible filters provided by link https://developers.connectycube.com/server/users?id=parameters-1 For example for getting users by ids you can use the next code snippet:
getUsersByFullName(String fullName, {RequestPaginator? paginator, RequestSorter? sorter}) → Future<PagedResult<CubeUser>?>
fullName - the part of the 'fullName' with which the name begins. paginator - the instance of the helper class RequestPaginator that is representing the pagination parameters in the request. Pay attention: the paginator.itemsPerPage should be 5 for this request. Note: the paginator.page should start from 0. sorter - the instance of the helper class RequestSorter that is representing the sorting parameters in the request. The example can be var sorter = RequestSorter.desc('created_at');
getUsersByTags(Set<String> tags, {RequestPaginator? paginator, RequestSorter? sorter}) → Future<PagedResult<CubeUser>?>
getVideoConfig({String? deviceId}) → Map<String, dynamic>
iceConnectionStateForString(String? state) → RTCIceConnectionState
iceGatheringStateforString(String? state) → RTCIceGatheringState
init(String applicationId, String authorizationKey, String authorizationSecret, {Future<CubeSession> onSessionRestore()?}) → dynamic
intToStreamType(int? type) → StreamType
isEmpty(String? string) → bool
isEmptyList<T>(List<T>? list) → bool
listToRtpEncodings(List<Map<String, dynamic>> list) → List<RTCRtpEncoding>
log(String? message, [String? tag]) → dynamic
logTime(String message, [String? tag]) → dynamic
mediaRecorder() → MediaRecorder
peerConnectionStateForString(String? state) → RTCPeerConnectionState
rejectCall(String callSessionId, Set<int> callMembers, {String platform = 'flutter', Map<String, String>? userInfo}) → Future<void>
Sends the reject call signal via HTTP. It is useful in case when the used doesn't have an active chat connection (for example from a Notification) callSessionId - the id of the P2PSession session callMembers - the ids of all call members including the caller and excluding the current user platform - the platform name the app ran on userInfo - additional info about performed action
resetPassword(String email) → Future<void>
rtcDataChannelStateForString(String state) → RTCDataChannelState
setEndpoints(String apiEndpoint, String chatEndpoint) → dynamic
signalingStateForString(String? state) → RTCSignalingState
signIn(CubeUser user) → Future<CubeUser>
signInByEmail(String email, String password) → Future<CubeUser>
signInByLogin(String login, String password) → Future<CubeUser>
signInUsingFirebase(String projectId, String accessToken) → Future<CubeUser>
signInUsingFirebaseEmail(String projectId, String accessToken) → Future<CubeUser>
signInUsingFirebasePhone(String projectId, String accessToken) → Future<CubeUser>
signInUsingSocialProvider(String socialProvider, String accessToken, [String? accessTokenSecret]) → Future<CubeUser>
signOut() → Future<void>
signUp(CubeUser user) → Future<CubeUser>
streamTypeToInt(StreamType type) → int
updateUser(CubeUser user) → Future<CubeUser>
uploadAddressBook(List<CubeContact> contacts, {bool? force, String? udid}) → Future<AddressBookResult?>

Typedefs

Error = void Function(WsException ex)
LayerChanged = void Function(int userId, int layer)
LocalStreamCallback = void Function(MediaStream stream)
PublisherLeft = void Function(int? userId)
PublishersReceived = void Function(List<int?> publishers)
RemoteStreamCallback<T> = void Function(T session, int userId, MediaStream stream)
RemoteStreamCallbackConference<T> = void Function(T session, int userId, MediaStream stream, {String? trackId})
SessionClosedCallback<T> = void Function(T session)
SessionStateCallback<T> = void Function(T session)
StreamTrackCallback = dynamic Function()
SubscribedOnPublisher = void Function(int userId)
SubscriberAttached = void Function(int userId)
SubStreamChanged = void Function(int userId, StreamType streamType)
UserActionCallback<T> = void Function(T session, int userId, [Map<String, String>? userInfo])
UserConnectionStateCallback<T> = void Function(T session, int userId)