Skip to content

Commit

Permalink
docs(web): update api reference
Browse files Browse the repository at this point in the history
  • Loading branch information
s-dvd authored Nov 16, 2023
1 parent dbe8237 commit 41eb3d0
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 25 deletions.
3 changes: 2 additions & 1 deletion .github/styles/Vocab/HMSVocab/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -163,4 +163,5 @@ keyof
unobserve
qp
rehype
num
num
url
6 changes: 6 additions & 0 deletions docs/api-reference/javascript/v2/interfaces/HLSVariant.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ nav: '4.4'

---

### state

`Optional` **state**: `HMSStreamingState`

---

### url

**url**: `string`
6 changes: 3 additions & 3 deletions docs/api-reference/javascript/v2/interfaces/HMSActions.md
Original file line number Diff line number Diff line change
Expand Up @@ -665,7 +665,7 @@ Send a plain text message to all the other participants in the room.
| Name | Type | Description |
| :-------- | :------- | :---------------------------------------------------------------- |
| `message` | `string` | string message to broadcast |
| `type?` | `string` | type of message. For example: image, video etc. - optional defaults to chat |
| `type?` | `string` | type of message, for example image, video etc. - optional defaults to chat |

#### Returns

Expand All @@ -683,7 +683,7 @@ Send a plain text message to all the other participants in the room.
| :-------- | :------- | :---------------------------------------------------------------- |
| `message` | `string` | |
| `peerID` | `string` | id of the peer to which message has to be sent |
| `type?` | `string` | type of message. For example: image, video etc. - optional defaults to chat |
| `type?` | `string` | type of message, for example image, video etc. - optional defaults to chat |

#### Returns

Expand All @@ -701,7 +701,7 @@ Send a plain text message to all the other participants in the room.
| :-------- | :--------- | :---------------------------------------------------------------- |
| `message` | `string` | string message to send |
| `roles` | `string`[] | roles to which to send the message |
| `type?` | `string` | type of message. For example: image, video etc. - optional defaults to chat |
| `type?` | `string` | type of message, for example: image, video etc. - optional defaults to chat |

#### Returns

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ When a peer joins the room for the first time or when a device change happens,
after selecting the mic for audio input, we try to find the matching output device
for selecting the speaker(on browsers where speaker selection is possible).

For example if the headset mic is selected, the headset speaker will also be selected,
For example, if the headset mic is selected, the headset speaker will also be selected,
if the laptop default mix is selected, the corresponding laptop speaker will be selected.

This is useful because if a non-matching pair is selected, it might lead to an echo in the room.
Expand All @@ -48,7 +48,7 @@ and always go for the default device selection as given by the browser.
There are two ways to use this, you can pass in 'all' which will disable the above behaviour for all devices.
Or you can pass in an array of labels which will be string matched to disable the behavior for specific devices.

For example ["Yeti Stereo Microphone"], as Yeti shows up often in audio output even when no device is plugged into its headphone jack.
For example, ["Yeti Stereo Microphone"], as Yeti shows up often in audio output even when no device is plugged into its headphone jack.

---

Expand Down
6 changes: 6 additions & 0 deletions docs/api-reference/javascript/v2/interfaces/HMSRTMP.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,9 @@ nav: '4.47'
### startedAt

`Optional` **startedAt**: `Date`

---

### state

`Optional` **state**: `HMSStreamingState`
20 changes: 2 additions & 18 deletions docs/api-reference/javascript/v2/interfaces/HMSRecording.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,7 @@ nav: '4.49'

### browser

**browser**: `Object`

#### Type declaration

| Name | Type |
| :----------- | :------------- |
| `error?` | `HMSException` |
| `running` | `boolean` |
| `startedAt?` | `Date` |
**browser**: `HMSBrowserRecording`

---

Expand All @@ -27,12 +19,4 @@ nav: '4.49'

### server

**server**: `Object`

#### Type declaration

| Name | Type |
| :----------- | :------------- |
| `error?` | `HMSException` |
| `running` | `boolean` |
| `startedAt?` | `Date` |
**server**: `HMSSFURecording`
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ HMSHLSPlayerView()

You instantiate `HMSHLSPlayerView()` instance passing the URL as parameter to render the HLS stream from the URL.
```swift
HMSHLSPlayerView(url: /* pass stream url here */)
HMSHLSPlayerView(url: /* pass stream URL here */)
```

## How to overlay buttons/UI on top of the HLS player
Expand Down

1 comment on commit 41eb3d0

@vercel
Copy link

@vercel vercel bot commented on 41eb3d0 Nov 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.