Suggestions

close search

Stringee Constants

All constants values available in stringee-flutter-plugin


Summary


Enum  

StringeeCallType

Type of Call.

StringeeSignalingState

Type of Signaling state.

StringeeMediaState

Type of Media state.

VideoQuality

Type of Video quality.

AudioDevice

Type of Audio device.

ScalingType

Type of Scaling.

ObjectType

Type of StringeeObject.

ChangeType

Status of StringeeObject.

UserRole

Role of participant.

MsgState

State of StringeeMessage.

MsgType

Type of StringeeMessage.

MsgNotifyType

Type of StringeeMessage noti.

StringeeChannelType

Type of channel of chat request.

StringeeChatRequestType

Type of chat request.

StringeeVideoDimensions

Dimension of video track.

Class  

MakeCallParams

Params for make call.

StringeeConversationOption

Params for create conversation's options.

StringeeObjectChange

Represents a StringeeObject and object's status.

StringeeServerAddress

Represents a Stringee server address.

StringeeVideoTrackOptions

Represents StringeeVideoTrack's options.

Parameters  

result

Result params received from all methods.

Enum


StringeeCallType

Type of Call.

appToAppOutgoing

Call is outgoing call and is app to app call.

appToAppIncoming

Call is incoming call and is app to app call.

appToPhone

Call is out going call and is app to phone call.

phoneToApp

Call is out going call and is phone to app call.

StringeeSignalingState

Type of Signaling state.

calling

Used to specify the call invite is sent to Stringee Server.

ringing

Used to specify the callee is ringing.

answered

Used to specify the callee answers the call.

busy

Used to specify the callee rejects the call.

ended

Used to specify the call is terminated.

StringeeMediaState

Type of Media state.

connected

Used to specify the call media is connected.

disconnected

Used to specify the call media is disconnected.

VideoQuality

Type of Video quality.

normal

The local video's quality is normal.

hd

The local video's quality is hd.

fullHd

The local video's quality is full hd.

AudioDevice

Type of Audio device.

speakerPhone

Speaker phone of device

wiredHeadset

Wired headset of device.

earpiece

Internal speaker of device.

bluetooth

Bluetooth headset of device.

none

None speaker is connected to the device.

ScalingType

Type of Scaling.

fit

Stream fit in widget.

fill

Stream fill in widget.

ObjectType

Type of objects in StringeeObjectChange.

conversation

objects is StringeeConversation.

message

objects is StringeeMessage.

ChangeType

Status of StringeeObjectChange.

insert

New objects is created or inserted.

update

objects is updated.

delete

objects is deleted.

UserRole

Role of participant.

admin

StringeeUser is admin of conversation.

member

StringeeUser is member of conversation.

MsgState

State of StringeeMessage.

initialize

message was created to send to Stringee server.

sending

message is being sent to Stringee server.

sent

message is sended to Stringee server.

delivered

message is sended to orther participants.

read

message is readed by other participants.

MsgType

Type of StringeeMessage.

text

Text message.

photo

Photo message.

video

Video message.

audio

Audio message.

file

File message.

link

Link message.

createConversation

Message noti create conversation.

renameConversation

Message noti create conversation.

location

Location message.

contact

Contact message.

sticker

Sticker message.

notification

Notification message.

MsgNotifyType

Type of Notification message.

addParticipants

Notification message noti participants is added.

removeParticipants

Notification message noti participants is removed.

changeGroupName

Notification message noti conversation's name is changed.

StringeeChannelType

Type of channel chat request.

livechat

Chat request is from livechat.

facebook

Chat request is from facebook.

zalo

Chat request is from zalo.

StringeeChatRequestType

Type of chat request.

normal

Normal chat request.

transfer

Chat request is transferred from another user.

StringeeVideoDimensions

Dimension of video track.

dimesion_1080

Dimension of video track is 1080.

dimesion_720

Dimension of video track is 720.

dimesion_480

Dimension of video track is 488.

dimesion_288

Dimension of video track is 288.

Class


MakeCallParams

Class represents options for make a call.

Constructors
MakeCallParams(String from, String to, {bool isVideoCall, Map<dynamic, dynamic> customData, VideoQuality videoQuality})
Properties

from → String

It's the Caller's id.

to → String

It's the Callee's id.

isVideoCall → bool

Whether the call is a video call:
- true - is video call.
- false - is not video call.

customData → Map<dynamic, dynamic>

It's custom data received from other user.

videoQuality → VideoQuality

It's quality of local stream

StringeeConversationOption

Class represents options for create a new StringeeConversation.

Constructors
StringeeConversationOption({bool isGroup, String name, bool isDistinct})
Properties

isGroup → bool

Whether the conversation is a group chat:
- true - is group chat.
- false - is chat 1-1.

name → String

It's the conversation's name.

isDistinct → bool

Whether the conversation is distinct:
- true - is distinct.
- false - is not distinct.

StringeeObjectChange

Class represents the change of StringeeConversation and StringeeMessage.

Properties

type → ChangeType

It's type of change

objectType → ObjectType

It's type of updated object.

objects → List<dynamic>

List of of updated objects.
- objectType = conversation -> StringeeConversation.
- objectType = message -> StringeeMessage.

StringeeServerAddress

Class represents the Stringee server address.

Constructors
StringeeServerAddress(String host, int port)
Properties

host → String

It's host of server.

port → int

It's port of server

StringeeVideoTrackOptions

Class represents options of StringeeVideoTrack.

Constructors
StringeeVideoTrackOptions({required bool audio, required bool video, required bool screen, StringeeVideoDimensions videoDimension})
Properties

audio → bool

Whether the video track has audio:
- true - has audio.
- false - no audio.

video → bool

Whether the video track has video:
- true - has video.
- false - no video.

screen → bool

Whether the video track is screen capture:
- true - is screen capture.
- false - is not screen capture.

videoDimension → StringeeVideoDimensions

Dimension of video track.

Parameters


result → Map<dynamic, dynamic>

Result params received from all methods.

status → bool

Status of result:
- true - method execute success
- false - method execute fail

code → int

Code of Stringee error

message → String

Message of Stringee error

body → Map<dynamic, dynamic>/Object/List<Object>

If method execute success and return a value, value will put in body.

Common error:

status

code

message

body

true

0

success

null/ Map<dynamic, dynamic>/ Object/List<Object>

false

-1

StringeeClient is not initialized or disconnected

null

false

-2

value is invalid

null

false

-3

Object is not found

null

false

-4

This function work only for Android

null