Skip to content

Commit 68180a7

Browse files
committed
Update README for upcoming release
1 parent 27db609 commit 68180a7

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -122,12 +122,12 @@ Initiate a call by providing the callee’s user id into the `SendBirdCall.dial(
122122
```javascript
123123
/*
124124
interface DirectCallOption {
125-
remoteVideoView: HTMLElement
125+
remoteMediaView: HTMLElement
126126
audioEnabled: boolean
127127
}
128128
*/
129129
const callOption = {
130-
remoteVideoView: document.getElementById('AUDIO_TAG'),
130+
remoteMediaView: document.getElementById('remote_audio_tag'),
131131
audioEnabled: true
132132
};
133133

@@ -155,7 +155,7 @@ call.onRemoteAudioEnabled = (call) => {
155155
};
156156
```
157157

158-
`remoteVideoView` option is necessary to play media stream. You have to append `<audio>` HTML tag to your page, and pass it to `callOption` to preform a audio call properly.
158+
`remoteMediaView` option is necessary to play media stream. You should append `<audio>` HTML tag in your page, and pass it to `callOption` to preform a audio call properly.
159159

160160
In `HTML`,
161161
```html
@@ -164,7 +164,7 @@ In `HTML`,
164164
In `JavaScript`,
165165
```javascript
166166
const callOption = {
167-
remoteVideoView: document.getElementById('remote_audio_tag'),
167+
remoteMediaView: document.getElementById('remote_audio_tag'),
168168
audioEnabled: true
169169
};
170170
```
@@ -197,12 +197,12 @@ SendBirdCall.addListener(UNIQUE_HANDLER_ID, {
197197

198198
/*
199199
interface DirectCallOption {
200-
remoteVideoView: HTMLElement
200+
remoteMediaView: HTMLElement
201201
audioEnabled: boolean
202202
}
203203
*/
204204
const callOption = {
205-
remoteVideoView: document.getElementById('AUDIO_TAG'),
205+
remoteMediaView: document.getElementById('remote_audio_tag'),
206206
audioEnabled: true
207207
};
208208

@@ -248,6 +248,14 @@ call.onEnded = (call) => {
248248
};
249249
```
250250

251+
## Deauthenticate a user
252+
You can deauthenticate the user with `SendBirdCall.deauthenticate()` method. it will discard all current directCalls, session keys, and user information; except for [SendBirdCallListener](#SendBirdCallListener). `SendBirdCall.deauthenticate()` can be used as 'logout' method for current user.
253+
254+
```javascript
255+
// Deauthenticate
256+
SendBirdCall.deauthenticate();
257+
```
258+
251259
## Retrieve a call information
252260
The local or remote user’s information is available via the `directCall.localUser` and `directCall.remoteUser` properties.
253261

0 commit comments

Comments
 (0)