Skip to content

Commit

Permalink
Update PreJoin description (#682)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Ocupe
Ocupe authored Nov 1, 2023
1 parent c5f0b75 commit 946d2b0
Show file tree
Hide file tree
Showing 13 changed files with 76 additions and 20 deletions.
7 changes: 7 additions & 0 deletions .changeset/many-swans-rest.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@livekit/components-core": patch
"@livekit/components-react": patch
"@livekit/components-js-docs": patch
---

Update PreJoin description and update docs.
8 changes: 4 additions & 4 deletions docs/docs/generated-docs/core/createurlregexp.md
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
{
"title": "createUrlRegExp variable",
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/urlRegex.ts"
"title": "createUrlRegExp",
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/url-regex.ts"
}
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

# createUrlRegExp variable
# createUrlRegExp

**Signature:**

```typescript
createUrlRegExp: (options: RegExOptions) => RegExp;
export declare function createUrlRegExp(options: RegExOptions): RegExp;
```
2 changes: 1 addition & 1 deletion docs/docs/generated-docs/core/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
| [createIsSpeakingObserver(participant)](./core/createisspeakingobserver.md) | |
| [createMediaDeviceObserver(kind, requestPermissions)](./core/createmediadeviceobserver.md) | |
| [createTrackObserver(participant, options)](./core/createtrackobserver.md) | |
| [createUrlRegExp](./core/createurlregexp.md) | |
| [createUrlRegExp(options)](./core/createurlregexp.md) | |
| [cssPrefix](./core/cssprefix.md) | |
| [DataSendOptions](./core/datasendoptions.md) | |
| [DataTopic](./core/datatopic.md) | |
Expand Down
18 changes: 9 additions & 9 deletions docs/docs/generated-docs/react/audiotrackprops.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ export interface AudioTrackProps<T extends HTMLMediaElement = HTMLMediaElement>
## Properties
| Property | Type | Description |
| -------------------------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------- |
| [name?](./react/audiotrackprops.name.md) | string | _(Optional)_ |
| [onSubscriptionStatusChanged?](./react/audiotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void | _(Optional)_ |
| [participant?](./react/audiotrackprops.participant.md) | Participant | _(Optional)_ |
| [publication?](./react/audiotrackprops.publication.md) | TrackPublication | _(Optional)_ |
| [source?](./react/audiotrackprops.source.md) | Track.Source | _(Optional)_ |
| [trackRef?](./react/audiotrackprops.trackref.md) | [TrackReference](./core/trackreference.md) | _(Optional)_ The track reference of the track from which the audio is to be rendered. |
| [volume?](./react/audiotrackprops.volume.md) | number | _(Optional)_ by the default the range is between 0 and 1 |
| Property | Type | Description |
| -------------------------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| [name?](./react/audiotrackprops.name.md) | string | _(Optional)_ |
| [onSubscriptionStatusChanged?](./react/audiotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void | _(Optional)_ |
| [participant?](./react/audiotrackprops.participant.md) | Participant | _(Optional)_ |
| [publication?](./react/audiotrackprops.publication.md) | TrackPublication | _(Optional)_ |
| [source?](./react/audiotrackprops.source.md) | Track.Source | _(Optional)_ |
| [trackRef?](./react/audiotrackprops.trackref.md) | [TrackReference](./core/trackreference.md) | _(Optional)_ The track reference of the track from which the audio is to be rendered. |
| [volume?](./react/audiotrackprops.volume.md) | number | _(Optional)_ Sets the volume of the audio track. By default, the range is between <code>0.0</code> and <code>1.0</code>. |
2 changes: 1 addition & 1 deletion docs/docs/generated-docs/react/audiotrackprops.volume.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# AudioTrackProps.volume property

by the default the range is between 0 and 1
Sets the volume of the audio track. By default, the range is between `0.0` and `1.0`<!-- -->.

**Signature:**

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/generated-docs/react/component/audiotrack.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ _(Optional)_ The track reference of the track from which the audio is to be rend
{% /parameter %}

{% parameter name="volume" type="number" optional=true %}
_(Optional)_ by the default the range is between 0 and 1
_(Optional)_ Sets the volume of the audio track. By default, the range is between `0.0` and `1.0`<!-- -->.

{% /parameter %}

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/generated-docs/react/component/prejoin.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import { PreJoin } from "@livekit/components-react";

## Remarks

This component is independent from the `LiveKitRoom` component and don't has to be nested inside it. Because it only access the local media tracks this component is self contained and works without connection to the LiveKit server.
This component is independent of the `LiveKitRoom` component and should not be nested within it. Because it only access the local media tracks this component is self contained and works without connection to the LiveKit server.

## Usage

Expand Down
7 changes: 7 additions & 0 deletions docs/docs/generated-docs/react/component/roomaudiorenderer.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,10 @@ import { RoomAudioRenderer } from "@livekit/components-react";
```

{% partial file="p_usage.md" variables={exampleCount: 1} /%}

## Properties

{% parameter name="volume" type="number" optional=true %}
_(Optional)_ Sets the volume for all audio tracks rendered by this component. By default, the range is between `0.0` and `1.0`<!-- -->.

{% /parameter %}
3 changes: 2 additions & 1 deletion docs/docs/generated-docs/react/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
| [ParticipantLoop({ participants, ...props })](./react/component/participantloop.md) | The <code>ParticipantLoop</code> component loops over an array of participants to create a context for every participant. This component takes exactly one child component as a template. By providing your own template as a child you have full control over the look and feel of your participant representations. |
| [ParticipantName({ participant, ...props })](./react/component/participantname.md) | The <code>ParticipantName</code> component displays the name of the participant as a string within an HTML span element. If no participant name is undefined the participant identity string is displayed. |
| [ParticipantTile({ trackRef, participant, children, source, onParticipantClick, publication, disableSpeakingIndicator, ...htmlProps })](./react/component/participanttile.md) | The <code>ParticipantTile</code> component is the base utility wrapper for displaying a visual representation of a participant. This component can be used as a child of the <code>TrackLoop</code> component or by passing a track reference as property. |
| [RoomAudioRenderer()](./react/component/roomaudiorenderer.md) | The <code>RoomAudioRenderer</code> component is a drop-in solution for adding audio to your LiveKit app. It takes care of handling remote participants’ audio tracks and makes sure that microphones and screen share are audible. |
| [RoomAudioRenderer({ volume, muted })](./react/component/roomaudiorenderer.md) | The <code>RoomAudioRenderer</code> component is a drop-in solution for adding audio to your LiveKit app. It takes care of handling remote participants’ audio tracks and makes sure that microphones and screen share are audible. |
| [RoomName({ childrenPosition, children, ...htmlAttributes })](./react/component/roomname.md) | The <code>RoomName</code> component renders the name of the connected LiveKit room inside a span tag. |
| [StartAudio({ label, ...props })](./react/component/startaudio.md) | The <code>StartAudio</code> component is only visible when the browser blocks audio playback. This is due to some browser implemented autoplay policies. To start audio playback, the user must perform a user-initiated event such as clicking this button. As soon as audio playback starts, the button hides itself again. |
| [Toast(props)](./react/component/toast.md) | The <code>Toast</code> component is a rudimentary way to display a message to the user. This message should be short lived and not require user interaction. For example, displaying the current connection state like <code>ConnectionStateToast</code> does. |
Expand Down Expand Up @@ -150,6 +150,7 @@
| [ParticipantNameProps](./react/participantnameprops.md) | |
| [ParticipantTileProps](./react/participanttileprops.md) | |
| [PreJoinProps](./react/prejoinprops.md) | |
| [RoomAudioRendererProps](./react/roomaudiorendererprops.md) | |
| [RoomContext](./react/roomcontext.md) | |
| [RoomNameProps](./react/roomnameprops.md) | |
| [TrackContext](./react/trackcontext.md) | |
Expand Down
24 changes: 24 additions & 0 deletions docs/docs/generated-docs/react/roomaudiorendererprops.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
{
"title": "RoomAudioRendererProps interface",
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/RoomAudioRenderer.tsx"
}
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

# RoomAudioRendererProps interface

**Signature:**

```typescript
export interface RoomAudioRendererProps
```

{% partial file="p_usage.md" variables={exampleCount: 0} /%}

## Properties

| Property | Type | Description |
| --------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| [volume?](./react/roomaudiorendererprops.volume.md) | number | _(Optional)_ Sets the volume for all audio tracks rendered by this component. By default, the range is between <code>0.0</code> and <code>1.0</code>. |
17 changes: 17 additions & 0 deletions docs/docs/generated-docs/react/roomaudiorendererprops.volume.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
{ "title": "RoomAudioRendererProps.volume property" }
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

# RoomAudioRendererProps.volume property

Sets the volume for all audio tracks rendered by this component. By default, the range is between `0.0` and `1.0`<!-- -->.

**Signature:**

```typescript
volume?: number;
```

{% partial file="p_usage.md" variables={exampleCount: 0} /%}
2 changes: 1 addition & 1 deletion packages/core/etc/components-core.api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ export function createTrackObserver(participant: Participant, options: TrackIden
// Warning: (ae-forgotten-export) The symbol "RegExOptions" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const createUrlRegExp: (options: RegExOptions) => RegExp;
export function createUrlRegExp(options: RegExOptions): RegExp;

// @public (undocumented)
export const cssPrefix = "lk";
Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/prefabs/PreJoin.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ export function usePreviewDevice<T extends LocalVideoTrack | LocalAudioTrack>(
* On submit the user decisions are returned, which can then be passed on to the `LiveKitRoom` so that the user enters the room with the correct media devices.
*
* @remarks
* This component is independent from the `LiveKitRoom` component and don't has to be nested inside it.
* This component is independent of the `LiveKitRoom` component and should not be nested within it.
* Because it only access the local media tracks this component is self contained and works without connection to the LiveKit server.
*
* @example
Expand Down

0 comments on commit 946d2b0

Please sign in to comment.