|
1 |
| -# Quickblox Flutter samples SDK |
| 1 | +# QuickBlox Flutter SDK |
2 | 2 |
|
3 |
| -## Quick Start |
4 |
| -This guide demonstrates how to run Quickblox Flutter SDK examples. |
| 3 | +# This project contains: |
5 | 4 |
|
6 |
| -Documentation: https://docs.quickblox.com/docs/flutter-quick-start |
7 |
| - |
8 |
| -### Create a new app in the Admin Panel |
9 |
| -Quickblox application includes everything that brings messaging right into your application - chat, video calling, users, push notifications, etc. To create a QuickBlox application, follow the steps below: |
10 |
| - |
11 |
| -1. Register a new account. Type in your email and password to sign in. You can also sign in with your Google or Github accounts. |
12 |
| -2. Create the app clicking **New app** button. |
13 |
| -3. Configure the app. Type in the information about your organization into corresponding fields and click **Add** button. |
14 |
| -4. Go to the screen with credentials. Locate **Credentials** groupbox and copy your **Application ID**, **Authorization Key**, and **Authorization Secret**. These data are needed to run your application on QuickBlox server. |
15 |
| - |
16 |
| -### Run the samples |
17 |
| - |
18 |
| -1. Change the dir to `lib` |
19 |
| -2. Open and modify the `credentials.dart` file with your account data |
20 |
| - |
21 |
| -```dart |
22 |
| -const String APP_ID = ""; // application id from your account |
23 |
| -const String AUTH_KEY = ""; // authentication key from your account |
24 |
| -const String AUTH_SECRET = ""; // authentication secret key from your account |
25 |
| -const String ACCOUNT_KEY = ""; // account key from your account |
26 |
| -const String API_ENDPOINT = ""; // optional |
27 |
| -const String CHAT_ENDPOINT = ""; // optional |
28 |
| -
|
29 |
| -const String USER_LOGIN = ""; // user login |
30 |
| -const String USER_PASSWORD = ""; // user password |
31 |
| -const int LOGGED_USER_ID = 000000000; // user id |
32 |
| -const int OPPONENT_ID = 000000000; // uer id of opponent user |
33 |
| -
|
34 |
| -const List<int> OPPONENTS_IDS = [OPPONENT_ID]; |
35 |
| -const String DIALOG_ID = ""; // dialog id |
36 |
| -const String CUSTOM_OBJECT_ClASS_NAME = ""; // name of custom object class |
37 |
| -``` |
38 |
| -3. Run `flutter run` in lib directory |
39 |
| -4. You can see the simple UI with button where you can test base functional of Quickblox SDK. |
40 |
| - |
41 |
| -### Start the video call |
42 |
| - |
43 |
| -1. Check permissions application |
44 |
| - - open the application settings |
45 |
| - - swipe the all permissions to enabled `Camera, Microphone, Storage` |
46 |
| -2. Init SDK and start the call |
47 |
| - - open the sample application |
48 |
| - - Press `Settings` button |
49 |
| - - Press `init credentials` button and wait when will show `The credentials were set` message |
50 |
| - - Return to the main screen |
51 |
| - - Press `Auth` button |
52 |
| - - Press `Login` button and waiting when will show `Login success` message |
53 |
| - - Return to the main screen |
54 |
| - - Press `Chat` button |
55 |
| - - Press `Connect` button and wait when will show `The chat was connected` message |
56 |
| - - Return to the main screen |
57 |
| - - Press `WebRTC` button |
58 |
| - - Press `init` button and wait when will show `The WebRTC was initiated` message |
59 |
| - - Press `subscribe RTC events` |
60 |
| - - Press `subscribe RTC events` and wait when messages about subscribing will stop show |
61 |
| - - Press `call Video` button |
62 |
| - - The opponent (`user with opponent id` from credentials file) will show incoming call dialog |
63 |
| - - Press `accept` button in opponent application and you can see the video call between two users |
64 |
| - |
65 |
| - 3. Finish the video call |
66 |
| - - Press `hangUp` button |
67 |
| - - Press `release Video Views` button |
68 |
| - - Press `release` button |
69 |
| - - Return to the main screen |
70 |
| - |
71 |
| -## LICENSE |
72 |
| -For license information, please visit: https://quickblox.com/terms-of-use/ |
| 5 | +* New Quickblox Samples: |
| 6 | + * [Sample Chat Flutter](https://github.com/QuickBlox/quickblox-flutter-samples/tree/master/chat_sample) |
| 7 | + * [Simple-sample](https://github.com/QuickBlox/quickblox-flutter-samples/tree/master/simple_sample) |
0 commit comments