Skip to content

Commit

Permalink
revert doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
myandrienko committed Nov 14, 2024
1 parent 579950a commit 740f195
Show file tree
Hide file tree
Showing 7 changed files with 3 additions and 426 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@ Here is an excerpt of the call state properties:
| `blockedUserIds$` | `blockedUserIds` | The list of blocked user IDs. |
| `callingState$` | `callingState` | Provides information about the call state. For example, `RINGING`, `JOINED` or `RECONNECTING`. |
| `callStatsReport$` | `callStatsReport` | When stats gathering is enabled, this observable will emit a new value at a regular (configurable) interval. |
| `captioning$` | `captioning` | Provides information whether closed-captions are running for this call or not. |
| `closedCaptions$` | `closedCaptions` | The closed captions state of the call. |
| `createdAt$` | `createdAt` | The time the call was created. |
| `createdBy$` | `createdBy` | The user who created the call. |
| `custom$` | `custom` | Custom data attached to the call. |
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ Here is an excerpt of the available call state hooks:
| `useCall` | The `Call` instance that is registered with `StreamCall`. You need the `Call` instance to initiate API calls. |
| `useCallBlockedUserIds` | The list of blocked user IDs. |
| `useCallCallingState` | Provides information about the call state. For example, `RINGING`, `JOINED` or `RECONNECTING`. |
| `useCallClosedCaptions` | The closed captions of the call. |
| `useCallCreatedAt` | The time the call was created. |
| `useCallCreatedBy` | The user that created the call. |
| `useCallCustomData` | The custom data attached to the call. |
Expand All @@ -85,16 +84,15 @@ Here is an excerpt of the available call state hooks:
| `useDominantSpeaker` | The participant that is the current dominant speaker of the call. |
| `useHasOngoingScreenShare` | It will return `true` if at least one participant is sharing their screen. |
| `useHasPermissions` | Returns `true` if the local participant has all the given permissions. |
| `useIncomingVideoSettings` | The state of manual overrides to incoming video quality. |
| `useIsCallCaptioningInProgress` | It's `true` if the call is being close-captioned. |
| `useIsCallHLSBroadcastingInProgress` | It's `true` if the call is being broadcasted in HLS mode. |
| `useIsCallLive` | It's `true` if the call is currently live. |
| `useIsCallRecordingInProgress` | It's `true` if the call is being recorded. |
| `useIsCallRecordingInProgress` | It's' `true` if the call is being recorded. |
| `useIsCallTranscribingInProgress` | It's `true` if the call is being transcribed. |
| `useMicrophoneState` | The microphone state of the local participant. |
| `useOwnCapabilities` | The capabilities of the local participant. |
| `useScreenShareState` | The screen share state of the local participant. |
| `useSpeakerState` | The speaker state of the local participant. |
| `useIncomingVideoSettings` | The state of manual overrides to incoming video quality. |

In your IDE of choice, you can see the full list if you de-structure the `useCallStateHooks` object:

Expand Down

This file was deleted.

Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ Here is an excerpt of the available call state hooks:
| `useCall` | The `Call` instance that is registered with `StreamCall`. You need the `Call` instance to initiate API calls. |
| `useCallBlockedUserIds` | The list of blocked user IDs. |
| `useCallCallingState` | Provides information about the call state. For example, `RINGING`, `JOINED` or `RECONNECTING`. |
| `useCallClosedCaptions` | The closed captions of the call. |
| `useCallCreatedAt` | The time the call was created. |
| `useCallCreatedBy` | The user that created the call. |
| `useCallCustomData` | The custom data attached to the call. |
Expand All @@ -86,11 +85,9 @@ Here is an excerpt of the available call state hooks:
| `useDominantSpeaker` | The participant that is the current dominant speaker of the call. |
| `useHasOngoingScreenShare` | It will return `true` if at least one participant is sharing their screen. |
| `useHasPermissions` | Returns `true` if the local participant has all the given permissions. |
| `useIncomingVideoSettings` | The state of manual overrides to incoming video quality. |
| `useIsCallCaptioningInProgress` | It's `true` if the call is being close-captioned. |
| `useIsCallHLSBroadcastingInProgress` | It's `true` if the call is being broadcasted in HLS mode. |
| `useIsCallLive` | It's `true` if the call is currently live. |
| `useIsCallRecordingInProgress` | It's `true` if the call is being recorded. |
| `useIsCallRecordingInProgress` | It's' `true` if the call is being recorded. |
| `useIsCallTranscribingInProgress` | It's `true` if the call is being transcribed. |
| `useMicrophoneState` | The microphone state of the local participant. |
| `useOwnCapabilities` | The capabilities of the local participant. |
Expand Down
Loading

0 comments on commit 740f195

Please sign in to comment.