Suggestions

close search

StringeeConstants

public constants, enums, and helper models



Enums, options, result models, and helper models used by the Stringee Flutter Plugin.



Summary


TypeDescription
StringeeClientEventsEvents emitted by StringeeClient.
StringeeCallEventsEvents emitted by StringeeCall.
StringeeCall2EventsEvents emitted by StringeeCall2.
StringeeChatEventsEvents emitted by StringeeChat.
StringeeRoomEventsEvents emitted by StringeeVideoRoom.
StringeeChannelTypeChat channel type.
StringeeChatRequestTypeChat request type.
StringeeObjectEventTypeNative object event type used by plugin event dispatch.
StringeeCallTypeCall direction and endpoint type.
StringeeSignalingStateCall signaling state.
StringeeMediaStateCall media state.
VideoQualityVideo quality used for outgoing calls.
ScalingTypeVideo view scaling mode.
ObjectTypeChat object type.
ChangeTypeChat object change type.
UserRoleConversation user role.
MsgStateMessage delivery state.
MsgTypeMessage content type.
MsgNotifyTypeNotification message subtype.
StringeeVideoDimensionsVideo dimension for a video track.
AudioTypeAudio device type.
MakeCallParamsOptions used to make an outgoing call. Properties: from, to, isVideoCall, customData, videoQuality.
StringeeConversationOptionOptions used to create a new StringeeConversation.
StringeeObjectChangeChange event for conversation and message objects. Properties: type, objectType, objects.
StringeeServerAddressServer address used by native Stringee SDK. Properties: host, port.
StringeeVideoTrackOptionOptions used to create or subscribe to a StringeeVideoTrack. Properties: audio, video, screen, videoDimension.
StringeeVideoTrackInfoInformation for a remote or local video track. Properties: id, audioEnable, videoEnable, isScreenCapture, publisher.
AudioDeviceAudio device model. Properties: audioType, name, uuid.
ResultTyped result returned by selected plugin APIs. Properties: status, code, message, data.
resultMap result returned by most async APIs. Common keys: status, code, message, body.

Enums


StringeeClientEvents
Events emitted by StringeeClient.
didConnect, didDisconnect, didFailWithError, requestAccessToken, didReceiveCustomMessage, incomingCall, incomingCall2, didReceiveChatRequest, didReceiveTransferChatRequest, timeoutAnswerChat, timeoutInQueue, conversationEnded, userBeginTyping, userEndTyping
StringeeCallEvents
Events emitted by StringeeCall.
didChangeSignalingState, didChangeMediaState, didReceiveCallInfo, didHandleOnAnotherDevice, didReceiveLocalStream, didReceiveRemoteStream
StringeeCall2Events
Events emitted by StringeeCall2.
didChangeSignalingState, didChangeMediaState, didReceiveCallInfo, didHandleOnAnotherDevice, didReceiveLocalStream, didReceiveRemoteStream, didAddVideoTrack, didRemoveVideoTrack
StringeeChatEvents
Events emitted by StringeeChat.
didReceiveObjectChange
StringeeRoomEvents
Events emitted by StringeeVideoRoom.
didJoinRoom, didLeaveRoom, didAddVideoTrack, didRemoveVideoTrack, didReceiveRoomMessage, trackReadyToPlay
StringeeChannelType
Chat channel type.
normal, livechat, facebook, zalo
StringeeChatRequestType
Chat request type.
normal, transfer
StringeeObjectEventType
Native object event type used by plugin event dispatch.
client, call, call2, chat, room
StringeeCallType
Call direction and endpoint type.
appToAppOutgoing, appToAppIncoming, appToPhone, phoneToApp
StringeeSignalingState
Call signaling state.
calling, ringing, answered, busy, ended
StringeeMediaState
Call media state.
connected, disconnected
VideoQuality
Video quality used for outgoing calls.
normal, hd, fullHd
ScalingType
Video view scaling mode.
fit, fill
ObjectType
Chat object type.
conversation, message
ChangeType
Chat object change type.
insert, update, delete
UserRole
Conversation user role.
admin, member
MsgState
Message delivery state.
initialize, sending, sent, delivered, read
MsgType
Message content type.
text, photo, video, audio, file, link, createConversation, renameConversation, location, contact, sticker, notification
MsgNotifyType
Notification message subtype.
addParticipants, removeParticipants, changeGroupName
StringeeVideoDimensions
Video dimension for a video track.
dimesion_1080, dimesion_720, dimesion_480, dimesion_288
AudioType
Audio device type.
speakerPhone, wiredHeadset, earpiece, bluetooth, other, none

Helper classes


MakeCallParams(String from, String to, {bool? isVideoCall, Map? customData, VideoQuality? videoQuality})
Options used to make an outgoing call. Properties: from, to, isVideoCall, customData, videoQuality.
StringeeConversationOption({required bool isGroup, required bool isDistinct, String? name, String? oaId, String? customData, String? creatorId})
Options used to create a new StringeeConversation.
StringeeObjectChange(ChangeType type, ObjectType objectType, List objects)
Change event for conversation and message objects. Properties: type, objectType, objects.
StringeeServerAddress(String host, int port)
Server address used by native Stringee SDK. Properties: host, port.
StringeeVideoTrackOption({required bool audio, required bool video, required bool screen, StringeeVideoDimensions? videoDimension})
Options used to create or subscribe to a StringeeVideoTrack. Properties: audio, video, screen, videoDimension.
StringeeVideoTrackInfo(Map info)
Information for a remote or local video track. Properties: id, audioEnable, videoEnable, isScreenCapture, publisher.
AudioDevice({required AudioType? audioType, String? uuid, String? name})
Audio device model. Properties: audioType, name, uuid.
Result({required bool status, required int code, required String message, dynamic data})
Typed result returned by selected plugin APIs. Properties: status, code, message, data.
Map result
Map result returned by most async APIs. Common keys: status, code, message, body.