Skip to content

Commit 7f15ab7

Browse files
committed
Moved Example Read Me
1 parent 3b5ee6e commit 7f15ab7

File tree

3 files changed

+77
-24
lines changed

3 files changed

+77
-24
lines changed

.idea/workspace.xml

+39-15
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ View Twilio Documentation on Access Token Generation: https://www.twilio.com/doc
4545
```
4646

4747

48-
## TO DO
48+
## To Do
4949

5050
1. Android Support
5151
2. Propagate Events and Call Status Notifications to Flutter

example/README.md

+37-8
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,44 @@
22

33
Demonstrates how to use the flutter_twilio_voice plugin.
44

5-
## Getting Started
5+
## Configure Server to Generate Access Token
66

7-
This project is a starting point for a Flutter application.
7+
View Twilio Documentation on Access Token Generation: https://www.twilio.com/docs/iam/access-tokens
88

9-
A few resources to get you started if this is your first Flutter project:
109

11-
- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
12-
- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
10+
## Make a Call
11+
12+
```
13+
await FlutterTwilioVoice.makeCall(to: "$client_identifier_or_number_to_call",
14+
accessTokenUrl: "https://${YOUR-SERVER-URL}/accesstoken");
15+
```
16+
17+
18+
## Mute a Call
19+
20+
```
21+
await FlutterTwilioVoice.muteCall(isMuted: true);
22+
23+
```
24+
25+
## Toggle Speaker
26+
27+
```
28+
await FlutterTwilioVoice.toggleSpeaker(speakerIsOn: true);
29+
30+
```
31+
32+
## Hang Up
33+
34+
```
35+
await FlutterTwilioVoice.hangUp();
36+
37+
```
38+
39+
## Client Setup to Receive Calls
40+
41+
```
42+
await FlutterTwilioVoice.receiveCalls(clientIdentifier: 'alice');
43+
44+
```
1345

14-
For help getting started with Flutter, view our
15-
[online documentation](https://flutter.dev/docs), which offers tutorials,
16-
samples, guidance on mobile development, and a full API reference.

0 commit comments

Comments
 (0)