diff --git a/website/docs/browser-sdk/_common/_method_off.mdx b/website/docs/browser-sdk/_common/_method_off.mdx index 582ed3542..697f4b829 100644 --- a/website/docs/browser-sdk/_common/_method_off.mdx +++ b/website/docs/browser-sdk/_common/_method_off.mdx @@ -1,6 +1,6 @@ import { GetListOfAvailableEventsDescription } from "./utils"; -▸ **off**(`event`, `fn?`) +- **off**(`event`, `fn?`) Remove an event handler. diff --git a/website/docs/browser-sdk/_common/_method_on.mdx b/website/docs/browser-sdk/_common/_method_on.mdx index d328e7ff8..5976c6a74 100644 --- a/website/docs/browser-sdk/_common/_method_on.mdx +++ b/website/docs/browser-sdk/_common/_method_on.mdx @@ -1,6 +1,6 @@ import { GetListOfAvailableEventsDescription } from "./utils"; -▸ **on**(`event`, `fn`) +- **on**(`event`, `fn`) Attaches an event handler to the specified event. diff --git a/website/docs/browser-sdk/_common/_method_once.mdx b/website/docs/browser-sdk/_common/_method_once.mdx index 0a90df806..32f68cc38 100644 --- a/website/docs/browser-sdk/_common/_method_once.mdx +++ b/website/docs/browser-sdk/_common/_method_once.mdx @@ -1,6 +1,6 @@ import { GetListOfAvailableEventsDescription } from "./utils"; -▸ **once**(`event`, `fn`) +- **once**(`event`, `fn`) Attaches an event handler to the specified event. The handler will fire only once. diff --git a/website/docs/browser-sdk/_common/_method_removealllisteners.mdx b/website/docs/browser-sdk/_common/_method_removealllisteners.mdx index cd76ac292..55581c7f4 100644 --- a/website/docs/browser-sdk/_common/_method_removealllisteners.mdx +++ b/website/docs/browser-sdk/_common/_method_removealllisteners.mdx @@ -1,6 +1,6 @@ import { GetListOfAvailableEventsDescription } from "./utils"; -▸ **removeAllListeners**(`event?`) +- **removeAllListeners**(`event?`) Detaches all event listeners for the specified event. diff --git a/website/docs/browser-sdk/tech-ref/SignalWire Client/client/address.mdx b/website/docs/browser-sdk/tech-ref/SignalWire Client/client/address.mdx index ce820ece6..2b9afc1c2 100644 --- a/website/docs/browser-sdk/tech-ref/SignalWire Client/client/address.mdx +++ b/website/docs/browser-sdk/tech-ref/SignalWire Client/client/address.mdx @@ -42,7 +42,7 @@ Here is an example of an `Address` object: ### getAddresses -▸ **getAddresses**(`options`): `Promise<{ data: Address[], hasNext, hasPrev }>` +- **getAddresses**(`options`): `Promise<{ data: Address[], hasNext, hasPrev }>` Returns a list of Addresses. @@ -99,7 +99,7 @@ await client.address.getAddresses(); ### getAddress -▸ **getAddress**(`options`): `Promise
` +- **getAddress**(`options`): `Promise
` Get the details of a particular address ID. diff --git a/website/docs/browser-sdk/tech-ref/SignalWire Client/client/chat.mdx b/website/docs/browser-sdk/tech-ref/SignalWire Client/client/chat.mdx index f4894a76b..79bde2f46 100644 --- a/website/docs/browser-sdk/tech-ref/SignalWire Client/client/chat.mdx +++ b/website/docs/browser-sdk/tech-ref/SignalWire Client/client/chat.mdx @@ -36,7 +36,7 @@ Here is an example of a `ConversationChatMessage` object: ### getMessages -▸ **getMessages**(`options`): `Promise<{ data: ConversationChatMessage[], hasNext, hasPrev, nextPage(), prevPage() }>` +- **getMessages**(`options`): `Promise<{ data: ConversationChatMessage[], hasNext, hasPrev, nextPage(), prevPage() }>` Returns the list of chat messages for a given `addressId`. @@ -60,7 +60,7 @@ await client.chat.getMessages({ addressId: "9dbe9e94-c797-461e-b5a3-af6d095deaf4 ### subscribe -▸ **subscribe**(`options`): `{cancel()}` +- **subscribe**(`options`): `{cancel()}` Returns a list of Addresses. @@ -91,7 +91,7 @@ cancel(); ### sendMessage -▸ **sendMessage**(`options`): `Promise` +- **sendMessage**(`options`): `Promise` Send a Chat Message to a given Address ID. If no Conversation exists with that Address ID, one will be created. This is the same function as [`conversation.sendMessage`](/sdks/browser-sdk/signalwire-client/client/conversation#sendmessage). @@ -117,7 +117,7 @@ await client.chat.sendMessage({ ### join -▸ **join**(`options`): `Promise` +- **join**(`options`): `Promise` Joins a conversation given an address without having to send a message. Does nothing if you were already joined to the conversation. This is the same function as [`conversation.join`](/sdks/browser-sdk/signalwire-client/client/conversation#join). diff --git a/website/docs/browser-sdk/tech-ref/SignalWire Client/client/conversation.mdx b/website/docs/browser-sdk/tech-ref/SignalWire Client/client/conversation.mdx index 22492d201..5e769298b 100644 --- a/website/docs/browser-sdk/tech-ref/SignalWire Client/client/conversation.mdx +++ b/website/docs/browser-sdk/tech-ref/SignalWire Client/client/conversation.mdx @@ -62,7 +62,7 @@ Here is an example of a `ConversationMessage` object: ### getConversations -▸ **getConversations**(): `Promise<{ data: Conversation[], hasNext, hasPrev }>` - +- **getConversations**(): `Promise<{ data: Conversation[], hasNext, hasPrev }>` - Returns a list of Conversation objects. @@ -96,7 +96,7 @@ await client.conversation.getConversations(); ### getConversationMessages -▸ **getConversationMessages**(`options`): `Promise<{ data: ConversationMessage[], hasNext, hasPrev }>` +- **getConversationMessages**(`options`): `Promise<{ data: ConversationMessage[], hasNext, hasPrev }>` Returns a list of ConversationMessage objects inside a Conversation with an Address ID. @@ -145,7 +145,7 @@ await client.conversation.getConversationMessages({ ### getMessages -▸ **getMessages**(`options`): `Promise<{ data: ConversationMessage[], hasNext, hasPrev }>` +- **getMessages**(`options`): `Promise<{ data: ConversationMessage[], hasNext, hasPrev }>` Returns a list of ConversationMessage objects without filtering by Address ID. @@ -191,7 +191,7 @@ await client.conversation.getMessages(); ### subscribe -▸ **subscribe**(): `Promise` +- **subscribe**(): `Promise` Subscribe to receive new ConversationMessage objects as they happen. @@ -231,7 +231,7 @@ client.conversation.subscribe((conversationMessage) => { ### sendMessage -▸ **sendMessage**(`options`): `Promise` +- **sendMessage**(`options`): `Promise` Sends a Chat Message to the Conversation. This is the same function as [`chat.sendMessage`](/sdks/browser-sdk/signalwire-client/client/chat#sendmessage). @@ -255,7 +255,7 @@ await conversation.sendMessage({ ### join -▸ **join**(`options`): `Promise` +- **join**(`options`): `Promise` Joins a conversation given an address, without having to send a message. Does nothing if you were already joined to the conversation. This is the same function as [`chat.join`](/sdks/browser-sdk/signalwire-client/client/chat#join). diff --git a/website/docs/browser-sdk/tech-ref/SignalWire Client/client/index.mdx b/website/docs/browser-sdk/tech-ref/SignalWire Client/client/index.mdx index 8596e650f..bbd80e575 100644 --- a/website/docs/browser-sdk/tech-ref/SignalWire Client/client/index.mdx +++ b/website/docs/browser-sdk/tech-ref/SignalWire Client/client/index.mdx @@ -60,7 +60,7 @@ export default function App() { ## **Parameters** -▸ **SignalWire**(`options`): `Promise` +- **SignalWire**(`options`): `Promise` | Name | Type | Required? | Description | | :----------------------------- | :----------------------- | :-------- | :---------------------------------------------------------------------- | @@ -149,7 +149,7 @@ export default function App() { ### httpHost -• `Readonly` **httpHost**: `string` +- `Readonly` **httpHost**: `string` Returns the URL of the host that the client will use to make HTTP requests (like querying the list of addresses or conversations). @@ -165,7 +165,7 @@ console.log(client.httpHost()); ### dial -▸ **dial**(`{to: string, nodeId ?: string}`): `Promise` +- **dial**(`{to: string, nodeId ?: string}`): `Promise` Dials to the address specified in the `to` parameter, and returns a `Call` object if successful. @@ -198,7 +198,7 @@ Promise to a Call object that describes the ongoing call, and provides handles f ### online -▸ **online**(`options`): `Promise` +- **online**(`options`): `Promise` Set the client to be online so it can receive call invites via WebRTC. The call invites can be accepted or rejected as per user input. @@ -257,13 +257,13 @@ window.reject = async () => { ### offline -▸ **offline**(): `void` +- **offline**(): `void` Set the client to be offline so it doesn't receive call invites via WebRTC. ### getSubscriberInfo -▸ **getSubscriberInfo**(): `void` +- **getSubscriberInfo**(): `void` Get information about the subscriber that is currently logged in. @@ -294,7 +294,7 @@ console.log(await client.getSubscriberInfo()) ### connect -▸ **connect**() +- **connect**() Connects to the WebSocket client. SignalWire manages the WebSocket connection automatically in most cases, so you'll only need to use `connect` in the rare edge @@ -302,7 +302,7 @@ cases when you need to manually manage the connection. ### disconnect -▸ **disconnect**() +- **disconnect**() Disconnects from the WebSocket client. SignalWire manages the WebSocket connection automatically in most cases. @@ -313,7 +313,7 @@ Nothing ### updateToken -▸ **updateToken**(token:`string`): `Promise` +- **updateToken**(token:`string`): `Promise` Update the auth token being used by the client. For example, in case when the old token is about to expire and you have diff --git a/website/docs/browser-sdk/tech-ref/SignalWire Client/utils.mdx b/website/docs/browser-sdk/tech-ref/SignalWire Client/utils.mdx index c9eedb2bf..9a920fda9 100644 --- a/website/docs/browser-sdk/tech-ref/SignalWire Client/utils.mdx +++ b/website/docs/browser-sdk/tech-ref/SignalWire Client/utils.mdx @@ -7,7 +7,7 @@ slug: /signalwire-client/utils ## `buildVideoElement` -▸ **buildVideoElement**(`options`): `Promise` +- **buildVideoElement**(`options`): `Promise` A function that creates and optionally injects a video DOM element for a given Call or Room object. diff --git a/website/docs/browser-sdk/tech-ref/chat/chat-client.mdx b/website/docs/browser-sdk/tech-ref/chat/chat-client.mdx index 3d0ebdb24..1d357822e 100644 --- a/website/docs/browser-sdk/tech-ref/chat/chat-client.mdx +++ b/website/docs/browser-sdk/tech-ref/chat/chat-client.mdx @@ -40,7 +40,7 @@ await chatClient.publish({ ### constructor -• **new Client**(`chatOptions`) +- **new Client**(`chatOptions`) Creates a new Chat client. @@ -65,7 +65,7 @@ const chatClient = new Chat.Client({ ### disconnect -▸ **disconnect**(): `void` +- **disconnect**(): `void` Disconnects this client. The client will stop receiving events and you will need to create a new instance if you want to use it again. @@ -83,7 +83,7 @@ client.disconnect(); ### getAllowedChannels -▸ **getAllowedChannels**(): `Promise` +- **getAllowedChannels**(): `Promise` Returns the channels that the current token allows you to subscribe to. @@ -116,7 +116,7 @@ console.log(channels); ### getMemberState -▸ **getMemberState**(`params`): `Promise<{ channels: Record }>` +- **getMemberState**(`params`): `Promise<{ channels: Record }>` Returns the states of a member in the specified channels. @@ -148,7 +148,7 @@ s.channels.chan1.state; // the state object for chan1 ### getMembers -▸ **getMembers**(`params`): `Promise<{ members: ChatMemberEntity[] }>` - See [ChatMemberEntity documentation](/sdks/browser-sdk/chat/member-entity) for more details. +- **getMembers**(`params`): `Promise<{ members: ChatMemberEntity[] }>` - See [ChatMemberEntity documentation](/sdks/browser-sdk/chat/member-entity) for more details. Returns the list of members in the given channel. @@ -177,7 +177,7 @@ m.members[0]; // { id: ..., channel: ..., state: ... } ### getMessages -▸ **getMessages**(`params`): `Promise<{ cursor: PagingCursor; messages: ChatMessageEntity[] }>` +- **getMessages**(`params`): `Promise<{ cursor: PagingCursor; messages: ChatMessageEntity[] }>` See [PagingCursor documentation](#paginationcursor) and [ChatMessageEntity documentation](/sdks/browser-sdk/chat/message-entity) for more details. @@ -245,7 +245,7 @@ const next = await chatClient.getMessages({ ### publish -▸ **publish**(`params`): `Promise` +- **publish**(`params`): `Promise` Publish a message into the specified channel. @@ -295,7 +295,7 @@ await chatClient.publish({ ### setMemberState -▸ **setMemberState**(`params`): `Promise` +- **setMemberState**(`params`): `Promise` Sets a state object for a member, for the specified channels. The previous state object will be completely replaced. @@ -328,7 +328,7 @@ await chatClient.setMemberState({ ### subscribe -▸ **subscribe**(`channels`): `Promise` +- **subscribe**(`channels`): `Promise` List of channels for which you want to receive messages. You can only subscribe to those channels for which your token has read permission. @@ -361,7 +361,7 @@ await chatClient.subscribe(["chan-2", "chan-3"]); ### unsubscribe -▸ **unsubscribe**(`channels`): `Promise` +- **unsubscribe**(`channels`): `Promise` List of channels from which you want to unsubscribe. @@ -386,7 +386,7 @@ await chatClient.unsubscribe(["chan-2", "chan-3"]); ### updateToken -▸ **updateToken**(`token`): `Promise` +- **updateToken**(`token`): `Promise` Replaces the token used by the client with a new one. You can use this method to replace the token when, for example, it is expiring, in order to keep the session alive. @@ -420,7 +420,7 @@ chatClient.on('session.expiring', async () => { ### member.joined -• **member.joined**(`member`) +- **member.joined**(`member`) A new member joined the chat. @@ -434,7 +434,7 @@ A new member joined the chat. ### member.left -• **member.left**(`member`) +- **member.left**(`member`) A member left the chat. @@ -448,7 +448,7 @@ A member left the chat. ### member.updated -• **member.updated**(`member`) +- **member.updated**(`member`) A member updated its state. @@ -462,7 +462,7 @@ A member updated its state. ### message -• **message**(`message`) +- **message**(`message`) A new message has been received. @@ -476,7 +476,7 @@ A new message has been received. ### session.expiring -• **session.expiring**() +- **session.expiring**() The session is going to expire. Use the `updateToken` method to refresh your token. diff --git a/website/docs/browser-sdk/tech-ref/chat/chatmemberentity.mdx b/website/docs/browser-sdk/tech-ref/chat/chatmemberentity.mdx index 6face9a67..2dcac63e3 100644 --- a/website/docs/browser-sdk/tech-ref/chat/chatmemberentity.mdx +++ b/website/docs/browser-sdk/tech-ref/chat/chatmemberentity.mdx @@ -9,7 +9,7 @@ An object representing a Chat Member with only the state properties of [`ChatMem ### channel -• `Readonly` **channel**: `string` +- `Readonly` **channel**: `string` The channel of this member. @@ -17,7 +17,7 @@ The channel of this member. ### id -• `Readonly` **id**: `string` +- `Readonly` **id**: `string` The id of this member. @@ -25,6 +25,6 @@ The id of this member. ### state -• `Readonly` **state**: `Record` +- `Readonly` **state**: `Record` The state of this member. diff --git a/website/docs/browser-sdk/tech-ref/chat/chatmessageentity.mdx b/website/docs/browser-sdk/tech-ref/chat/chatmessageentity.mdx index 123b72314..d2655d666 100644 --- a/website/docs/browser-sdk/tech-ref/chat/chatmessageentity.mdx +++ b/website/docs/browser-sdk/tech-ref/chat/chatmessageentity.mdx @@ -9,7 +9,7 @@ An object representing a Chat Message with only the state properties of [`ChatMe ### content -• `Readonly` **content**: `any` +- `Readonly` **content**: `any` The content of this message. This can be any JSON-serializable object or value. @@ -17,7 +17,7 @@ The content of this message. This can be any JSON-serializable object or value. ### id -• `Readonly` **id**: `string` +- `Readonly` **id**: `string` The id of this message. @@ -25,7 +25,7 @@ The id of this message. ### member -• `Readonly` **member**: [`ChatMember`](/sdks/browser-sdk/chat/member) +- `Readonly` **member**: [`ChatMember`](/sdks/browser-sdk/chat/member) The member which sent this message. @@ -33,7 +33,7 @@ The member which sent this message. ### meta -• `Readonly` **meta?**: `any` +- `Readonly` **meta?**: `any` Any metadata associated with this message. @@ -41,6 +41,6 @@ Any metadata associated with this message. ### publishedAt -• `Readonly` **publishedAt**: `Date` +- `Readonly` **publishedAt**: `Date` The date and time at which this message was published. diff --git a/website/docs/browser-sdk/tech-ref/pubsub/pubsub-client.mdx b/website/docs/browser-sdk/tech-ref/pubsub/pubsub-client.mdx index 2a3a4177d..7fe4c9a00 100644 --- a/website/docs/browser-sdk/tech-ref/pubsub/pubsub-client.mdx +++ b/website/docs/browser-sdk/tech-ref/pubsub/pubsub-client.mdx @@ -40,7 +40,7 @@ await pubSubClient.publish({ ### constructor -• **new Client**(`pubSubOptions`) +- **new Client**(`pubSubOptions`) Creates a new PubSub client. @@ -65,7 +65,7 @@ const pubSubClient = new PubSub.Client({ ### disconnect -▸ **disconnect**(): `void` +- **disconnect**(): `void` Disconnects this client. The client will stop receiving events and you will need to create a new instance if you want to use it again. @@ -83,7 +83,7 @@ client.disconnect(); ### getAllowedChannels -▸ **getAllowedChannels**(): `Promise` +- **getAllowedChannels**(): `Promise` Returns the channels that the current token allows you to subscribe to. @@ -134,7 +134,7 @@ console.log(channels); ### publish -▸ **publish**(`params`): `Promise` +- **publish**(`params`): `Promise` Publish a message into the specified channel. @@ -184,7 +184,7 @@ await pubSub.publish({ ### subscribe -▸ **subscribe**(`channels`): `Promise` +- **subscribe**(`channels`): `Promise` List of channels for which you want to receive messages. You can only subscribe to those channels for which your token has read permission. @@ -217,7 +217,7 @@ await pubSub.subscribe(["chan-2", "chan-3"]); ### unsubscribe -▸ **unsubscribe**(`channels`): `Promise` +- **unsubscribe**(`channels`): `Promise` List of channels from which you want to unsubscribe. @@ -242,7 +242,7 @@ await pubSub.unsubscribe(["chan-2", "chan-3"]); ### updateToken -▸ **updateToken**(`token`): `Promise` +- **updateToken**(`token`): `Promise` Replaces the token used by the client with a new one. You can use this method to replace the token when, for example, it is expiring, in order to keep the session alive. @@ -276,7 +276,7 @@ pubSubClient.on('session.expiring', async () => { ### message -• **message**(`message`) +- **message**(`message`) A new message has been received. @@ -290,6 +290,6 @@ A new message has been received. ### session.expiring -• **session.expiring**() +- **session.expiring**() The session is going to expire. Use the [updateToken](#updatetoken) method to refresh your token. diff --git a/website/docs/browser-sdk/tech-ref/video/index.mdx b/website/docs/browser-sdk/tech-ref/video/index.mdx index 79de5a1a8..b673ed25a 100644 --- a/website/docs/browser-sdk/tech-ref/video/index.mdx +++ b/website/docs/browser-sdk/tech-ref/video/index.mdx @@ -28,7 +28,7 @@ Functions directly on the Video namespace have been **deprecated**. Please use t ### ~~createRoomObject~~ -▸ `Const` **createRoomObject**(`roomOptions`): `Promise` +- `Const` **createRoomObject**(`roomOptions`): `Promise` > ⚠️ **Deprecated** > @@ -67,7 +67,7 @@ try { ### ~~joinRoom~~ -▸ `Const` **joinRoom**(`roomOptions`): `Promise` +- `Const` **joinRoom**(`roomOptions`): `Promise` > ⚠️ Deprecated. > diff --git a/website/docs/browser-sdk/tech-ref/video/video-roomsession.mdx b/website/docs/browser-sdk/tech-ref/video/video-roomsession.mdx index 088b58d50..6ae69223d 100644 --- a/website/docs/browser-sdk/tech-ref/video/video-roomsession.mdx +++ b/website/docs/browser-sdk/tech-ref/video/video-roomsession.mdx @@ -34,7 +34,7 @@ Please refer to the [Simple Video Demo](/video/getting-started/simple-video-demo ### constructor -• **new RoomSession**(`opts`) +- **new RoomSession**(`opts`) Creates a new RoomSession. Note that the room will not be joined until [join](#join) has been called. @@ -68,7 +68,7 @@ const roomSession = new SignalWire.Video.RoomSession({ ### active -• `Readonly` **active**: `boolean` +- `Readonly` **active**: `boolean` Whether the connection is currently active. @@ -76,7 +76,7 @@ Whether the connection is currently active. ### cameraId -• `Readonly` **cameraId**: `null` \| `string` +- `Readonly` **cameraId**: `null` \| `string` The id of the video device, or null if not available. @@ -84,7 +84,7 @@ The id of the video device, or null if not available. ### cameraLabel -• `Readonly` **cameraLabel**: `null` \| `string` +- `Readonly` **cameraLabel**: `null` \| `string` The label of the video device, or null if not available. @@ -92,7 +92,7 @@ The label of the video device, or null if not available. ### deviceList -• `Readonly` **deviceList**: [`RoomSessionDevice`](/sdks/browser-sdk/video/room-session-device)[] +- `Readonly` **deviceList**: [`RoomSessionDevice`](/sdks/browser-sdk/video/room-session-device)[] Contains any additional devices added via [addCamera](/sdks/browser-sdk/video/room-session#addcamera), [addMicrophone](/sdks/browser-sdk/video/room-session#addmicrophone), or [addDevice](/sdks/browser-sdk/video/room-session#adddevice). @@ -100,7 +100,7 @@ Contains any additional devices added via [addCamera](/sdks/browser-sdk/video/ro ### interactivityMode -• `Readonly` **interactivityMode**: `"audience"`|`"member"` +- `Readonly` **interactivityMode**: `"audience"`|`"member"` The current interactivity mode (_member_ or _audience_) for the local member. @@ -112,7 +112,7 @@ can only view and/or listen. See [join](#join). ### localAudioTrack -• `Readonly` **localAudioTrack**: `null` \| `MediaStreamTrack` +- `Readonly` **localAudioTrack**: `null` \| `MediaStreamTrack` Provides access to the local audio [MediaStreamTrack](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack). @@ -120,7 +120,7 @@ Provides access to the local audio [MediaStreamTrack](https://developer.mozilla. ### localStream -• `Readonly` **localStream**: `undefined` \| `MediaStream` +- `Readonly` **localStream**: `undefined` \| `MediaStream` Provides access to the local [MediaStream](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream). @@ -128,7 +128,7 @@ Provides access to the local [MediaStream](https://developer.mozilla.org/en-US/d ### localVideoTrack -• `Readonly` **localVideoTrack**: `null` \| `MediaStreamTrack` +- `Readonly` **localVideoTrack**: `null` \| `MediaStreamTrack` Provides access to the local video [MediaStreamTrack](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack). @@ -136,7 +136,7 @@ Provides access to the local video [MediaStreamTrack](https://developer.mozilla. ### localOverlay -• `Readonly` **localOverlay**: [`LocalOverlay`](/sdks/browser-sdk/video/local-overlay) +- `Readonly` **localOverlay**: [`LocalOverlay`](/sdks/browser-sdk/video/local-overlay) Provides access to the local video overlay. Use this for example to mirror the local video. @@ -145,7 +145,7 @@ Provides access to the local video overlay. Use this for example to mirror the l ### memberId -• `Readonly` **memberId**: `string` +- `Readonly` **memberId**: `string` The id of the current member within the room. @@ -153,7 +153,7 @@ The id of the current member within the room. ### microphoneId -• `Readonly` **microphoneId**: `null` \| `string` +- `Readonly` **microphoneId**: `null` \| `string` The id of the audio input device, or null if not available. @@ -161,7 +161,7 @@ The id of the audio input device, or null if not available. ### microphoneLabel -• `Readonly` **microphoneLabel**: `null` \| `string` +- `Readonly` **microphoneLabel**: `null` \| `string` The label of the audio input device, or null if not available. @@ -169,7 +169,7 @@ The label of the audio input device, or null if not available. ### permissions -• `Readonly` **permissions**: `string[]` +- `Readonly` **permissions**: `string[]` The list of permissions currently available to the local member. @@ -177,7 +177,7 @@ The list of permissions currently available to the local member. ### previewUrl -• `Optional` `Readonly` **previewUrl**: `string` +- `Optional` `Readonly` **previewUrl**: `string` If the Room has been created with the property `enable_room_previews` set to `true`, this field contains the URL to the room preview. @@ -185,7 +185,7 @@ If the Room has been created with the property `enable_room_previews` set to `tr ### remoteStream -• `Readonly` **remoteStream**: `undefined` \| `MediaStream` +- `Readonly` **remoteStream**: `undefined` \| `MediaStream` Provides access to the remote [MediaStream](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream). @@ -193,7 +193,7 @@ Provides access to the remote [MediaStream](https://developer.mozilla.org/en-US/ ### roomId -• `Readonly` **roomId**: `string` +- `Readonly` **roomId**: `string` The unique identifier for the room. @@ -201,7 +201,7 @@ The unique identifier for the room. ### roomSessionId -• `Readonly` **roomSessionId**: `string` +- `Readonly` **roomSessionId**: `string` The unique identifier for the room session. @@ -209,7 +209,7 @@ The unique identifier for the room session. ### screenShareList -• `Readonly` **screenShareList**: [`RoomSessionScreenShare`](/sdks/browser-sdk/video/room-session-screenshare)[] +- `Readonly` **screenShareList**: [`RoomSessionScreenShare`](/sdks/browser-sdk/video/room-session-screenshare)[] Contains any local screen shares added to the room via [startScreenShare](/sdks/browser-sdk/video/room-session#startscreenshare). @@ -219,7 +219,7 @@ Contains any local screen shares added to the room via [startScreenShare](/sdks/ ### addCamera -▸ **addCamera**(`opts`): `Promise` - See [RoomSessionDevice documentation](/sdks/browser-sdk/video/room-session-device) for more details. +- **addCamera**(`opts`): `Promise` - See [RoomSessionDevice documentation](/sdks/browser-sdk/video/room-session-device) for more details. Adds a camera device to the room. Using this method, a user can stream multiple video sources at the same time. @@ -270,7 +270,7 @@ await roomDev.join(); ### addDevice -▸ **addDevice**(`opts`): `Promise` - See [RoomSessionDevice documentation](/sdks/browser-sdk/video/room-session-device) for more details. +- **addDevice**(`opts`): `Promise` - See [RoomSessionDevice documentation](/sdks/browser-sdk/video/room-session-device) for more details. Adds a device to the room. Using this method, a user can stream multiple sources at the same time. If you need to add a camera device or a microphone device, you can alternatively use the more specific methods [addCamera](/sdks/browser-sdk/video/room-session#addcamera) and [addMicrophone](/sdks/browser-sdk/video/room-session#addmicrophone). @@ -305,7 +305,7 @@ await roomSession.addDevice({ audio: true }); ### addMicrophone -▸ **addMicrophone**(`opts`): `Promise` - See [RoomSessionDevice documentation](/sdks/browser-sdk/video/room-session-device) for more details. +- **addMicrophone**(`opts`): `Promise` - See [RoomSessionDevice documentation](/sdks/browser-sdk/video/room-session-device) for more details. Adds a microphone device to the room. Using this method, a user can stream multiple audio sources at the same time. @@ -355,7 +355,7 @@ await roomDev.join(); ### audioMute -▸ **audioMute**(`params?`): `Promise` +- **audioMute**(`params?`): `Promise` Puts the microphone on mute. The other participants will not hear audio from the muted participant anymore. You can use this method to mute either yourself or another participant in the room. @@ -396,7 +396,7 @@ await roomSession.audioMute({ memberId: id }); ### audioUnmute -▸ **audioUnmute**(`params?`): `Promise` +- **audioUnmute**(`params?`): `Promise` Unmutes the microphone if it had been previously muted. You can use this method to unmute either yourself or another participant in the room. @@ -437,7 +437,7 @@ await roomSession.audioUnmute({ memberId: id }); ### ~~createScreenShareObject~~ -▸ **createScreenShareObject**(`opts`): `Promise` - See [RoomSessionScreenShare documentation](/sdks/browser-sdk/video/room-session-screenshare) for more details. +- **createScreenShareObject**(`opts`): `Promise` - See [RoomSessionScreenShare documentation](/sdks/browser-sdk/video/room-session-screenshare) for more details. > ⚠️ Deprecated. @@ -477,7 +477,7 @@ await roomSession.createScreenShareObject({ audio: true, video: true }); ### deaf -▸ **deaf**(`params?`): `Promise` +- **deaf**(`params?`): `Promise` Mutes the incoming audio. The affected participant will not hear audio from the other participants anymore. You can use this method to make deaf either yourself or another participant in the room. @@ -520,7 +520,7 @@ await roomSession.deaf({ memberId: id }); ### deleteMemberMeta -▸ **deleteMemberMeta**(`params`): `Promise` +- **deleteMemberMeta**(`params`): `Promise` Deletes the specified keys from the metadata for the specified member. @@ -564,7 +564,7 @@ await roomSession.deleteMemberMeta({ memberId: "...", keys: ["foo"] }); ### deleteMeta -▸ **deleteMeta**(`keys`): `Promise` +- **deleteMeta**(`keys`): `Promise` Deletes the specified keys from the metadata for this RoomSession. @@ -603,7 +603,7 @@ await roomSession.deleteMeta(["foo"]); ### demote -▸ **demote**(`params`): `Promise` +- **demote**(`params`): `Promise` Demotes a participant from "member" to "audience". See [join](#join) and [promote](#promote). @@ -638,7 +638,7 @@ await roomSession.demote({ ### destroy -▸ **destroy**(): `void` +- **destroy**(): `void` Destroys the room object. This only destroys the JavaScript object: it has no effect on the server-side room. @@ -650,7 +650,7 @@ Destroys the room object. This only destroys the JavaScript object: it has no ef ### getLayouts -▸ **getLayouts**(): `Promise<{ layouts: string[] }>` +- **getLayouts**(): `Promise<{ layouts: string[] }>` Returns a list of available layouts for the room. @@ -682,7 +682,7 @@ await roomSession.getLayouts() ### getMembers -▸ **getMembers**(): `Promise<{ members: VideoMemberEntity[] }>` +- **getMembers**(): `Promise<{ members: VideoMemberEntity[] }>` Returns a list of members currently in the room. @@ -733,7 +733,7 @@ await roomSession.getMembers() ### getMemberMeta -▸ **getMemberMeta**(): `Promise<{ meta: Object }>` +- **getMemberMeta**(): `Promise<{ meta: Object }>` Returns the metadata assigned to the specified member. @@ -759,7 +759,7 @@ console.log(meta); ### getMeta -▸ **getMeta**(): `Promise<{ meta`: `Object` }\> +- **getMeta**(): `Promise<{ meta`: `Object` }\> Returns the metadata assigned to this Room Session. @@ -778,7 +778,7 @@ console.log(meta); ### getPlaybacks -▸ **getPlaybacks**(): `Promise<{ playbacks: RoomSessionPlayback }>` - See [RoomSessionPlayback documentation](/sdks/browser-sdk/video/room-session-playback) for more details. +- **getPlaybacks**(): `Promise<{ playbacks: RoomSessionPlayback }>` - See [RoomSessionPlayback documentation](/sdks/browser-sdk/video/room-session-playback) for more details. Obtains a list of recordings for the current room session. @@ -807,7 +807,7 @@ if (pl.playbacks.length > 0) { ### getRecordings -▸ **getRecordings**(): `Promise<{ recordings: RoomSessionRecording}>` - See [RoomSessionRecording documentation](/sdks/browser-sdk/video/room-session-recording) for more details. +- **getRecordings**(): `Promise<{ recordings: RoomSessionRecording}>` - See [RoomSessionRecording documentation](/sdks/browser-sdk/video/room-session-recording) for more details. Obtains a list of recordings for the current room session. To download the actual mp4 file, please use the [REST API](/rest). @@ -843,7 +843,7 @@ curl --request GET \ ### getStreams -▸ **getStreams**(): `Promise<{ streams: RoomSessionStream}>` - See [RoomSessionStream documentation](/sdks/browser-sdk/video/room-session-stream) for more details. +- **getStreams**(): `Promise<{ streams: RoomSessionStream}>` - See [RoomSessionStream documentation](/sdks/browser-sdk/video/room-session-stream) for more details. Obtains a list of active streams for this RoomSession. These are RTMP streams of the audio/video content of this room, which will be sent to an external party @@ -870,7 +870,7 @@ for (const stream of s.streams) { ### hangupAll -▸ **hangupAll**(): `Promise` +- **hangupAll**(): `Promise` Hangs up the active calls in the `RoomSession` and will send a `REJECT_ALL` message to the rejected participant(s). @@ -915,7 +915,7 @@ await roomSession.hangupAll(); ### ~~hideVideoMuted~~ -▸ **hideVideoMuted**(): `Promise` +- **hideVideoMuted**(): `Promise` > ⚠️ Deprecated. > Use [setHideVideoMuted](/sdks/browser-sdk/video/room-session#sethidevideomuted) instead. @@ -943,7 +943,7 @@ await roomSession.hideVideoMuted(); ### join -▸ **join**(): `Promise` +- **join**(): `Promise` Joins the room session. @@ -970,7 +970,7 @@ as a _member_ or as an _audience_ participant. ### leave -▸ **leave**(): `Promise` +- **leave**(): `Promise` Leaves the room. This detaches all the locally originating streams from the room. @@ -982,7 +982,7 @@ Leaves the room. This detaches all the locally originating streams from the room ### lock -▸ **lock**(`params`): `Promise` +- **lock**(`params`): `Promise` Locks the room. This prevents new participants from joining the room. @@ -1019,7 +1019,7 @@ await roomSession.lock(); ### play -▸ **play**(`params`): `Promise` - See [RoomSessionPlayback documentation](/sdks/browser-sdk/video/room-session-playback) for more details. +- **play**(`params`): `Promise` - See [RoomSessionPlayback documentation](/sdks/browser-sdk/video/room-session-playback) for more details. Starts a playback in the room. You can use the returned [RoomSessionPlayback](/sdks/browser-sdk/video/room-session-playback) object to control the playback (e.g., pause, resume, setVolume and stop). @@ -1055,7 +1055,7 @@ await playback.stop(); ### promote -▸ **promote**(`params`): `Promise` +- **promote**(`params`): `Promise` Promotes a participant from "audience" to "member". See [join](#join) and [demote](#demote). @@ -1107,7 +1107,7 @@ await roomSession.promote({ ### removeAllMembers -▸ **removeAllMembers**(): `Promise` +- **removeAllMembers**(): `Promise` Removes all the members from this room session. The room session will end. @@ -1131,7 +1131,7 @@ await roomSession.removeAllMembers(); ### removeMember -▸ **removeMember**(`params`): `Promise` +- **removeMember**(`params`): `Promise` Removes a specific participant from the room. @@ -1164,7 +1164,7 @@ await roomSession.removeMember({ memberId: id }); ### sendDigits -▸ **sendDigits**(`string`): `Promise` +- **sendDigits**(`string`): `Promise` Sends DTMF digits to the room. The digits will be sent to the RoomSession. @@ -1189,7 +1189,7 @@ await roomSession.sendDigits("1"); ### setHideVideoMuted -▸ **setHideVideoMuted**(`value`): `Promise` +- **setHideVideoMuted**(`value`): `Promise` Show or hide muted videos in the room layout. Members that have been muted via [videoMute](/sdks/browser-sdk/video/room-session#videomute) will not appear in the video stream, instead of appearing as a mute image, if this setting is enabled. @@ -1222,7 +1222,7 @@ await roomSession.setHideVideoMuted(false); ### setInputSensitivity -▸ **setInputSensitivity**(`params`): `Promise` +- **setInputSensitivity**(`params`): `Promise` Sets the input level at which the participant is identified as currently speaking. You can use this method to set the input sensitivity for either yourself or another participant in the room. @@ -1264,7 +1264,7 @@ await roomSession.setInputSensitivity({ memberId: id, value: 80 }); ### setInputVolume -▸ **setInputVolume**(`params`): `Promise` +- **setInputVolume**(`params`): `Promise` Sets the input volume level (e.g. for the microphone). You can use this method to set the input volume for either yourself or another participant in the room. @@ -1306,7 +1306,7 @@ await roomSession.setInputVolume({ memberId: id, volume: -10 }); ### setLayout -▸ **setLayout**(`params`): `Promise` +- **setLayout**(`params`): `Promise` Sets a layout for the room. You can obtain a list of available layouts with [getLayouts](/sdks/browser-sdk/video/room-session#getlayouts). @@ -1341,7 +1341,7 @@ await roomSession.setLayout({ name: "6x6" }); ### setLocalStream -▸ **setLocalStream**(`stream`): `void` +- **setLocalStream**(`stream`): `void` Replaces the current local media stream with the one specified as a parameter. @@ -1391,7 +1391,7 @@ await roomSession.setLocalStream(stream); ### setMemberMeta -▸ **setMemberMeta**(`params`): `Promise` +- **setMemberMeta**(`params`): `Promise` Assigns custom metadata to the specified RoomSession member. You can use this to store metadata whose meaning is entirely defined by your application. @@ -1443,7 +1443,7 @@ await roomSession.setMemberMeta({ ### setMemberPosition -▸ **setMemberPosition**(`params`): `Promise` +- **setMemberPosition**(`params`): `Promise` Assigns a position in the layout to the specified member. @@ -1479,7 +1479,7 @@ await roomSession.setMemberPosition({ ### setMeta -▸ **setMeta**(`meta`): `Promise` +- **setMeta**(`meta`): `Promise` Assigns custom metadata to the RoomSession. You can use this to store metadata whose meaning is entirely defined by your application. @@ -1511,7 +1511,7 @@ await roomSession.setMeta({ foo: "bar" }); ### setOutputVolume -▸ **setOutputVolume**(`params`): `Promise` +- **setOutputVolume**(`params`): `Promise` Sets the output volume level (e.g., for the speaker). You can use this method to set the output volume for either yourself or another participant in the room. @@ -1553,7 +1553,7 @@ await roomSession.setOutputVolume({ memberId: id, volume: -10 }); ### setPositions -▸ **setPositions**(`params`): `Promise` +- **setPositions**(`params`): `Promise` Assigns a position in the layout for multiple members. @@ -1589,7 +1589,7 @@ await roomSession.setPositions({ ### setPrioritizeHandraise -▸ **setPrioritizeHandraise**(`params`): `Promise` +- **setPrioritizeHandraise**(`params`): `Promise` Sets whether to prioritize hand-raise's or not. @@ -1621,7 +1621,7 @@ await room.setPrioritizeHandraise(false) ### setRaisedHand -▸ **setRaisedHand**(`params`): `Promise` +- **setRaisedHand**(`params`): `Promise` Sets the raised hand status for the current member. @@ -1659,7 +1659,7 @@ await roomSession.setRaisedHand({ ### ~~showVideoMuted~~ -▸ **showVideoMuted**(): `Promise` +- **showVideoMuted**(): `Promise` > ⚠️ Deprecated. > Use [setHideVideoMuted](/sdks/browser-sdk/video/room-session#sethidevideomuted) instead. @@ -1686,7 +1686,7 @@ await roomSession.showVideoMuted(); ### startRecording -▸ **startRecording**(): `Promise` - See [RoomSessionRecording documentation](/sdks/browser-sdk/video/room-session-recording) for more details. +- **startRecording**(): `Promise` - See [RoomSessionRecording documentation](/sdks/browser-sdk/video/room-session-recording) for more details. Starts the recording of the room. You can use the returned [RoomSessionRecording](/sdks/browser-sdk/video/room-session-recording) object to control the recording (e.g., pause, resume, stop). @@ -1711,7 +1711,7 @@ await rec.stop(); ### startScreenShare -▸ **startScreenShare**(`opts`): `Promise` - See [RoomSessionScreenShare documentation](/sdks/browser-sdk/video/room-session-screenshare) for more details. +- **startScreenShare**(`opts`): `Promise` - See [RoomSessionScreenShare documentation](/sdks/browser-sdk/video/room-session-screenshare) for more details. Adds a screen sharing instance to the room. You can create multiple screen sharing instances and add all of them to the room. @@ -1761,7 +1761,7 @@ await roomSession.startScreenShare({ ### startStream -▸ **startStream**(): `Promise` - See [RoomSessionStream documentation](/sdks/browser-sdk/video/room-session-stream) for more details. +- **startStream**(): `Promise` - See [RoomSessionStream documentation](/sdks/browser-sdk/video/room-session-stream) for more details. Starts streaming the audio/video of this room to an external service. You can use the returned [RoomSessionStream](/sdks/browser-sdk/video/room-session-stream) object to @@ -1797,7 +1797,7 @@ setTimeout(() => stream.stop(), 60000); ### undeaf -▸ **undeaf**(`params?`): `Promise` +- **undeaf**(`params?`): `Promise` Unmutes the incoming audio. The affected participant will start hearing audio from the other participants again. You can use this method to undeaf either yourself or another participant in the room. @@ -1840,7 +1840,7 @@ await roomSession.undeaf({ memberId: id }); ### updateCamera -▸ **updateCamera**(`constraints`): `Promise` +- **updateCamera**(`constraints`): `Promise` Replaces the current camera stream with the one coming from a different device. @@ -1868,7 +1868,7 @@ await roomSession.updateCamera({ ### updateMemberMeta -▸ **updateMemberMeta**(`params`): `Promise` +- **updateMemberMeta**(`params`): `Promise` Updates a member's metadata in only the specified fields. This is different from [setMemberMeta](#setmembermeta), which replaces the whole metadata object. @@ -1916,7 +1916,7 @@ await roomSession.updateMemberMeta({ ### updateMeta -▸ **updateMeta**(`meta`): `Promise` +- **updateMeta**(`meta`): `Promise` Updates the RoomSession metadata by only setting the specified fields. This is different from [setMeta](#setmeta), which replaces the whole metadata object. @@ -1956,7 +1956,7 @@ await roomSession.updateMeta({ baz: false, t: 10 }); ### unlock -▸ **unlock**(`params`): `Promise` +- **unlock**(`params`): `Promise` Unlocks the room if it had been previously locked. This allows new participants to join the room. @@ -1974,7 +1974,7 @@ await roomSession.unlock(); ### updateMicrophone -▸ **updateMicrophone**(`constraints`): `Promise` +- **updateMicrophone**(`constraints`): `Promise` Replaces the current microphone stream with the one coming from a different device. @@ -2002,7 +2002,7 @@ await roomSession.updateMicrophone({ ### updateSpeaker -▸ **updateSpeaker**(`opts`): `Promise` +- **updateSpeaker**(`opts`): `Promise` Replaces the current speaker with a different one. @@ -2034,7 +2034,7 @@ await roomSession.updateSpeaker({ ### videoMute -▸ **videoMute**(`params?`): `Promise` +- **videoMute**(`params?`): `Promise` Puts the video on mute. Participants will see a mute image instead of the video stream. You can use this method to mute either yourself or another participant in the room. @@ -2075,7 +2075,7 @@ await roomSession.videoMute({ memberId: id }); ### videoUnmute -▸ **videoUnmute**(`params?`): `Promise` +- **videoUnmute**(`params?`): `Promise` Unmutes the video if it had been previously muted. Participants will start seeing the video stream again. You can use this method to unmute either yourself or another participant in the room. @@ -2120,7 +2120,7 @@ List of events emitted by a RoomSession object. ### camera.disconnected -• **camera.disconnected**(`e`) +- **camera.disconnected**(`e`) A camera device was disconnected. @@ -2136,7 +2136,7 @@ A camera device was disconnected. ### camera.updated -• **camera.updated**(`e`) +- **camera.updated**(`e`) A camera device was updated. @@ -2156,7 +2156,7 @@ A camera device was updated. ### layout.changed -• **layout.changed**(`e`) +- **layout.changed**(`e`) The layout of the room has changed. This event is not limited to changes associated to the grid layout of the room: it also includes for example changes @@ -2179,25 +2179,25 @@ in the position of the participants within the grid of the room. ### media.connected -• **media.connected** +- **media.connected** New media has been connected. There is no payload, as this event is used to troubleshoot advanced use cases when hooking into the media connection. ### media.disconnected -• **media.disconnected** +- **media.disconnected** Media has been disconnected from the session. There is no payload, as this event is used to troubleshoot advanced use cases when hooking into the media connection. ### media.reconnecting -• **media.reconnecting** +- **media.reconnecting** Media is attempting to reconnect to the session. There is no payload, as this event is used to troubleshoot advanced use cases when hooking into the media connection. ### member.demoted -• **member.demoted**(`e`) +- **member.demoted**(`e`) A member has been demoted to audience, for example using [demote](#demote). @@ -2219,7 +2219,7 @@ to ensure future compatibility. ### member.joined -• **member.joined**(`e`) +- **member.joined**(`e`) A member has joined the room. @@ -2249,7 +2249,7 @@ A member has joined the room. ### member.left -• **member.left**(`e`) +- **member.left**(`e`) A member has left the room. @@ -2270,7 +2270,7 @@ A member has left the room. ### member.promoted -• **member.promoted**(`e`) +- **member.promoted**(`e`) An audience participant has been promoted to member, for example using [promote](#promote). @@ -2292,7 +2292,7 @@ to ensure future compatibility. ### member.talking -• **member.talking**(`e`) +- **member.talking**(`e`) A member is talking or has stopped talking. @@ -2313,7 +2313,7 @@ A member is talking or has stopped talking. ### member.updated -• **member.updated**(`e`) +- **member.updated**(`e`) A property of a member of the room has been updated. @@ -2355,7 +2355,7 @@ For example, say `visible` and `video_muted` have been updated. The received obj ### memberList.updated -• **memberList.updated**(`e`) +- **memberList.updated**(`e`) The set of members or one or more properties of a member have changed. @@ -2370,7 +2370,7 @@ The set of members or one or more properties of a member have changed. ### microphone.disconnected -• **microphone.disconnected**(`e`) +- **microphone.disconnected**(`e`) A microphone device was disconnected. @@ -2386,7 +2386,7 @@ A microphone device was disconnected. ### microphone.updated -• **microphone.updated**(`e`) +- **microphone.updated**(`e`) A microphone device was updated. @@ -2406,7 +2406,7 @@ A microphone device was updated. ### playback.ended -• **playback.ended** +- **playback.ended** A playback has ended. You only receive this event if your token has the `room.playback` permission. The event handler receives a [RoomSessionPlayback](/sdks/browser-sdk/video/room-session-playback) object. @@ -2414,7 +2414,7 @@ A playback has ended. You only receive this event if your token has the `room.pl ### playback.started -• **playback.started** +- **playback.started** A playback has been started. You only receive this event if your token has the `room.playback` permission. The event handler receives a [RoomSessionPlayback](/sdks/browser-sdk/video/room-session-playback) object. @@ -2422,7 +2422,7 @@ A playback has been started. You only receive this event if your token has the ` ### playback.updated -• **playback.updated** +- **playback.updated** A playback has been updated. You only receive this event if your token has the `room.playback` permission. The event handler receives a [RoomSessionPlayback](./video-roomsessionplayback.md) object. @@ -2430,7 +2430,7 @@ A playback has been updated. You only receive this event if your token has the ` ### recording.ended -• **recording.ended** +- **recording.ended** An active recording has been stopped. You only receive this event if your token has the `room.recording` permission. The event handler receives a [RoomSessionRecording](/sdks/browser-sdk/video/room-session-recording) object. @@ -2438,7 +2438,7 @@ An active recording has been stopped. You only receive this event if your token ### recording.started -• **recording.started** +- **recording.started** A recording has been started in the room. You only receive this event if your token has the `room.recording` permission. The event handler receives a [RoomSessionRecording](/sdks/browser-sdk/video/room-session-recording) object. @@ -2446,7 +2446,7 @@ A recording has been started in the room. You only receive this event if your to ### recording.updated -• **recording.updated** +- **recording.updated** An active recording has been updated. You only receive this event if your token has the `room.recording` permission. The event handler receives a [RoomSessionRecording](/sdks/browser-sdk/video/room-session-recording) object. @@ -2454,7 +2454,7 @@ An active recording has been updated. You only receive this event if your token ### room.audience_count -• **room.audience_count**(`e`) +- **room.audience_count**(`e`) This event is received periodically, and contains a total count of audience members. @@ -2473,7 +2473,7 @@ Audience members joining and leaving trigger this event. ### room.joined -• **room.joined**(`e`) +- **room.joined**(`e`) The current client joined the room session. The event handler receives objects that contain information about the room and all its members (including the current client). @@ -2503,7 +2503,7 @@ The current client joined the room session. The event handler receives objects t ### room.left -• **room.left**(`e`) +- **room.left**(`e`) The current client left the room session. @@ -2518,7 +2518,7 @@ The current client left the room session. ### room.updated -• **room.updated**(`e`) +- **room.updated**(`e`) The properties of the room have been updated. @@ -2555,7 +2555,7 @@ For example, if `hide_video_muted` has been updated, the received object will be ### speaker.disconnected -• **speaker.disconnected**(`e`) +- **speaker.disconnected**(`e`) A speaker device was disconnected. @@ -2571,7 +2571,7 @@ A speaker device was disconnected. ### speaker.updated -• **speaker.updated**(`e`) +- **speaker.updated**(`e`) A speaker device was updated. @@ -2591,7 +2591,7 @@ A speaker device was updated. ### stream.ended -• **stream.ended**(`stream`) +- **stream.ended**(`stream`) A stream ended (e.g., it was stopped). @@ -2605,7 +2605,7 @@ A stream ended (e.g., it was stopped). ### stream.started -• **stream.started**(`stream`) +- **stream.started**(`stream`) A new stream started. diff --git a/website/docs/browser-sdk/tech-ref/video/video-roomsessionstream.mdx b/website/docs/browser-sdk/tech-ref/video/video-roomsessionstream.mdx index 6a91a3a08..49831f811 100644 --- a/website/docs/browser-sdk/tech-ref/video/video-roomsessionstream.mdx +++ b/website/docs/browser-sdk/tech-ref/video/video-roomsessionstream.mdx @@ -14,7 +14,7 @@ You can start a stream with [RoomSession.startStream](/sdks/browser-sdk/video/ro ### duration -• `Optional` **duration**: `number` +- `Optional` **duration**: `number` Total seconds of time spent streaming, if available. This is equal to (`endedAt` - `startedAt`). @@ -22,7 +22,7 @@ Total seconds of time spent streaming, if available. This is equal to (`endedAt` ### endedAt -• `Optional` **endedAt**: `Date` +- `Optional` **endedAt**: `Date` End time, if available. @@ -30,7 +30,7 @@ End time, if available. ### id -• **id**: `string` +- **id**: `string` The unique id of this stream. @@ -38,7 +38,7 @@ The unique id of this stream. ### roomSessionId -• **roomSessionId**: `string` +- **roomSessionId**: `string` The id of the room session associated to this stream. @@ -46,7 +46,7 @@ The id of the room session associated to this stream. ### startedAt -• **startedAt**: `Date` +- **startedAt**: `Date` Start time, if available. @@ -54,7 +54,7 @@ Start time, if available. ### state -• **state**: `"streaming"` \| `"completed"` +- **state**: `"streaming"` \| `"completed"` Current state of the stream. @@ -62,7 +62,7 @@ Current state of the stream. ### url -• **url**: `string` +- **url**: `string` The RTMP URL of the stream. @@ -70,7 +70,7 @@ The RTMP URL of the stream. ### stop -▸ **stop**(): `Promise` +- **stop**(): `Promise` Stops the stream. diff --git a/website/docs/browser-sdk/tech-ref/webrtc/index.mdx b/website/docs/browser-sdk/tech-ref/webrtc/index.mdx index 0b9dccb08..28f216a3d 100644 --- a/website/docs/browser-sdk/tech-ref/webrtc/index.mdx +++ b/website/docs/browser-sdk/tech-ref/webrtc/index.mdx @@ -12,7 +12,7 @@ The WebRTC namespace includes functions that give you access to the input and ou ### checkCameraPermissions -▸ `Const` **checkCameraPermissions**(): `Promise` +- `Const` **checkCameraPermissions**(): `Promise` Asynchronously returns whether we have permissions to access the camera. @@ -31,7 +31,7 @@ await SignalWire.WebRTC.checkCameraPermissions(); ### checkMicrophonePermissions -▸ `Const` **checkMicrophonePermissions**(): `Promise` +- `Const` **checkMicrophonePermissions**(): `Promise` Asynchronously returns whether we have permissions to access the microphone. @@ -50,7 +50,7 @@ await SignalWire.WebRTC.checkMicrophonePermissions(); ### checkPermissions -▸ `Const` **checkPermissions**(`name?`): `Promise` +- `Const` **checkPermissions**(`name?`): `Promise` Asynchronously returns whether we have permissions to access the specified resource. Some common parameter values for `name` are `"camera"`, `"microphone"`, and `"speaker"`. In those cases, prefer the dedicated methods @@ -77,7 +77,7 @@ await SignalWire.WebRTC.checkPermissions("camera"); ### checkSpeakerPermissions -▸ `Const` **checkSpeakerPermissions**(): `Promise` +- `Const` **checkSpeakerPermissions**(): `Promise` Asynchronously returns whether we have permissions to access the speakers. @@ -96,7 +96,7 @@ await SignalWire.WebRTC.checkSpeakerPermissions(); ### createCameraDeviceWatcher -▸ `Const` **createCameraDeviceWatcher**(): `Promise>` +- `Const` **createCameraDeviceWatcher**(): `Promise>` Asynchronously returns an event emitter that notifies changes in all camera devices. This is equivalent to calling `createDeviceWatcher({ targets: ['camera'] })`, so refer to @@ -110,7 +110,7 @@ Asynchronously returns an event emitter that notifies changes in all camera devi ### createDeviceWatcher -▸ `Const` **createDeviceWatcher**(`options?`): `Promise>` +- `Const` **createDeviceWatcher**(`options?`): `Promise>` Asynchronously returns an event emitter that notifies changes in the devices. The possible events are: @@ -162,7 +162,7 @@ h.on("changed", (c) => console.log(c)); ### createMicrophoneAnalyzer -▸ `Const` **createMicrophoneAnalyzer**(`options`): `Promise` +- `Const` **createMicrophoneAnalyzer**(`options`): `Promise` Initializes a microphone analyzer. You can use a MicrophoneAnalyzer to track the input audio volume. @@ -207,7 +207,7 @@ micAnalyzer.destroy(); ### createMicrophoneDeviceWatcher -▸ `Const` **createMicrophoneDeviceWatcher**(): `Promise>` +- `Const` **createMicrophoneDeviceWatcher**(): `Promise>` Asynchronously returns an event emitter that notifies changes in all microphone devices. This is equivalent to calling `createDeviceWatcher({ targets: ['microphone'] })`, so refer to @@ -221,7 +221,7 @@ Asynchronously returns an event emitter that notifies changes in all microphone ### createSpeakerDeviceWatcher -▸ `Const` **createSpeakerDeviceWatcher**(): `Promise>` +- `Const` **createSpeakerDeviceWatcher**(): `Promise>` Asynchronously returns an event emitter that notifies changes in all speaker devices. This is equivalent to calling `createDeviceWatcher({ targets: ['speaker'] })`, so refer to @@ -235,7 +235,7 @@ Asynchronously returns an event emitter that notifies changes in all speaker dev ### enumerateDevices -▸ `Const` **enumerateDevices**(): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. +- `Const` **enumerateDevices**(): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. Enumerates the media input and output devices available on this device. @@ -267,7 +267,7 @@ await SignalWire.WebRTC.enumerateDevices(); ### getCameraDevices -▸ `Const` **getCameraDevices**(): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. +- `Const` **getCameraDevices**(): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. Returns an array of camera devices that can be accessed on this device (for which we have permissions). @@ -293,7 +293,7 @@ await SignalWire.WebRTC.getCameraDevices(); ### getCameraDevicesWithPermissions -▸ `Const` **getCameraDevicesWithPermissions**(): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. +- `Const` **getCameraDevicesWithPermissions**(): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. > ⚠️ Deprecated. > Use [getCameraDevices](#getcameradevices) for better cross browser compatibility. @@ -322,7 +322,7 @@ await SignalWire.WebRTC.getCameraDevicesWithPermissions(); ### getDevices -▸ `Const` **getDevices**(`name?`, `fullList?`): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. +- `Const` **getDevices**(`name?`, `fullList?`): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. Enumerates the media input and output devices available on this machine. If `name` is provided, only the devices of the specified kind are returned. @@ -359,7 +359,7 @@ await SignalWire.WebRTC.getDevices("camera", true); ### getDevicesWithPermissions -▸ `Const` **getDevicesWithPermissions**(`kind?`, `fullList?`): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. +- `Const` **getDevicesWithPermissions**(`kind?`, `fullList?`): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. > ⚠️ Deprecated. > Use [getDevices](#getdevices) for better cross browser compatibility. @@ -395,7 +395,7 @@ await SignalWire.WebRTC.getDevicesWithPermissions("camera"); ### getDisplayMedia -▸ `Const` **getDisplayMedia**(`constraints?`): `Promise` - See [MediaStream](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream) for more details. +- `Const` **getDisplayMedia**(`constraints?`): `Promise` - See [MediaStream](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream) for more details. Prompts the user to share the screen and asynchronously returns a [MediaStream](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream) object associated with a display or part of it. @@ -419,7 +419,7 @@ await SignalWire.WebRTC.getDisplayMedia(); // MediaStream {id: "HCXy...", active ### getMicrophoneDevices -▸ `Const` **getMicrophoneDevices**(): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. +- `Const` **getMicrophoneDevices**(): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. Returns an array of microphone devices that can be accessed on this device (for which we have permissions). @@ -445,7 +445,7 @@ await SignalWire.WebRTC.getMicrophoneDevices(); ### getMicrophoneDevicesWithPermissions -▸ `Const` **getMicrophoneDevicesWithPermissions**(): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. +- `Const` **getMicrophoneDevicesWithPermissions**(): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. > ⚠️ Deprecated. > Use [getMicrophoneDevices](#getmicrophonedevices) for better cross browser compatibility. @@ -474,7 +474,7 @@ await SignalWire.WebRTC.getMicrophoneDevicesWithPermissions(); ### getSpeakerDevices -▸ `Const` **getSpeakerDevices**(): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. +- `Const` **getSpeakerDevices**(): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. Returns an array of speaker devices that can be accessed on this device (for which we have permissions). @@ -500,7 +500,7 @@ await SignalWire.WebRTC.getSpeakerDevices(); ### getSpeakerDevicesWithPermissions -▸ `Const` **getSpeakerDevicesWithPermissions**(): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. +- `Const` **getSpeakerDevicesWithPermissions**(): `Promise` - See [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/mediadeviceinfo) for more details. > ⚠️ Deprecated. > Use [getSpeakerDevices](#getspeakerdevices) for better cross browser compatibility. @@ -529,7 +529,7 @@ await SignalWire.WebRTC.getSpeakerDevicesWithPermissions(); ### getSupportedConstraints -▸ `Const` **getSupportedConstraints**(): `MediaTrackSupportedConstraints` +- `Const` **getSupportedConstraints**(): `MediaTrackSupportedConstraints` Returns a dictionary whose fields specify the constrainable properties the user agent understands. @@ -555,7 +555,7 @@ SignalWire.WebRTC.getSupportedConstraints(); ### getUserMedia -▸ `Const` **getUserMedia**(`constraints?`): `Promise` - See [MediaStream](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream) for more details. +- `Const` **getUserMedia**(`constraints?`): `Promise` - See [MediaStream](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream) for more details. Prompts the user to share one or more media devices and asynchronously returns an associated [MediaStream](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream) object. @@ -598,7 +598,7 @@ await SignalWire.WebRTC.getUserMedia(constraints); ### requestPermissions -▸ `Const` **requestPermissions**(`constraints`): `Promise` +- `Const` **requestPermissions**(`constraints`): `Promise` Prompts the user to grant permissions for the devices matching the specified set of constraints. @@ -637,7 +637,7 @@ await SignalWire.WebRTC.requestPermissions(constraints); ### setMediaElementSinkId -▸ `Const` **setMediaElementSinkId**(`el`, `deviceId`): `Promise` +- `Const` **setMediaElementSinkId**(`el`, `deviceId`): `Promise` Assigns the specified audio output device to the specified HTMLMediaElement. The device with id `deviceId` must be an audio output device. Asynchronously returns whether the operation had success. @@ -669,7 +669,7 @@ await SignalWire.WebRTC.setMediaElementSinkId(el, outDevices[0].deviceId); ### stopStream -▸ `Const` **stopStream**(`stream?`): `void` +- `Const` **stopStream**(`stream?`): `void` Stops all tracks in a specified stream and fires the `ended` event for each. @@ -687,7 +687,7 @@ Stops all tracks in a specified stream and fires the `ended` event for each. ### stopTrack -▸ `Const` **stopTrack**(`track`): `void` +- `Const` **stopTrack**(`track`): `void` Stops a specified track. This method is similar to [`MediaStreamTrack.stop()`](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack/stop) but this method also fires the `ended` event. @@ -705,7 +705,7 @@ Stops a specified track. This method is similar to [`MediaStreamTrack.stop()`](h ### supportsGetDisplayMedia -▸ `Const` **supportsGetDisplayMedia**(): `boolean` +- `Const` **supportsGetDisplayMedia**(): `boolean` Returns whether the current environment supports [`getDisplayMedia`](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia). @@ -717,7 +717,7 @@ Returns whether the current environment supports [`getDisplayMedia`](https://dev ### supportsGetUserMedia -▸ `Const` **supportsGetUserMedia**(): `boolean` +- `Const` **supportsGetUserMedia**(): `boolean` Returns whether the current environment supports [`getUserMedia`](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia). @@ -729,7 +729,7 @@ Returns whether the current environment supports [`getUserMedia`](https://develo ### supportsMediaDevices -▸ `Const` **supportsMediaDevices**(): `boolean` +- `Const` **supportsMediaDevices**(): `boolean` Returns whether the current environment supports the media devices API. @@ -741,7 +741,7 @@ Returns whether the current environment supports the media devices API. ### supportsMediaOutput -▸ `Const` **supportsMediaOutput**(): `boolean` +- `Const` **supportsMediaOutput**(): `boolean` Returns whether the current environment supports the selection of a media output device. diff --git a/website/docs/main/compatibility-api/guides/voice/nodejs/realtime-streaming-to-openai/index.mdx b/website/docs/main/compatibility-api/guides/voice/nodejs/realtime-streaming-to-openai/index.mdx index 409b4310d..27d632049 100644 --- a/website/docs/main/compatibility-api/guides/voice/nodejs/realtime-streaming-to-openai/index.mdx +++ b/website/docs/main/compatibility-api/guides/voice/nodejs/realtime-streaming-to-openai/index.mdx @@ -740,12 +740,12 @@ Refer to this table if you encounter issues running the application. | Issue | Cause | Solution | |-------|-------|----------| -| No audio from AI | Codec mismatch or incorrect codec configuration | • Check `AUDIO_FORMAT` environment variable
• Verify SignalWire and application codec match | -| Invalid AUDIO_FORMAT error | Invalid environment variable value | • Verify `AUDIO_FORMAT` is either `g711_ulaw` or `pcm16`
• Check for typos or extra whitespace
• Remove the variable to use default (`g711_ulaw`) | -| Server fails to start | Port 5050 already in use | • Check what's running on port 5050: `lsof -i :5050`
• Stop the conflicting application or use a different port with `PORT=5051 npm start` | -| Health check failing | Server crashed or not responding | • Check server logs for error messages
• Verify all configuration is correct
• Try accessing `/health` endpoint directly in browser | -| Missing OPENAI_API_KEY | Configuration error | • Verify `OPENAI_API_KEY` in `.env` file (local)
• Verify Docker secrets are configured (Docker) | -| Calls not connecting after ngrok restart | ngrok URL changed | • ngrok generates a new URL each time you restart
• Update the webhook URL in SignalWire Dashboard with the new ngrok URL
• Restart ngrok and update SignalWire before testing | +| No audio from AI | Codec mismatch or incorrect codec configuration | - Check `AUDIO_FORMAT` environment variable
- Verify SignalWire and application codec match | +| Invalid AUDIO_FORMAT error | Invalid environment variable value | - Verify `AUDIO_FORMAT` is either `g711_ulaw` or `pcm16`
- Check for typos or extra whitespace
- Remove the variable to use default (`g711_ulaw`) | +| Server fails to start | Port 5050 already in use | - Check what's running on port 5050: `lsof -i :5050`
- Stop the conflicting application or use a different port with `PORT=5051 npm start` | +| Health check failing | Server crashed or not responding | - Check server logs for error messages
- Verify all configuration is correct
- Try accessing `/health` endpoint directly in browser | +| Missing OPENAI_API_KEY | Configuration error | - Verify `OPENAI_API_KEY` in `.env` file (local)
- Verify Docker secrets are configured (Docker) | +| Calls not connecting after ngrok restart | ngrok URL changed | - ngrok generates a new URL each time you restart
- Update the webhook URL in SignalWire Dashboard with the new ngrok URL
- Restart ngrok and update SignalWire before testing | ## Resources diff --git a/website/docs/main/home/calling/ai/get-started/capabilities/_mermaid/traditional-ivr-flow.mdx b/website/docs/main/home/calling/ai/get-started/capabilities/_mermaid/traditional-ivr-flow.mdx index fcb53dc51..cf69fd2a6 100644 --- a/website/docs/main/home/calling/ai/get-started/capabilities/_mermaid/traditional-ivr-flow.mdx +++ b/website/docs/main/home/calling/ai/get-started/capabilities/_mermaid/traditional-ivr-flow.mdx @@ -32,5 +32,5 @@ sequenceDiagram C->>I: Presses or says "1" Note over I: End Input Collection
Appointment Confirmed I->>C: "Your appointment is scheduled for Tuesday at 9AM with Dr. Smith." - Note over C,I: 9 menu selections • Each question requires new menu • Linear path only • Inflexible conversation + Note over C,I: 9 menu selections - Each question requires new menu - Linear path only - Inflexible conversation ``` \ No newline at end of file diff --git a/website/docs/realtime-sdk/tech-ref/chat/chat-client.mdx b/website/docs/realtime-sdk/tech-ref/chat/chat-client.mdx index 71cccd211..b53b34047 100644 --- a/website/docs/realtime-sdk/tech-ref/chat/chat-client.mdx +++ b/website/docs/realtime-sdk/tech-ref/chat/chat-client.mdx @@ -39,7 +39,7 @@ const chatClient = client.chat; ### getMemberState -▸ **getMemberState**(`params`): `Promise<\{ channels: Record \}>` +- **getMemberState**(`params`): `Promise<\{ channels: Record \}>` Returns the states of a member in the specified channels. @@ -89,7 +89,7 @@ console.log(`The state of ${usesId} is: ${JSON.stringify(s.channels.channel1.sta ### getMembers -▸ **getMembers**(`params`): `Promise<{ members: ChatMemberEntity[] }>` +- **getMembers**(`params`): `Promise<{ members: ChatMemberEntity[] }>` Returns the list of members in the given channel. @@ -130,7 +130,7 @@ The list of members are: ${m.members.map(m => m.id).join(", ")}`); ### getMessages -▸ **getMessages**(`params`): `Promise<{ cursor: PaginationCursor, messages: ChatMessageEntity[] }>` +- **getMessages**(`params`): `Promise<{ cursor: PaginationCursor, messages: ChatMessageEntity[] }>` Returns the list of messages that were sent to the specified channel. @@ -193,7 +193,7 @@ while (true) { ### listen -▸ **listen**(`{ event: Callback }`): `Promise` +- **listen**(`{ event: Callback }`): `Promise` Listen for events on the specified channels. @@ -241,7 +241,7 @@ await chatClient.listen({ ### publish -▸ **publish**(`params`): `Promise` +- **publish**(`params`): `Promise` Publish a message into the specified channel. @@ -306,7 +306,7 @@ await chatClient.publish({ ### setMemberState -▸ **setMemberState**(`params`): `Promise` +- **setMemberState**(`params`): `Promise` Sets a state object for a member, for the specified channels. The previous state object will be completely replaced. @@ -373,7 +373,7 @@ console.log(`The state of ${usesId} is: ${JSON.stringify(s.channels.channel1.sta ### onMemberJoined -• **client.chat.listen**(`{ onMemberJoined: Callback }`) +- **client.chat.listen**(`{ onMemberJoined: Callback }`) Emitted when a new member joins the chat. Your event handler will be called with an instance of [`ChatMember`][chatmember]. @@ -385,7 +385,7 @@ Emitted when a new member joins the chat. Your event handler will be called with ### onMemberLeft -• **client.chat.listen**(`{ onMemberLeft: Callback }`) +- **client.chat.listen**(`{ onMemberLeft: Callback }`) Emitted when a member leaves the chat. Your event handler will be called with an instance of [`ChatMember`][chatmember]. @@ -397,7 +397,7 @@ Emitted when a member leaves the chat. Your event handler will be called with an ### onMemberUpdated -• **client.chat.listen**(`{ onMemberUpdated: Callback }`) +- **client.chat.listen**(`{ onMemberUpdated: Callback }`) Emitted when a member updates its state. Your event handler will be called with an instance of [`ChatMember`][chatmember]. @@ -409,7 +409,7 @@ Emitted when a member updates its state. Your event handler will be called with ### onMessageReceived -• **client.chat.listen**(`{ onMessageReceived: Callback}`) +- **client.chat.listen**(`{ onMessageReceived: Callback}`) Emitted when a message is received. Your event handler will be called with an instance of [`ChatMessage`][chatmessage]. @@ -427,15 +427,15 @@ An object representing a Chat Member with only the state properties of [`ChatMem #### Properties -• `Readonly` **channel**: `string` +- `Readonly` **channel**: `string` The channel of this member. -• `Readonly` **id**: `string` +- `Readonly` **id**: `string` The id of this member. -• `Readonly` **state**: `Record` +- `Readonly` **state**: `Record` The state of this member. @@ -447,23 +447,23 @@ An object representing a Chat Message with only the state properties of [`ChatMe #### Properties -• `Readonly` **content**: `any` +- `Readonly` **content**: `any` The content of this message. -• `Readonly` **id**: `string` +- `Readonly` **id**: `string` The id. of this message -• `Readonly` **member**: [`ChatMember`][chatmember] +- `Readonly` **member**: [`ChatMember`][chatmember] The member which sent this message. -• `Readonly` **meta?**: `any` +- `Readonly` **meta?**: `any` Any metadata associated with this message. -• `Readonly` **publishedAt**: `Date` +- `Readonly` **publishedAt**: `Date` The date and time at which this message was published. @@ -476,11 +476,11 @@ It is specifically used in conjunction with the [getMessages][getmessages] metho #### Properties -• `Readonly` **after?**: `string` +- `Readonly` **after?**: `string` This property signifies the cursor for the subsequent page. -• `Readonly` **before?**: `string` +- `Readonly` **before?**: `string` This property signifies the cursor for the preceding page. diff --git a/website/docs/realtime-sdk/tech-ref/messaging/messaging-client.mdx b/website/docs/realtime-sdk/tech-ref/messaging/messaging-client.mdx index 079f25bb9..561d0abd2 100644 --- a/website/docs/realtime-sdk/tech-ref/messaging/messaging-client.mdx +++ b/website/docs/realtime-sdk/tech-ref/messaging/messaging-client.mdx @@ -34,7 +34,7 @@ This example demonstrates how to set up a messaging client using the SignalWire ### listen -▸ **listen**(`{ event: Callback }`): `Promise` +- **listen**(`{ event: Callback }`): `Promise` Listens for message events. @@ -79,7 +79,7 @@ await client.messaging.listen({ ### send -▸ **send**(`params`): `Promise` +- **send**(`params`): `Promise` Send an outbound SMS or MMS message. @@ -152,7 +152,7 @@ try { ### onMessageReceived -• **client.messaging.listen**(`{onMessageReceived: Callback}`) +- **client.messaging.listen**(`{onMessageReceived: Callback}`) Emitted whenever a message is received. Your event handler will be called with an instance of [`MessageContract`][messagecontract]. @@ -164,7 +164,7 @@ Emitted whenever a message is received. Your event handler will be called with a ### onMessageUpdated -• **client.messaging.listen**(`{onMessageUpdated: Callback}`) +- **client.messaging.listen**(`{onMessageUpdated: Callback}`) Emitted when the status of a message is updated. You can use this event to track the different stages that an outbound message goes through for delivery. Your event handler will be called with an instance of [`MessageContract`][messagecontract]. diff --git a/website/docs/realtime-sdk/tech-ref/pubsub/pubsub-client.mdx b/website/docs/realtime-sdk/tech-ref/pubsub/pubsub-client.mdx index 40e43c144..b58354ac8 100644 --- a/website/docs/realtime-sdk/tech-ref/pubsub/pubsub-client.mdx +++ b/website/docs/realtime-sdk/tech-ref/pubsub/pubsub-client.mdx @@ -31,7 +31,7 @@ const pubSubClient = client.pubSub; ### listen -▸ **listen**(`{ event: Callback }`): `Promise` +- **listen**(`{ event: Callback }`): `Promise` Listen for events on the specified channel. @@ -82,7 +82,7 @@ In this example: ### publish -▸ **publish**(`params`): `Promise` +- **publish**(`params`): `Promise` Publish a message into the specified channel. @@ -149,7 +149,7 @@ await pubSubClient.publish({ ### onMessageReceived -• **client.pubSub.listen**(`{ onMessageReceived: Callback }`) +- **client.pubSub.listen**(`{ onMessageReceived: Callback }`) Emitted when a message is received on a channel. Your event handler will be called with an instance of [`PubSubMessage`][pubsubmessage]. diff --git a/website/docs/realtime-sdk/tech-ref/realtime-client/index.mdx b/website/docs/realtime-sdk/tech-ref/realtime-client/index.mdx index 9e9427b1e..76bd276eb 100644 --- a/website/docs/realtime-sdk/tech-ref/realtime-client/index.mdx +++ b/website/docs/realtime-sdk/tech-ref/realtime-client/index.mdx @@ -20,7 +20,7 @@ It provides methods to connect to the Realtime service, authenticate, and subscr ## **Constructor** -▸ **SignalWire(`options`)**: `Promise` +- **SignalWire(`options`)**: `Promise` Create a new Client instance. @@ -68,7 +68,7 @@ const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" ### connect -▸ **connect()**: `Promise` +- **connect()**: `Promise` :::note The client will automatically connect when it is created. You only need to call this method if you have previously [`disconnected`][link]. @@ -92,7 +92,7 @@ await client.connect().then(() => { ### disconnect -▸ **disconnect()**: `Promise` +- **disconnect()**: `Promise` Disconnects this client. The client will stop receiving events and you will need to create a new instance if you want to use it again. diff --git a/website/docs/realtime-sdk/tech-ref/task/task-client.mdx b/website/docs/realtime-sdk/tech-ref/task/task-client.mdx index b4cba558e..e7e536850 100644 --- a/website/docs/realtime-sdk/tech-ref/task/task-client.mdx +++ b/website/docs/realtime-sdk/tech-ref/task/task-client.mdx @@ -34,7 +34,7 @@ const taskClient = client.task ### listen -▸ **listen**(`{ event: Callback }`): `Promise` +- **listen**(`{ event: Callback }`): `Promise` Listens for incoming tasks. @@ -79,7 +79,7 @@ await taskClient.listen({ ### send -▸ `Const` **send**(`params`): `Promise` +- `Const` **send**(`params`): `Promise` Send a job to your Task Client in a specific topic. @@ -138,7 +138,7 @@ const taskSend = await clientTask.send({ ### onTaskReceived -• **client.task.listen**(`{ onTaskReceived: Callback }`) +- **client.task.listen**(`{ onTaskReceived: Callback }`) Emitted whenever a task is received. Your event handler receives the payload. diff --git a/website/docs/realtime-sdk/tech-ref/video/video-client.mdx b/website/docs/realtime-sdk/tech-ref/video/video-client.mdx index b66dc636e..c3e716728 100644 --- a/website/docs/realtime-sdk/tech-ref/video/video-client.mdx +++ b/website/docs/realtime-sdk/tech-ref/video/video-client.mdx @@ -34,7 +34,7 @@ const videoClient = client.video; ### getRoomSessions -▸ **getRoomSessions**(): `Promise<{ roomSessions: RoomSession[] }>` +- **getRoomSessions**(): `Promise<{ roomSessions: RoomSession[] }>` Returns the currently active room sessions. @@ -66,7 +66,7 @@ console.log(roomSessions.forEach(room => console.log(room.name))); ### getRoomSessionById -▸ **getRoomSessionById**(`id`): `Promise<{ roomSession: RoomSession }>` +- **getRoomSessionById**(`id`): `Promise<{ roomSession: RoomSession }>` Returns a room session given its id. Only in-progress room sessions are currently returned. @@ -107,7 +107,7 @@ that can be used to access the room session's information and methods. ### listen -▸ **listen**(`{ event: Callback }`): `Promise` +- **listen**(`{ event: Callback }`): `Promise` Listens to events on the `video` client. You can use this method to listen to any of the events listed in the [`Events`][events] section. @@ -155,7 +155,7 @@ await videoClient.listen({ ### onRoomEnded -• **client.video.listen**(`{ onRoomEnded: Callback }`) +- **client.video.listen**(`{ onRoomEnded: Callback }`) Emitted when a room session ends. Your event handler receives an object which is an instance of [`RoomSessionFullState`][roomsessionfullstate]. @@ -168,7 +168,7 @@ of [`RoomSessionFullState`][roomsessionfullstate]. ### onRoomStarted -• **client.video.listen**( `{ onRoomStarted: Callback }`) +- **client.video.listen**( `{ onRoomStarted: Callback }`) Emitted when a room session is started. Your event handler receives an object which is an instance of [`RoomSessionFullState`][roomsessionfullstate]. diff --git a/website/docs/realtime-sdk/tech-ref/video/video-roomsession.mdx b/website/docs/realtime-sdk/tech-ref/video/video-roomsession.mdx index eef2517b8..3f08a2a63 100644 --- a/website/docs/realtime-sdk/tech-ref/video/video-roomsession.mdx +++ b/website/docs/realtime-sdk/tech-ref/video/video-roomsession.mdx @@ -10,7 +10,7 @@ sidebar_label: RoomSession ### onMemberTalkingEnded -• **RoomSession.listen**(`{ onMemberTalkingEnded: Callback }` +- **RoomSession.listen**(`{ onMemberTalkingEnded: Callback }` [roomsessionmember-28]: ./video-roomsessionmember.md [roomsessionmember-29]: ./video-roomsessionmember.md | @@ -18,7 +18,7 @@ sidebar_label: RoomSession ### onPlaybackStarted -• **RoomSession.listen**(`{ onPlaybackStarted: Callback }` +- **RoomSession.listen**(`{ onPlaybackStarted: Callback }` [roomsessionmembers]: ./video-roomsessionmember.md [roomsessionplayback-12]: ./video-roomsessionplayback.md @@ -115,7 +115,7 @@ await videoClient.listen({ ### audioMute -▸ **audioMute**(`params`): `Promise` +- **audioMute**(`params`): `Promise` Mutes the audio of a given member for all other participants. @@ -172,7 +172,7 @@ await videoClient.listen({ ### audioUnmute -▸ **audioUnmute**(`params`): `Promise` +- **audioUnmute**(`params`): `Promise` Unmutes the microphone of a given member if it had been previously muted. @@ -234,7 +234,7 @@ await videoClient.listen({ ### deaf -▸ **deaf**(`params`): `Promise` +- **deaf**(`params`): `Promise` Mutes the incoming audio for a given member. The affected participant will not hear audio from the other participants anymore. @@ -290,7 +290,7 @@ await videoClient.listen({ ### deleteMemberMeta -▸ **deleteMemberMeta**(`params`): `Promise` +- **deleteMemberMeta**(`params`): `Promise` Deletes the specified keys from the metadata for the specified member. @@ -374,7 +374,7 @@ await videoClient.listen({ ### deleteMeta -▸ **deleteMeta**(`keys`): `Promise` +- **deleteMeta**(`keys`): `Promise` Deletes the specified keys from the metadata for this RoomSession. @@ -435,7 +435,7 @@ await videoClient.listen({ ### demote -▸ **demote**(`params`): `Promise` +- **demote**(`params`): `Promise` Demotes a participant from "member" to "audience". See [promote][link]. @@ -496,7 +496,7 @@ await videoClient.listen({ ### getLayouts -▸ **getLayouts**(): `Promise<\{ layouts: string[] \}>` +- **getLayouts**(): `Promise<\{ layouts: string[] \}>` Returns a list of available layouts for the room. To set a room layout, use [`setLayout`][video-roomsession-2]. @@ -535,7 +535,7 @@ await videoClient.listen({ ### getMembers -▸ **getMembers**(): `Promise`\<\{ `members:` [`RoomSessionMember[]`](./video-roomsessionmember.md) }> +- **getMembers**(): `Promise`\<\{ `members:` [`RoomSessionMember[]`](./video-roomsessionmember.md) }> Returns a list of members currently in the room. @@ -577,7 +577,7 @@ await videoClient.listen({ ### getMemberMeta -▸ **getMemberMeta**(): `Promise`\<\{ `meta:` [`RoomSessionMember.meta`][video-roomsessionmember] }> +- **getMemberMeta**(): `Promise`\<\{ `meta:` [`RoomSessionMember.meta`][video-roomsessionmember] }> Returns the metadata assigned to the specified member. @@ -639,7 +639,7 @@ await videoClient.listen({ ### getMeta -▸ **getMeta**(): `Promise`\<\{ `meta:` [`RoomSession.meta`][link-1] }> +- **getMeta**(): `Promise`\<\{ `meta:` [`RoomSession.meta`][link-1] }> Returns the metadata assigned to this Room Session. @@ -690,7 +690,7 @@ await videoClient.listen({ ### getPlaybacks -▸ **getPlaybacks**(): `Promise`\<\{ `playbacks:` [`RoomSessionPlayback`][roomsessionplayback-12] }> +- **getPlaybacks**(): `Promise`\<\{ `playbacks:` [`RoomSessionPlayback`][roomsessionplayback-12] }> Obtains a list of playbacks for the current room session. @@ -760,7 +760,7 @@ await videoClient.listen({ ### getRecordings -▸ **getRecordings**(): `Promise`\<\{ `recordings:` [`RoomSessionRecording`][roomsessionrecording-12] }> +- **getRecordings**(): `Promise`\<\{ `recordings:` [`RoomSessionRecording`][roomsessionrecording-12] }> Obtains a list of recordings for the current room session. @@ -840,7 +840,7 @@ await videoClient.listen({ ### getStreams -▸ **getStreams**(): `Promise<\{ streams: RoomSessionStream \}>` +- **getStreams**(): `Promise<\{ streams: RoomSessionStream \}>` Obtains a list of active streams for this RoomSession. These are RTMP streams of the audio/video content of this room, which will be sent to an external party @@ -909,7 +909,7 @@ await videoClient.listen({ ### listen -▸ **listen**(`{ event: Callback }`): `Promise`\<[`RoomSession Events`][link-2]> +- **listen**(`{ event: Callback }`): `Promise`\<[`RoomSession Events`][link-2]> Enables listening for events on this room session. @@ -959,7 +959,7 @@ await videoClient.listen({ ### lock -▸ **lock**(`params`): `Promise` +- **lock**(`params`): `Promise` Locks the room. This prevents new participants from joining the room. @@ -993,7 +993,7 @@ await videoClient.listen({ ### play -▸ **play**(`params`): `Promise`\<[`RoomSessionPlayback`][roomsessionplayback-12]> +- **play**(`params`): `Promise`\<[`RoomSessionPlayback`][roomsessionplayback-12]> Start a playback in the room. You can use the returned [RoomSessionPlayback][roomsessionplayback-4] object to control the playback (e.g., pause, resume, setVolume and stop). @@ -1084,7 +1084,7 @@ await videoClient.listen({ ### promote -▸ **promote**(`params`): `Promise` +- **promote**(`params`): `Promise` Promotes a participant from "audience" to "member". See [demote][link-3]. @@ -1180,7 +1180,7 @@ await videoClient.listen({ ### removeAllMembers -▸ **removeAllMembers**(): `Promise` +- **removeAllMembers**(): `Promise` Removes all the members from this room session. The room session will end. @@ -1221,7 +1221,7 @@ await videoClient.listen({ ### removeMember -▸ **removeMember**(`params`): `Promise` +- **removeMember**(`params`): `Promise` Removes a specific participant from the room. @@ -1282,7 +1282,7 @@ await videoClient.listen({ ### setHideVideoMuted -▸ **setHideVideoMuted**(`value`): `Promise` +- **setHideVideoMuted**(`value`): `Promise` Show or hide muted videos in the room layout. Members that have been muted via [`videoMute`][video-roomsession-3] will not appear in the video stream, instead of appearing as a mute image, if this setting is enabled. @@ -1335,7 +1335,7 @@ await videoClient.listen({ ### setInputSensitivity -▸ **setInputSensitivity**(`params`): `Promise` +- **setInputSensitivity**(`params`): `Promise` Sets the input level at which the participant is identified as currently speaking. @@ -1400,7 +1400,7 @@ await videoClient.listen({ ### setInputVolume -▸ **setInputVolume**(`params`): `Promise` +- **setInputVolume**(`params`): `Promise` Sets the input volume for a given member (e.g., the microphone input level). @@ -1463,7 +1463,7 @@ await videoClient.listen({ ### setLayout -▸ **setLayout**(`params`): `Promise` +- **setLayout**(`params`): `Promise` Sets a layout for the room. You can obtain a list of available layouts with [`getLayouts`][video-roomsession-4]. @@ -1524,7 +1524,7 @@ await videoClient.listen({ ### setMemberMeta -▸ **setMemberMeta**(`params`): `Promise` +- **setMemberMeta**(`params`): `Promise` Assigns custom metadata to the specified [`RoomSessionMember`][roomsessionmember-28]. You can use this to store metadata whose meaning is entirely defined by your application. @@ -1596,7 +1596,7 @@ await videoClient.listen({ ### setMemberPosition -▸ **setMemberPosition**(`params`): `Promise` +- **setMemberPosition**(`params`): `Promise` Assigns a position in the layout to the specified member. @@ -1670,7 +1670,7 @@ await videoClient.listen({ ### setMeta -▸ **setMeta**(`meta`): `Promise` +- **setMeta**(`meta`): `Promise` Assigns custom metadata to the RoomSession. You can use this to store metadata whose meaning is entirely defined by your application. @@ -1728,7 +1728,7 @@ await videoClient.listen({ ### setOutputVolume -▸ **setOutputVolume**(`params`): `Promise` +- **setOutputVolume**(`params`): `Promise` Sets the output volume for the member (e.g., the speaker output level). @@ -1794,7 +1794,7 @@ await videoClient.listen({ ### setPositions -▸ **setPositions**(`params`): `Promise` +- **setPositions**(`params`): `Promise` Assigns a position in the layout for multiple members. @@ -1878,7 +1878,7 @@ await videoClient.listen({ ### setPrioritizeHandraise -▸ **setPrioritizeHandraise**(`param`): `Promise` +- **setPrioritizeHandraise**(`param`): `Promise` Set whether to prioritize hand-raise or not. Users with raised hands will be shown in the main video area over other participants who don't have their hand raised. @@ -1921,7 +1921,7 @@ await videoClient.listen({ ### setRaisedHand -▸ **setRaisedHand**(`params`): `Promise` +- **setRaisedHand**(`params`): `Promise` Sets the raised hand status for the current member. @@ -1981,7 +1981,7 @@ await videoClient.listen({ ### startRecording -▸ **startRecording**(): `Promise`\<[`RoomSessionRecording`][roomsessionrecording-12]> +- **startRecording**(): `Promise`\<[`RoomSessionRecording`][roomsessionrecording-12]> Starts the recording of the room. You can use the returned [RoomSessionRecording][roomsessionrecording-4] object to control the recording (e.g., pause, resume, stop). @@ -2061,7 +2061,7 @@ await videoClient.listen({ ### startStream -▸ **startStream**(): `Promise`\<[`RoomSessionStream`][roomsessionstream-8]> +- **startStream**(): `Promise`\<[`RoomSessionStream`][roomsessionstream-8]> Starts streaming the audio/video of this room to an external service. You can use the returned [`RoomSessionStream`][roomsessionstream-8] object to @@ -2136,7 +2136,7 @@ await videoClient.listen({ ### undeaf -▸ **undeaf**(`params`): `Promise` +- **undeaf**(`params`): `Promise` Unmutes the incoming audio for a given member. The affected participant will start hearing audio from the other participants again. @@ -2201,7 +2201,7 @@ await videoClient.listen({ ### updateMemberMeta -▸ **updateMemberMeta**(`params`): `Promise` +- **updateMemberMeta**(`params`): `Promise` Updates a member's metadata in only the specified fields. This is different from [setMemberMeta][link-5], which replaces the whole metadata object. @@ -2287,7 +2287,7 @@ await videoClient.listen({ ### updateMeta -▸ **updateMeta**(`meta`): `Promise` +- **updateMeta**(`meta`): `Promise` Updates the RoomSession metadata by only setting the specified fields. This is different from [setMeta][link-6], which replaces the whole metadata object. @@ -2353,7 +2353,7 @@ await videoClient.listen({ ### unlock -▸ **unlock**(): `Promise` +- **unlock**(): `Promise` Unlocks the room if it had been previously locked. This allows new participants to join the room. @@ -2403,7 +2403,7 @@ await videoClient.listen({ ### videoMute -▸ **videoMute**(`params`): `Promise` +- **videoMute**(`params`): `Promise` Puts the video of a given member on mute. Participants will see a mute image instead of the video stream. @@ -2463,7 +2463,7 @@ await videoClient.listen({ ### videoUnmute -▸ **videoUnmute**(`params`): `Promise` +- **videoUnmute**(`params`): `Promise` Unmutes the video of a given member if it had been previously muted. Participants will start seeing the video stream again. @@ -2537,7 +2537,7 @@ You can use this object to subscribe to the following events. ### onRoomSubscribed -• **RoomSession.listen**(`{ onRoomSubscribed: Callback }`) +- **RoomSession.listen**(`{ onRoomSubscribed: Callback }`) Emitted when the room session is subscribed too. Your event handler will be called with an instance of the [`RoomSession`][roomsession-41] object. @@ -2550,7 +2550,7 @@ will be called with an instance of the [`RoomSession`][roomsession-41] object. ### onRoomStarted -• **RoomSession.listen**(`{ onRoomStarted: Callback }`) +- **RoomSession.listen**(`{ onRoomStarted: Callback }`) :::tip This event is emitted when the first participant joins the room. @@ -2567,7 +2567,7 @@ Your event handler will be called with an instance of the [`RoomSession`][roomse ### onRoomUpdated -• **RoomSession.listen**(`{ onRoomUpdated: Callback }`) +- **RoomSession.listen**(`{ onRoomUpdated: Callback }`) Emitted when the room session is updated. Your event handler will be called with an instance of the [`RoomSession`][roomsession-41] object. @@ -2580,7 +2580,7 @@ will be called with an instance of the [`RoomSession`][roomsession-41] object. ### onRoomEnded -• **RoomSession.listen**(`{ onRoomEnded: Callback }`) +- **RoomSession.listen**(`{ onRoomEnded: Callback }`) Emitted when the room session is ended. Your event handler will be called with an instance of the [`RoomSession`][roomsession-41] object. @@ -2593,7 +2593,7 @@ will be called with an instance of the [`RoomSession`][roomsession-41] object. ### onRoomAudienceCount -• **RoomSession.listen**(`{ onRoomAudienceCount: Callback }`) +- **RoomSession.listen**(`{ onRoomAudienceCount: Callback }`) Emitted periodically, and when the audience count of the room changes. Your event handler will be called with an instance of the `VideoRoomAudienceCount` object. @@ -2618,7 +2618,7 @@ will be called with an instance of the `VideoRoomAudienceCount` object. ### onLayoutChanged -• **RoomSession.listen**(`{ onLayoutChanged: Callback }`) +- **RoomSession.listen**(`{ onLayoutChanged: Callback }`) Emitted when the layout of the room changes. Your event handler will be called with an instance of the `VideoLayOutChanged` object. @@ -2643,7 +2643,7 @@ will be called with an instance of the `VideoLayOutChanged` object. ### onMemberJoined -• **RoomSession.listen**(`{ onMemberJoined: Callback }`) +- **RoomSession.listen**(`{ onMemberJoined: Callback }`) :::tip This event is only emitted when the room session has already been started. @@ -2661,7 +2661,7 @@ will be called with an instance of the [`RoomSessionMember`][roomsessionmember-2 ### onMemberUpdated -• **RoomSession.listen**(`{ onMemberUpdated: Callback }`) +- **RoomSession.listen**(`{ onMemberUpdated: Callback }`) Emitted when a member in the room is updated. Your event handler will be called with an instance of the [`RoomSessionMember`][roomsessionmember-28] object. @@ -2674,7 +2674,7 @@ will be called with an instance of the [`RoomSessionMember`][roomsessionmember-2 ### onMemberListUpdated -• **RoomSession.listen**(`{ onMemberListUpdated: Callback }`) +- **RoomSession.listen**(`{ onMemberListUpdated: Callback }`) Emitted when the list of members in the room is updated. Your event handler will be called with an instance of the [`RoomSessionMember`][roomsessionmember-28] object. @@ -2687,7 +2687,7 @@ will be called with an instance of the [`RoomSessionMember`][roomsessionmember-2 ### onMemberLeft -• **RoomSession.listen**(`{ onMemberLeft: Callback }`) +- **RoomSession.listen**(`{ onMemberLeft: Callback }`) Emitted when a member leaves the room. Your event handler will be called with an instance of the [`RoomSessionMember`][roomsessionmember-28] object. @@ -2700,7 +2700,7 @@ will be called with an instance of the [`RoomSessionMember`][roomsessionmember-2 ### onMemberDeaf -• **RoomSession.listen**(`{ onMemberDeaf: Callback }`) +- **RoomSession.listen**(`{ onMemberDeaf: Callback }`) Emitted when a member in the room deafens status changes. Your event handler will be called with an instance of the [`RoomSessionMember`][roomsessionmember-28] object. @@ -2713,7 +2713,7 @@ will be called with an instance of the [`RoomSessionMember`][roomsessionmember-2 ### onMemberVisible -• **RoomSession.listen**(`{ onMemberVisible: Callback }`) +- **RoomSession.listen**(`{ onMemberVisible: Callback }`) Emitted when a member in the room visibility changes. Your event handler will be called with an instance of the [`RoomSessionMember`][roomsessionmember-28] object. @@ -2726,7 +2726,7 @@ will be called with an instance of the [`RoomSessionMember`][roomsessionmember-2 ### onMemberAudioMuted -• **RoomSession.listen**(`{ onMemberAudioMuted: Callback }`) +- **RoomSession.listen**(`{ onMemberAudioMuted: Callback }`) Emitted when a member in the room audio state changes. Your event handler will be called with an instance of the [`RoomSessionMember`][roomsessionmember-28] object. @@ -2739,7 +2739,7 @@ will be called with an instance of the [`RoomSessionMember`][roomsessionmember-2 ### onMemberVideoMuted -• **RoomSession.listen**(`{ onMemberVideoMuted: Callback }`) +- **RoomSession.listen**(`{ onMemberVideoMuted: Callback }`) Emitted when a member in the room video state changes. Your event handler will be called with an instance of the [`RoomSessionMember`][roomsessionmember-28] object. @@ -2752,7 +2752,7 @@ will be called with an instance of the [`RoomSessionMember`][roomsessionmember-2 ### onMemberInputVolume -• **RoomSession.listen**(`{ onMemberInputVolume: Callback }`) +- **RoomSession.listen**(`{ onMemberInputVolume: Callback }`) Emitted when a member in the room input volume changes. Your event handler will be called with an instance of the [`RoomSessionMember`][roomsessionmember-28] object. @@ -2765,7 +2765,7 @@ will be called with an instance of the [`RoomSessionMember`][roomsessionmember-2 ### onMemberOutputVolume -• **RoomSession.listen**(`{ onMemberOutputVolume: Callback }`) +- **RoomSession.listen**(`{ onMemberOutputVolume: Callback }`) Emitted when a member in the room output volume changes. Your event handler will be called with an instance of the [`RoomSessionMember`][roomsessionmember-28] object. @@ -2778,7 +2778,7 @@ will be called with an instance of the [`RoomSessionMember`][roomsessionmember-2 ### onMemberInputSensitivity -• **RoomSession.listen**(`{ onMemberInputSensitivity: Callback }`) +- **RoomSession.listen**(`{ onMemberInputSensitivity: Callback }`) Emitted when a member in the room input sensitivity changes. Your event handler will be called with an instance of the [`RoomSessionMember`][roomsessionmember-28] object. @@ -2791,7 +2791,7 @@ will be called with an instance of the [`RoomSessionMember`][roomsessionmember-2 ### onMemberTalking -• **RoomSession.listen**(`{ onMemberTalking: Callback }`) +- **RoomSession.listen**(`{ onMemberTalking: Callback }`) Emitted when a member in the room talking status changes. Your event handler will be called with an instance of the [`RoomSessionMember`][roomsessionmember-28] object. @@ -2804,7 +2804,7 @@ will be called with an instance of the [`RoomSessionMember`][roomsessionmember-2 ### onMemberTalkingStarted -• **RoomSession.listen**(`{ onMemberTalkingStarted: Callback }`) +- **RoomSession.listen**(`{ onMemberTalkingStarted: Callback }`) Emitted when a member in the room starts talking. Your event handler will be called with an instance of the [`RoomSessionMember`][roomsessionmember-28] object. @@ -2843,7 +2843,7 @@ will be called with an instance of the [`RoomSessionPlayback`][roomsessionplayba ### onPlaybackUpdated -• **RoomSession.listen**(`{ onPlaybackUpdated: Callback }`) +- **RoomSession.listen**(`{ onPlaybackUpdated: Callback }`) Emitted when a playback in the room is updated. Your event handler will be called with an instance of the [`RoomSessionPlayback`][roomsessionplayback-12] object. @@ -2856,7 +2856,7 @@ will be called with an instance of the [`RoomSessionPlayback`][roomsessionplayba ### onPlaybackEnded -• **RoomSession.listen**(`{ onPlaybackEnded: Callback }`) +- **RoomSession.listen**(`{ onPlaybackEnded: Callback }`) Emitted when a playback in the room ends. Your event handler will be called with an instance of the [`RoomSessionPlayback`][roomsessionplayback-12] object. @@ -2869,7 +2869,7 @@ will be called with an instance of the [`RoomSessionPlayback`][roomsessionplayba ### onRecordingStarted -• **RoomSession.listen**(`{ onRecordingStarted: Callback }`) +- **RoomSession.listen**(`{ onRecordingStarted: Callback }`) Emitted when a recording starts in the room. Your event handler will be called with an instance of the [`RoomSessionRecording`][roomsessionrecording-12] object. @@ -2882,7 +2882,7 @@ will be called with an instance of the [`RoomSessionRecording`][roomsessionrecor ### onRecordingUpdated -• **RoomSession.listen**(`{ onRecordingUpdated: Callback }`) +- **RoomSession.listen**(`{ onRecordingUpdated: Callback }`) Emitted when a recording in the room is updated. Your event handler will be called with an instance of the [`RoomSessionRecording`][roomsessionrecording-12] object. @@ -2895,7 +2895,7 @@ will be called with an instance of the [`RoomSessionRecording`][roomsessionrecor ### onRecordingEnded -• **RoomSession.listen**(`{ onRecordingEnded: Callback }`) +- **RoomSession.listen**(`{ onRecordingEnded: Callback }`) Emitted when a recording in the room ends. Your event handler will be called with an instance of the [`RoomSessionRecording`][roomsessionrecording-12] object. @@ -2908,7 +2908,7 @@ will be called with an instance of the [`RoomSessionRecording`][roomsessionrecor ### onStreamEnded -• **RoomSession.listen**(`{ onStreamEnded: Callback }`) +- **RoomSession.listen**(`{ onStreamEnded: Callback }`) Emitted when a stream in the room ends. Your event handler will be called with an instance of the [`RoomSessionStream`][roomsessionstream-8] object. @@ -2921,7 +2921,7 @@ will be called with an instance of the [`RoomSessionStream`][roomsessionstream-8 ### onStreamStarted -• **RoomSession.listen**(`{ onStreamStarted: Callback }`) +- **RoomSession.listen**(`{ onStreamStarted: Callback }`) Emitted when a stream starts in the room. Your event handler will be called with an instance of the [`RoomSessionStream`][roomsessionstream-8] object. diff --git a/website/docs/realtime-sdk/tech-ref/video/video-roomsessionstream.mdx b/website/docs/realtime-sdk/tech-ref/video/video-roomsessionstream.mdx index a3d7e0185..1ce0e03b5 100644 --- a/website/docs/realtime-sdk/tech-ref/video/video-roomsessionstream.mdx +++ b/website/docs/realtime-sdk/tech-ref/video/video-roomsessionstream.mdx @@ -56,7 +56,7 @@ You can start a stream with [RoomSession.startStream][video-roomsession]. ### stop -▸ **stop**(): `Promise` +- **stop**(): `Promise` Stops the stream. @@ -113,7 +113,7 @@ await videoClient.listen({ ### onStarted -▸ **RoomSessionStream**(`{ listen: {onStarted: Callback }}`) +- **RoomSessionStream**(`{ listen: {onStarted: Callback }}`) Emitted when the stream has started. @@ -125,7 +125,7 @@ Emitted when the stream has started. ### onEnded -▸ **RoomSessionStream**(`{ listen: {onEnded: Callback } }`) +- **RoomSessionStream**(`{ listen: {onEnded: Callback } }`) Emitted when the stream has ended. diff --git a/website/docs/realtime-sdk/tech-ref/voice/callcollect.mdx b/website/docs/realtime-sdk/tech-ref/voice/callcollect.mdx index 584cde91b..1928d0f46 100644 --- a/website/docs/realtime-sdk/tech-ref/voice/callcollect.mdx +++ b/website/docs/realtime-sdk/tech-ref/voice/callcollect.mdx @@ -120,7 +120,7 @@ await call.collect({ ### ended -▸ **ended**(): `Promise`\<[`CallCollect`][callcollect]> +- **ended**(): `Promise`\<[`CallCollect`][callcollect]> Returns a promise that is resolved only after this collect finishes (or is stopped). @@ -149,7 +149,7 @@ await collect.ended(); ### startInputTimers -▸ **startInputTimers**(): `Promise`\<[`CallCollect`][callcollect]> +- **startInputTimers**(): `Promise`\<[`CallCollect`][callcollect]> Start the `initialTimeout` timer on an active collect. @@ -180,7 +180,7 @@ await collect.startInputTimers(); ### stop -▸ **stop**(): `Promise`\<[`CallCollect`][callcollect]> +- **stop**(): `Promise`\<[`CallCollect`][callcollect]> Stops the collect session. @@ -306,7 +306,7 @@ The result of a collect session when [`type`][type] is `"error"`. ### onStarted -▸ **CallCollect.listen**(`{ onStarted: Callback }`) +- **CallCollect.listen**(`{ onStarted: Callback }`) Emitted when the collect session is started. Your event handler will receive the [`CallCollect`][callcollect] object. @@ -318,7 +318,7 @@ Emitted when the collect session is started. Your event handler will receive the ### onInputStarted -▸ **CallCollect.listen**(`{ onInputStarted: Callback }`) +- **CallCollect.listen**(`{ onInputStarted: Callback }`) Emitted when the collect session starts receiving input. Your event handler will receive the [`CallCollect`][callcollect] object. @@ -330,7 +330,7 @@ Emitted when the collect session starts receiving input. Your event handler will ### onUpdated -▸ **CallCollect.listen**(`{ onUpdated: Callback }`) +- **CallCollect.listen**(`{ onUpdated: Callback }`) Emitted when the collect session is updated. Your event handler will receive the [`CallCollect`][callcollect] object. @@ -342,7 +342,7 @@ Emitted when the collect session is updated. Your event handler will receive the ### onFailed -▸ **CallCollect.listen**(`{ onFailed: Callback }`) +- **CallCollect.listen**(`{ onFailed: Callback }`) Emitted when the collect session fails. Your event handler will receive the [`CallCollect`][callcollect] object. @@ -354,7 +354,7 @@ Emitted when the collect session fails. Your event handler will receive the [`Ca ### onEnded -▸ **CallCollect.listen**(`{ onEnded: Callback }`) +- **CallCollect.listen**(`{ onEnded: Callback }`) Emitted when the collect session ends. Your event handler will receive the [`CallCollect`][callcollect] object. diff --git a/website/docs/realtime-sdk/tech-ref/voice/calldetect.mdx b/website/docs/realtime-sdk/tech-ref/voice/calldetect.mdx index b5180bcf8..00a7b3d0f 100644 --- a/website/docs/realtime-sdk/tech-ref/voice/calldetect.mdx +++ b/website/docs/realtime-sdk/tech-ref/voice/calldetect.mdx @@ -126,7 +126,7 @@ const detect = await call.detectFax({ ### ended -▸ **ended**(): `Promise`\<[`CallDetect`][calldetect]> +- **ended**(): `Promise`\<[`CallDetect`][calldetect]> Returns a promise which will get resolved only after the detecting session is completed. @@ -147,7 +147,7 @@ console.log("Detect result:", result.type); ### stop -▸ **stop**(): `Promise`\<[`CallDetect`][calldetect]> +- **stop**(): `Promise`\<[`CallDetect`][calldetect]> Stops the detect session. @@ -168,7 +168,7 @@ await detect.stop(); ### onStarted -▸ **CallDetect.listen**(`{ onStarted: Callback }}`) +- **CallDetect.listen**(`{ onStarted: Callback }}`) Emitted when the detecting session has started. Your event handler will be called with an instance of [`CallDetect`][calldetect]. @@ -180,7 +180,7 @@ Emitted when the detecting session has started. Your event handler will be calle ### onUpdated -▸ **CallDetect.listen**(`{ onUpdated: Callback }}`) +- **CallDetect.listen**(`{ onUpdated: Callback }}`) Emitted when the detecting session has been updated. Your event handler will be called with an instance of [`CallDetect`][calldetect]. @@ -192,7 +192,7 @@ Emitted when the detecting session has been updated. Your event handler will be ### onEnded -▸ **CallDetect.listen**(`{ onEnded: Callback }}`) +- **CallDetect.listen**(`{ onEnded: Callback }}`) Emitted when the detecting session has ended. Your event handler will be called with an instance of [`CallDetect`][calldetect]. diff --git a/website/docs/realtime-sdk/tech-ref/voice/callplayback.mdx b/website/docs/realtime-sdk/tech-ref/voice/callplayback.mdx index c7baa98cb..5f1fef299 100644 --- a/website/docs/realtime-sdk/tech-ref/voice/callplayback.mdx +++ b/website/docs/realtime-sdk/tech-ref/voice/callplayback.mdx @@ -71,7 +71,7 @@ await call.playTTS({ ### pause -▸ **pause**(): `Promise`\<[`CallPlayback`][callplayback]> +- **pause**(): `Promise`\<[`CallPlayback`][callplayback]> Pauses the playback. @@ -94,7 +94,7 @@ await playback.pause(); ### ended -▸ **ended**(): `Promise`\<[`CallPlayback`][callplayback]> +- **ended**(): `Promise`\<[`CallPlayback`][callplayback]> Waits for the playback to end. @@ -117,7 +117,7 @@ await playback.ended(); ### resume -▸ **resume**(): `Promise`\<[`CallPlayback`][callplayback]> +- **resume**(): `Promise`\<[`CallPlayback`][callplayback]> Resumes the playback if it was paused. @@ -140,7 +140,7 @@ await playback.resume(); ### setVolume -▸ **setVolume**(`volume`): `Promise`\<[`CallPlayback`][callplayback]> +- **setVolume**(`volume`): `Promise`\<[`CallPlayback`][callplayback]> Changes the volume of the playback. @@ -169,7 +169,7 @@ await playback.setVolume(-20); ### stop -▸ **stop**(): `Promise`\<[`CallPlayback`][callplayback]> +- **stop**(): `Promise`\<[`CallPlayback`][callplayback]> Stops the playback. @@ -194,7 +194,7 @@ await playback.stop(); ### onStarted -▸ **CallPlayback.listen**(`{ onStarted: Callback }}`) +- **CallPlayback.listen**(`{ onStarted: Callback }}`) Emitted when the playback starts playing. Your event handler will receive an instance of [`CallPlayback`][callplayback]. @@ -206,7 +206,7 @@ Emitted when the playback starts playing. Your event handler will receive an ins ### onUpdated -▸ **CallPlayback.listen**(`{ onUpdated: Callback }}`) +- **CallPlayback.listen**(`{ onUpdated: Callback }}`) Emitted when the playback is updated. Your event handler will receive an instance of [`CallPlayback`][callplayback]. @@ -218,7 +218,7 @@ Emitted when the playback is updated. Your event handler will receive an instanc ### onFailed -▸ **CallPlayback.listen**(`{ onFailed: Callback }}`) +- **CallPlayback.listen**(`{ onFailed: Callback }}`) Emitted when the playback fails to start. Your event handler will receive an instance of [`CallPlayback`][callplayback]. @@ -230,7 +230,7 @@ Emitted when the playback fails to start. Your event handler will receive an ins ### onEnded -▸ **CallPlayback.listen**(`{ onEnded: Callback }}`) +- **CallPlayback.listen**(`{ onEnded: Callback }}`) Emitted when the playback finishes playing. Your event handler will receive an instance of [`CallPlayback`][callplayback]. diff --git a/website/docs/realtime-sdk/tech-ref/voice/callprompt.mdx b/website/docs/realtime-sdk/tech-ref/voice/callprompt.mdx index 9c9de22aa..dd9c5330e 100644 --- a/website/docs/realtime-sdk/tech-ref/voice/callprompt.mdx +++ b/website/docs/realtime-sdk/tech-ref/voice/callprompt.mdx @@ -103,7 +103,7 @@ await call.promptTTS({ ### ended -▸ **ended**(): `Promise`\<[`CallPrompt`][callprompt]> +- **ended**(): `Promise`\<[`CallPrompt`][callprompt]> Returns a promise that is resolved only after this prompt finishes (or is stopped). @@ -131,7 +131,7 @@ const { type, digits, terminator } = await prompt.ended(); ### setVolume -▸ **setVolume**(`volume`): `Promise`\<[`CallPrompt`][callprompt]> +- **setVolume**(`volume`): `Promise`\<[`CallPrompt`][callprompt]> Changes the volume of the audio. @@ -165,7 +165,7 @@ await prompt.setVolume(-20); ### stop -▸ **stop**(): `Promise`\<[`CallPrompt`][callprompt]> +- **stop**(): `Promise`\<[`CallPrompt`][callprompt]> Stops the prompt. @@ -195,7 +195,7 @@ await prompt.stop(); ### onStarted -▸ **CallPrompt.listen**(`{ onStarted: Callback }}`) +- **CallPrompt.listen**(`{ onStarted: Callback }}`) Emitted when the prompt starts. Your event handler will receive an instance of [`CallPrompt`][callprompt]. @@ -207,7 +207,7 @@ Emitted when the prompt starts. Your event handler will receive an instance of [ ### onUpdated -▸ **CallPrompt.listen**(`{ onUpdated: Callback }}`) +- **CallPrompt.listen**(`{ onUpdated: Callback }}`) Emitted when the prompt is updated. Your event handler will receive an instance of [`CallPrompt`][callprompt]. @@ -219,7 +219,7 @@ Emitted when the prompt is updated. Your event handler will receive an instance ### onFailed -▸ **CallPrompt.listen**(`{ onFailed: Callback }}`) +- **CallPrompt.listen**(`{ onFailed: Callback }}`) Emitted when the prompt fails. Your event handler will receive an instance of [`CallPrompt`][callprompt]. @@ -231,7 +231,7 @@ Emitted when the prompt fails. Your event handler will receive an instance of [` ### onEnded -▸ **CallPrompt.listen**(`{ onEnded: Callback }}`) +- **CallPrompt.listen**(`{ onEnded: Callback }}`) Emitted when the prompt ends. Your event handler will receive an instance of [`CallPrompt`][callprompt]. diff --git a/website/docs/realtime-sdk/tech-ref/voice/callrecording.mdx b/website/docs/realtime-sdk/tech-ref/voice/callrecording.mdx index e30b2b024..5acdddae4 100644 --- a/website/docs/realtime-sdk/tech-ref/voice/callrecording.mdx +++ b/website/docs/realtime-sdk/tech-ref/voice/callrecording.mdx @@ -91,7 +91,7 @@ await call.recordAudio({ ### pause -▸ **pause**(`behavior?`): `Promise`\<[`CallRecording`][callrecording]> +- **pause**(`behavior?`): `Promise`\<[`CallRecording`][callrecording]> Pauses the recording. @@ -129,7 +129,7 @@ await recording.pause("skip"); ### resume -▸ **resume**(): `Promise`\<[`CallRecording`][callrecording]> +- **resume**(): `Promise`\<[`CallRecording`][callrecording]> Resumes the recording. @@ -160,7 +160,7 @@ await recording.resume(); ### stop -▸ **stop**(): `Promise`\<[`CallRecording`][callrecording]> +- **stop**(): `Promise`\<[`CallRecording`][callrecording]> Stops the recording. @@ -195,7 +195,7 @@ console.log("Recording URL:", recording.url); ### onStarted -▸ **CallRecording.listen**(`{ onStarted: Callback }}`) +- **CallRecording.listen**(`{ onStarted: Callback }}`) Emitted when the recording starts. Your event handler will receive the instance of [`CallRecording`][callrecording]. @@ -219,7 +219,7 @@ Emitted when the recording is updated. Your event handler will receive the insta ### onFailed -▸ **CallRecording.listen**(`{ onFailed: Callback }}`) +- **CallRecording.listen**(`{ onFailed: Callback }}`) Emitted when the recording fails to start. Your event handler will receive the instance of [`CallRecording`][callrecording]. @@ -231,7 +231,7 @@ Emitted when the recording fails to start. Your event handler will receive the i ### onEnded -▸ **CallRecording.listen**(`{ onEnded: Callback }}`) +- **CallRecording.listen**(`{ onEnded: Callback }}`) Emitted when the recording ends. Your event handler will receive the instance of [`CallRecording`][callrecording]. diff --git a/website/docs/realtime-sdk/tech-ref/voice/calltap.mdx b/website/docs/realtime-sdk/tech-ref/voice/calltap.mdx index f65a914b8..bc7e5e3ff 100644 --- a/website/docs/realtime-sdk/tech-ref/voice/calltap.mdx +++ b/website/docs/realtime-sdk/tech-ref/voice/calltap.mdx @@ -77,7 +77,7 @@ call.hangup(); ### ended -▸ **ended**(): `Promise`\<[`CallTap`][calltap]> +- **ended**(): `Promise`\<[`CallTap`][calltap]> Returns a promise that is resolved only after this tap finishes (or is stopped). @@ -122,7 +122,7 @@ console.log("Tap session completed"); ### stop -▸ **stop**(): `Promise`\<[`CallTap`][calltap]> +- **stop**(): `Promise`\<[`CallTap`][calltap]> Stops the tapping. @@ -169,7 +169,7 @@ console.log("Tap stopped"); ### onStarted -▸ **CallTap.listen**(`{ onStarted: Callback }}`) +- **CallTap.listen**(`{ onStarted: Callback }}`) Emitted when the tapping starts. Your event handler will receive an instance of [`CallTap`][calltap]. @@ -181,7 +181,7 @@ Emitted when the tapping starts. Your event handler will receive an instance of ### onEnded -▸ **CallTap.listen**(`{ onEnded: Callback }}`) +- **CallTap.listen**(`{ onEnded: Callback }}`) Emitted when the tapping ends. Your event handler will receive an instance of [`CallTap`][calltap]. diff --git a/website/docs/realtime-sdk/tech-ref/voice/voice-call.mdx b/website/docs/realtime-sdk/tech-ref/voice/voice-call.mdx index 3d51e83a2..4fce8e5c5 100644 --- a/website/docs/realtime-sdk/tech-ref/voice/voice-call.mdx +++ b/website/docs/realtime-sdk/tech-ref/voice/voice-call.mdx @@ -152,7 +152,7 @@ await voiceClient.listen({ ### amd -▸ **amd**(`params?`): `Promise`\<[`CallDetect`][calldetect]> +- **amd**(`params?`): `Promise`\<[`CallDetect`][calldetect]> Detects the presence of an answering machine. Alias for [detectAnsweringMachine][detectansweringmachine]. @@ -160,7 +160,7 @@ Detects the presence of an answering machine. Alias for [detectAnsweringMachine] ### answer -▸ **answer**(): `Promise`\<[`Call`][call]> +- **answer**(): `Promise`\<[`Call`][call]> Answers the incoming call. @@ -360,7 +360,7 @@ await voiceClient.listen({ ### connect -▸ **connect**(`params`): `Promise`\<[`Call`][call]> +- **connect**(`params`): `Promise`\<[`Call`][call]> Attempt to connect an existing call to a new outbound call. The two devices will hear each other. You can wait until the new peer is disconnected by calling [disconnected][disconnected]. @@ -450,7 +450,7 @@ await voiceClient.listen({ ### connectPhone -▸ **connectPhone**(`params`): `Promise`\<[`Call`][call]> +- **connectPhone**(`params`): `Promise`\<[`Call`][call]> Attempt to connect an existing call to a new outbound phone call. The two devices will hear each other. You can wait until the new peer is disconnected by calling [disconnected][disconnected]. @@ -548,7 +548,7 @@ await voiceClient.listen({ ### connectSip -▸ **connectSip**(`params`): `Promise`\<[`Call`][call]> +- **connectSip**(`params`): `Promise`\<[`Call`][call]> Attempt to connect an existing call to a new outbound SIP call. The two devices will hear each other. You can wait until the new peer is disconnected by calling [disconnected][disconnected]. @@ -661,7 +661,7 @@ await voiceClient.listen({ ### detect -▸ **detect**(`params`): `Promise`\<[`CallDetect`][calldetect]> +- **detect**(`params`): `Promise`\<[`CallDetect`][calldetect]> Generic method. Please see [amd][amd], [detecFax][detectfax], and [detectDigit][detectdigit]. @@ -690,7 +690,7 @@ view the current state and results of the `detect` session. ### detectAnsweringMachine {#voice_call_detect_answering} -▸ **detectAnsweringMachine**(`params?`): `Promise`\<[`CallDetect`][calldetect]> +- **detectAnsweringMachine**(`params?`): `Promise`\<[`CallDetect`][calldetect]> Detects the presence of an answering machine. @@ -798,7 +798,7 @@ try { ### detectDigit -▸ **detectDigit**(`params?`): `Promise`\<[`CallDetect`][calldetect]> +- **detectDigit**(`params?`): `Promise`\<[`CallDetect`][calldetect]> Detects when a digit is pressed in an audio stream. To gather digit input from a caller, please see [prompt][prompt]. @@ -870,7 +870,7 @@ await voiceClient.listen({ ### detectFax {#voice_call_detect_fax} -▸ **detectFax**(`params?`): `Promise`\<[`CallDetect`][calldetect]> +- **detectFax**(`params?`): `Promise`\<[`CallDetect`][calldetect]> Detects the presence of a fax machine. @@ -943,7 +943,7 @@ await voiceClient.listen({ ### disconnect -▸ **disconnect**(): `Promise` +- **disconnect**(): `Promise` Disconnects the [`connected`][connect] peer from the call. @@ -993,7 +993,7 @@ await voiceClient.listen({ ### disconnected -▸ **disconnected**(): `Promise`\<[`Call`][call]> +- **disconnected**(): `Promise`\<[`Call`][call]> Call this method after connecting a peer (e.g., using [connect][connect], [connectPhone][connectphone], or [connectSip][connectsip]) to wait until the @@ -1049,7 +1049,7 @@ await voiceClient.listen({ ### hangup -▸ **hangup**(`reason?`): `Promise` +- **hangup**(`reason?`): `Promise` Hangup the call. @@ -1094,7 +1094,7 @@ await voiceClient.listen({ ### listen -▸ **listen**(`{ event: Callback }`): `Promise`\<[`Call Events`][here]> +- **listen**(`{ event: Callback }`): `Promise`\<[`Call Events`][here]> Listen for events on the call. @@ -1152,7 +1152,7 @@ await voiceClient.listen({ ### pass -▸ **pass**(`params`): `Promise`\<[`Call`][call]> +- **pass**(`params`): `Promise`\<[`Call`][call]> This will allow a client to decline incoming calls without ending the call and redirect the call to another [Voice client][voice-client-oncallreceived]. @@ -1186,7 +1186,7 @@ await voiceClient.listen({ ### play -▸ **play**(`params`): `Promise`\<[`CallPlayback`][callplayback]> +- **play**(`params`): `Promise`\<[`CallPlayback`][callplayback]> Play one or multiple media in a Call and waits until the playing has ended. @@ -1261,7 +1261,7 @@ await voiceClient.listen({ ### playAudio -▸ **playAudio**(`params`): `Promise`\<[`CallPlayback`][callplayback]> +- **playAudio**(`params`): `Promise`\<[`CallPlayback`][callplayback]> Plays an audio file. @@ -1330,7 +1330,7 @@ await voiceClient.listen({ ### playRingtone -▸ **playRingtone**(`params`): `Promise`\<[`CallPlayback`][callplayback]> +- **playRingtone**(`params`): `Promise`\<[`CallPlayback`][callplayback]> Plays a ringtone. @@ -1403,7 +1403,7 @@ await voiceClient.listen({ ### playSilence -▸ **playSilence**(`params`): `Promise`\<[`CallPlayback`][callplayback]> +- **playSilence**(`params`): `Promise`\<[`CallPlayback`][callplayback]> Plays some silence. @@ -1465,7 +1465,7 @@ await voiceClient.listen({ ### playTTS -▸ **playTTS**(`params`): `Promise`\<[`CallPlayback`][callplayback]> +- **playTTS**(`params`): `Promise`\<[`CallPlayback`][callplayback]> Plays text-to-speech. @@ -1590,7 +1590,7 @@ await voiceClient.listen({ ### prompt -▸ **prompt**(`params`): `Promise`\<[`CallPrompt`][callprompt]> +- **prompt**(`params`): `Promise`\<[`CallPrompt`][callprompt]> Generic method to prompt the user for input. @@ -1722,7 +1722,7 @@ await voiceClient.listen({ ### promptAudio -▸ **promptAudio**(`params`): `Promise`\<[`CallPrompt`][callprompt]> +- **promptAudio**(`params`): `Promise`\<[`CallPrompt`][callprompt]> Play an audio while collecting user input from the call, such as `digits` or `speech`. @@ -1851,7 +1851,7 @@ await voiceClient.listen({ ### promptRingtone -▸ **promptRingtone**(`params`): `Promise`\<[`CallPrompt`][callprompt]> +- **promptRingtone**(`params`): `Promise`\<[`CallPrompt`][callprompt]> Play a ringtone while collecting user input from the call, such as `digits` or `speech`. @@ -1990,7 +1990,7 @@ await voiceClient.listen({ ### promptTTS -▸ **promptTTS**(`params`): `Promise`\<[`CallPrompt`][callprompt]> +- **promptTTS**(`params`): `Promise`\<[`CallPrompt`][callprompt]> Play text-to-speech while collecting user input from the call, such as `digits` or `speech`. @@ -2186,7 +2186,7 @@ await voiceClient.listen({ ### record -▸ **record**(`params`): `Promise`\<[`CallRecording`][callrecording]> +- **record**(`params`): `Promise`\<[`CallRecording`][callrecording]> Generic method to record a call. @@ -2273,7 +2273,7 @@ await voiceClient.listen({ ### recordAudio {#voice_call_record_audio} -▸ **recordAudio**(`params?`): `Promise`\<[`CallRecording`][callrecording]> +- **recordAudio**(`params?`): `Promise`\<[`CallRecording`][callrecording]> Records the audio from the call. @@ -2385,7 +2385,7 @@ await voiceClient.listen({ ### sendDigits -▸ **sendDigits**(`digits`): `Promise`\<[`Call`][call]> +- **sendDigits**(`digits`): `Promise`\<[`Call`][call]> Play DTMF digits to the other party on the call. @@ -2434,7 +2434,7 @@ await voiceClient.listen({ ### tap -▸ **tap**(`params`): `Promise`\<[`CallTap`][calltap]> +- **tap**(`params`): `Promise`\<[`CallTap`][calltap]> Intercept call media and stream it to the specified WebSocket endpoint. Prefer using [tapAudio][tapaudio] if you only need to tap audio. @@ -2528,7 +2528,7 @@ await voiceClient.listen({ ### tapAudio -▸ **tapAudio**(`params`): `Promise`\<[`CallTap`][calltap]> +- **tapAudio**(`params`): `Promise`\<[`CallTap`][calltap]> Intercept call audio and stream it to the specified WebSocket endpoint. @@ -2615,7 +2615,7 @@ await voiceClient.listen({ ### waitFor -▸ **waitFor**(`params`): `Promise` +- **waitFor**(`params`): `Promise` Returns a promise that is resolved only after the current call is in one of the specified states. @@ -2680,7 +2680,7 @@ To listen to a specific event within a single session, use `listen` at the param ### onStateChanged -▸ **Call.listen**(`{ onStateChanged: Callback }`) +- **Call.listen**(`{ onStateChanged: Callback }`) Emitted when the state of the call changes. Your event handler will be called with an instance of the [`CallState`][callstate] object. @@ -2693,7 +2693,7 @@ will be called with an instance of the [`CallState`][callstate] object. ### onCollectEnded -• **Call.listen**(`{ onCollectEnded: Callback }`) +- **Call.listen**(`{ onCollectEnded: Callback }`) Emitted when a collect session has ended. Your event handler will be called with an instance of the [`CallCollect`][callcollect] object. @@ -2706,7 +2706,7 @@ will be called with an instance of the [`CallCollect`][callcollect] object. ### onCollectFailed -• **Call.listen**(`{ onCollectFailed: Callback }`) +- **Call.listen**(`{ onCollectFailed: Callback }`) Emitted when a collect session has failed. Your event handler will be called with an instance of the [`CallCollect`][callcollect] object. @@ -2719,7 +2719,7 @@ will be called with an instance of the [`CallCollect`][callcollect] object. ### onCollectInputStarted {#voice_call_oncollectinputstarted} -• **Call.listen**(`{ onCollectInputStarted: Callback }`) +- **Call.listen**(`{ onCollectInputStarted: Callback }`) Emitted when a collect session has started. Your event handler will be called with an instance of the [`CallCollect`][callcollect] object. @@ -2732,7 +2732,7 @@ will be called with an instance of the [`CallCollect`][callcollect] object. ### onCollectStarted -• **Call.listen**(`{ onCollectStarted: Callback }`) +- **Call.listen**(`{ onCollectStarted: Callback }`) Emitted when a collect session has started. Your event handler will be called with an instance of the [`CallCollect`][callcollect] object. @@ -2745,7 +2745,7 @@ will be called with an instance of the [`CallCollect`][callcollect] object. ### onCollectUpdated -• **Call.listen**(`{ onCollectUpdated: Callback }`) +- **Call.listen**(`{ onCollectUpdated: Callback }`) Emitted when the state of a collect session has changed. Your event handler will be called with an instance of the [`CallCollect`][callcollect] object. @@ -2758,7 +2758,7 @@ will be called with an instance of the [`CallCollect`][callcollect] object. ### onDetectEnded -• **Call.listen**(`{ onDetectEnded: Callback }`) +- **Call.listen**(`{ onDetectEnded: Callback }`) Emitted when a call detection session has ended. Your event handler will be called with an instance of the [`CallDetect`][calldetect] object. @@ -2771,7 +2771,7 @@ will be called with an instance of the [`CallDetect`][calldetect] object. ### onDetectStarted -• **Call.listen**(`{ onDetectStarted: Callback }`) +- **Call.listen**(`{ onDetectStarted: Callback }`) Emitted when a call detection session has started. Your event handler will be called with an instance of the [`CallDetect`][calldetect] object. @@ -2784,7 +2784,7 @@ will be called with an instance of the [`CallDetect`][calldetect] object. ### onDetectUpdated -• **Call.listen**(`{ onDetectUpdated: Callback }`) +- **Call.listen**(`{ onDetectUpdated: Callback }`) Emitted when the state of a call detection session has changed. Your event handler will be called with an instance of the [`CallDetect`][calldetect] object. @@ -2797,7 +2797,7 @@ will be called with an instance of the [`CallDetect`][calldetect] object. ### onPlaybackEnded -• **Call.listen**(`{ onPlaybackEnded: Callback }`) +- **Call.listen**(`{ onPlaybackEnded: Callback }`) Emitted when a playback has ended. Your event handler will be called with an instance of the [`CallPlayback`][callplayback] object. @@ -2823,7 +2823,7 @@ will be called with an instance of the [`CallPlayback`][callplayback] object. ### onPlaybackStarted -• **Call.listen**(`{ onPlaybackStarted: Callback }`) +- **Call.listen**(`{ onPlaybackStarted: Callback }`) Emitted when a playback has started. Your event handler will be called with an instance of the [`CallPlayback`][callplayback] object. @@ -2836,7 +2836,7 @@ will be called with an instance of the [`CallPlayback`][callplayback] object. ### onPlaybackUpdated -• **Call.listen**(`{ onPlaybackUpdated: Callback }`) +- **Call.listen**(`{ onPlaybackUpdated: Callback }`) Emitted when the state of a playback has changed. Your event handler will be called with an instance of the [`CallPlayback`][callplayback] object. @@ -2849,7 +2849,7 @@ will be called with an instance of the [`CallPlayback`][callplayback] object. ### onPromptEnded -• **Call.listen**(`{ onPromptEnded: Callback }`) +- **Call.listen**(`{ onPromptEnded: Callback }`) Emitted when a prompt has ended. Your event handler will be called with an instance of the [`CallPrompt`][callprompt] object. @@ -2862,7 +2862,7 @@ will be called with an instance of the [`CallPrompt`][callprompt] object. ### onPromptFailed -• **Call.listen**(`{ onPromptFailed: Callback }`) +- **Call.listen**(`{ onPromptFailed: Callback }`) Emitted when a prompt has failed. Your event handler will be called with an instance of the [`CallPrompt`][callprompt] object. @@ -2875,7 +2875,7 @@ will be called with an instance of the [`CallPrompt`][callprompt] object. ### onPromptStarted -• **Call.listen**(`{ onPromptStarted: Callback }`) +- **Call.listen**(`{ onPromptStarted: Callback }`) Emitted when a prompt has started. Your event handler will be called with an instance of the [`CallPrompt`][callprompt] object. @@ -2888,7 +2888,7 @@ will be called with an instance of the [`CallPrompt`][callprompt] object. ### onPromptUpdated -• **Call.listen**(`{ onPromptUpdated: Callback }`) +- **Call.listen**(`{ onPromptUpdated: Callback }`) Emitted when the state of a prompt has changed. Your event handler will be called with an instance of the [`CallPrompt`][callprompt] object. @@ -2901,7 +2901,7 @@ will be called with an instance of the [`CallPrompt`][callprompt] object. ### onRecordingEnded -• **Call.listen**(`{ onRecordingEnded: Callback }`) +- **Call.listen**(`{ onRecordingEnded: Callback }`) Emitted when a recording has ended. Your event handler will be called with an instance of the [`CallRecording`][callrecording] object. @@ -2914,7 +2914,7 @@ will be called with an instance of the [`CallRecording`][callrecording] object. ### onRecordingFailed -• **Call.listen**( `{ onRecordingFailed: Callback }`) +- **Call.listen**( `{ onRecordingFailed: Callback }`) Emitted when a recording has failed. Your event handler will be called with an instance of the [`CallRecording`][callrecording] object. @@ -2927,7 +2927,7 @@ will be called with an instance of the [`CallRecording`][callrecording] object. ### onRecordingStarted -• **Call.listen**(`{ onRecordingStarted: Callback }`) +- **Call.listen**(`{ onRecordingStarted: Callback }`) Emitted when a recording has started. Your event handler will be called with an instance of the [`CallRecording`][callrecording] object. @@ -2940,7 +2940,7 @@ will be called with an instance of the [`CallRecording`][callrecording] object. ### onRecordingUpdated -• **Call.listen**(`{ onRecordingUpdated: Callback }`) +- **Call.listen**(`{ onRecordingUpdated: Callback }`) Emitted when the state of a recording has changed. Your event handler will be called with an instance of the [`CallRecording`][callrecording] object. @@ -2953,7 +2953,7 @@ will be called with an instance of the [`CallRecording`][callrecording] object. ### onTapEnded -• **Call.listen**(`{ onTapEnded: Callback }`) +- **Call.listen**(`{ onTapEnded: Callback }`) Emitted when a tap has ended. Your event handler will be called with an instance of the [`CallTap`][calltap] object. @@ -2966,7 +2966,7 @@ will be called with an instance of the [`CallTap`][calltap] object. ### onTapStarted -• **Call.listen**(`{ onTapStarted: Callback }`) +- **Call.listen**(`{ onTapStarted: Callback }`) Emitted when a tap has started. Your event handler will be called with an instance of the [`CallTap`][calltap] object. diff --git a/website/docs/realtime-sdk/tech-ref/voice/voice-client.mdx b/website/docs/realtime-sdk/tech-ref/voice/voice-client.mdx index 81a3a9240..8adbef452 100644 --- a/website/docs/realtime-sdk/tech-ref/voice/voice-client.mdx +++ b/website/docs/realtime-sdk/tech-ref/voice/voice-client.mdx @@ -37,7 +37,7 @@ const voiceClient = client.voice ### dial -▸ **dial**(`params`): `Promise`\<[`Call`][call]> +- **dial**(`params`): `Promise`\<[`Call`][call]> Makes an outbound Call and waits until it has been answered or hung up. This is an advanced method that lets you call multiple devices in parallel or series: for simpler use cases, see [dialPhone][dialphone] and [dialSip][dialsip]. @@ -85,7 +85,7 @@ try { ### dialPhone -▸ **dialPhone**(`params`): `Promise`\<[`Call`][call-5]> +- **dialPhone**(`params`): `Promise`\<[`Call`][call-5]> Makes an outbound call to a PSTN number. @@ -146,7 +146,7 @@ try { ### dialSip -▸ **dialSip**(`params`): `Promise`\<[`Call`][call-5]> +- **dialSip**(`params`): `Promise`\<[`Call`][call-5]> Makes an outbound call to a SIP endpoint. @@ -227,7 +227,7 @@ try { ### listen -▸ **listen**(`{event: Callback }`): `Promise` +- **listen**(`{event: Callback }`): `Promise` Listens for Voice events. @@ -273,7 +273,7 @@ await voiceClient.listen({ ### onCallReceived {#oncallreceived} -• **client.voice.listen**(`{ onCallReceived: Callback }`) +- **client.voice.listen**(`{ onCallReceived: Callback }`) Emitted when a call is received. Your event handler will be called with a [`Call`][call-7] object. diff --git a/website/realtime-sdk_versioned_docs/version-v3/_common/_method_off.mdx b/website/realtime-sdk_versioned_docs/version-v3/_common/_method_off.mdx index 582ed3542..697f4b829 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/_common/_method_off.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/_common/_method_off.mdx @@ -1,6 +1,6 @@ import { GetListOfAvailableEventsDescription } from "./utils"; -▸ **off**(`event`, `fn?`) +- **off**(`event`, `fn?`) Remove an event handler. diff --git a/website/realtime-sdk_versioned_docs/version-v3/_common/_method_on.mdx b/website/realtime-sdk_versioned_docs/version-v3/_common/_method_on.mdx index abc49c730..bc720734c 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/_common/_method_on.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/_common/_method_on.mdx @@ -1,6 +1,6 @@ import { GetListOfAvailableEventsDescription } from "./utils"; -▸ **on**(`event`, `fn`) +- **on**(`event`, `fn`) Attaches an event handler to the specified event. diff --git a/website/realtime-sdk_versioned_docs/version-v3/_common/_method_once.mdx b/website/realtime-sdk_versioned_docs/version-v3/_common/_method_once.mdx index 0a90df806..32f68cc38 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/_common/_method_once.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/_common/_method_once.mdx @@ -1,6 +1,6 @@ import { GetListOfAvailableEventsDescription } from "./utils"; -▸ **once**(`event`, `fn`) +- **once**(`event`, `fn`) Attaches an event handler to the specified event. The handler will fire only once. diff --git a/website/realtime-sdk_versioned_docs/version-v3/_common/_method_removealllisteners.mdx b/website/realtime-sdk_versioned_docs/version-v3/_common/_method_removealllisteners.mdx index cd76ac292..55581c7f4 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/_common/_method_removealllisteners.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/_common/_method_removealllisteners.mdx @@ -1,6 +1,6 @@ import { GetListOfAvailableEventsDescription } from "./utils"; -▸ **removeAllListeners**(`event?`) +- **removeAllListeners**(`event?`) Detaches all event listeners for the specified event. diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/chat/chat-client.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/chat/chat-client.mdx index ef9cf69d3..9e38466ce 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/chat/chat-client.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/chat/chat-client.mdx @@ -43,7 +43,7 @@ await chatClient.publish({ ### constructor -• **new Client**(`chatOptions`) +- **new Client**(`chatOptions`) Creates a new Chat client. @@ -72,7 +72,7 @@ const chatClient = new Chat.Client({ ### disconnect -▸ **disconnect**(): `void` +- **disconnect**(): `void` Disconnects this client. The client will stop receiving events and you will need to create a new instance if you want to use it again. @@ -90,7 +90,7 @@ client.disconnect(); ### getMemberState -▸ **getMemberState**(`params`): `Promise<{ channels: Record }>` +- **getMemberState**(`params`): `Promise<{ channels: Record }>` Returns the states of a member in the specified channels. @@ -122,7 +122,7 @@ s.channels.chan1.state; // the state object for chan1 ### getMembers -▸ **getMembers**(`params`): `Promise<{ members: ChatMemberEntity[] }>` - See [`ChatMemberEntity`][link] for more details. +- **getMembers**(`params`): `Promise<{ members: ChatMemberEntity[] }>` - See [`ChatMemberEntity`][link] for more details. Returns the list of members in the given channel. @@ -150,7 +150,7 @@ m.members[0]; // { id: ..., channel: ..., state: ... } ### getMessages -▸ **getMessages**(`params`): `Promise<{ cursor: PaginationCursor ; messages: ChatMessageEntity[] }>` - See [`ChatMessageEntity`][link-1] for more details. +- **getMessages**(`params`): `Promise<{ cursor: PaginationCursor ; messages: ChatMessageEntity[] }>` - See [`ChatMessageEntity`][link-1] for more details. Returns the list of messages that were sent to the specified channel. @@ -210,7 +210,7 @@ const next = await chatClient.getMessages({ ### publish -▸ **publish**(`params`): `Promise` +- **publish**(`params`): `Promise` Publish a message into the specified channel. @@ -260,7 +260,7 @@ await chatClient.publish({ ### setMemberState -▸ **setMemberState**(`params`): `Promise` +- **setMemberState**(`params`): `Promise` Sets a state object for a member, for the specified channels. The previous state object will be completely replaced. @@ -293,7 +293,7 @@ await chatClient.setMemberState({ ### subscribe -▸ **subscribe**(`channels`): `Promise` +- **subscribe**(`channels`): `Promise` List of channels for which you want to receive messages. @@ -327,7 +327,7 @@ await chatClient.subscribe(["chan-2", "chan-3"]); ### unsubscribe -▸ **unsubscribe**(`channels`): `Promise` +- **unsubscribe**(`channels`): `Promise` List of channels from which you want to unsubscribe. @@ -352,7 +352,7 @@ await chatClient.unsubscribe(["chan-2", "chan-3"]); ### member.joined -• **member.joined**(`member`) +- **member.joined**(`member`) A new member joined the chat. @@ -366,7 +366,7 @@ A new member joined the chat. ### member.left -• **member.left**(`member`) +- **member.left**(`member`) A member left the chat. @@ -380,7 +380,7 @@ A member left the chat. ### member.updated -• **member.updated**(`member`) +- **member.updated**(`member`) A member updated its state. @@ -394,7 +394,7 @@ A member updated its state. ### message -• **message**(`message`) +- **message**(`message`) A new message has been received. @@ -412,15 +412,15 @@ An object representing a Chat Member with only the state properties of [`ChatMem #### Properties -• `Readonly` **channel**: `string` +- `Readonly` **channel**: `string` The channel of this member. -• `Readonly` **id**: `string` +- `Readonly` **id**: `string` The id of this member. -• `Readonly` **state**: `Record` +- `Readonly` **state**: `Record` The state of this member. @@ -430,22 +430,22 @@ An object representing a Chat Message with only the state properties of [`ChatMe #### Properties -• `Readonly` **content**: `any` +- `Readonly` **content**: `any` The content of this message. -• `Readonly` **id**: `string` +- `Readonly` **id**: `string` The id. of this message -• `Readonly` **member**: [`ChatMember`][chatmember-4] +- `Readonly` **member**: [`ChatMember`][chatmember-4] The member which sent this message. -• `Readonly` **meta?**: `any` +- `Readonly` **meta?**: `any` Any metadata associated with this message. -• `Readonly` **publishedAt**: `Date` +- `Readonly` **publishedAt**: `Date` The date and time at which this message was published. diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/index.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/index.mdx index 347a6bbdc..9b822f622 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/index.mdx @@ -76,7 +76,7 @@ const video = new Video.Client({ ### ~~createClient~~ -▸ `Const` **createClient**(`userOptions`): `Promise` ⚠️ **Deprecated** — See [RealtimeClient](/sdks/realtime-sdk/v3/realtime-client) for more details. +- `Const` **createClient**(`userOptions`): `Promise` ⚠️ **Deprecated** — See [RealtimeClient](/sdks/realtime-sdk/v3/realtime-client) for more details. > ⚠️ **Deprecated** > You no longer need to create the client manually. You can use the product constructors, like [Video.Client](/sdks/realtime-sdk/v3/video/room-session), to access the same functionality. @@ -111,7 +111,7 @@ const client = await createClient({ ### getConfig -▸ `Const` **getConfig**(): `GlobalConfig` +- `Const` **getConfig**(): `GlobalConfig` #### Returns diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/messaging/messaging-client.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/messaging/messaging-client.mdx index 37a559404..7d5bd54ee 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/messaging/messaging-client.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/messaging/messaging-client.mdx @@ -40,7 +40,7 @@ await client.send({ ### constructor -• **new Client**(`opts`) +- **new Client**(`opts`) #### Parameters @@ -57,7 +57,7 @@ await client.send({ ### disconnect -▸ **disconnect**(): `void` +- **disconnect**(): `void` Disconnects this client. The client will stop receiving events and you will need to create a new instance if you want to use it again. @@ -99,7 +99,7 @@ client.disconnect(); ### send -▸ **send**(`params`): `Promise` - See [`MessagingSendResult`][messagingsendresult-1] +- **send**(`params`): `Promise` - See [`MessagingSendResult`][messagingsendresult-1] Send an outbound SMS or MMS message. @@ -143,7 +143,7 @@ try { ### message.received -• **message.received**(`message`) +- **message.received**(`message`) Emitted whenever a message is received. Your event handler receives a message object. Example: @@ -168,7 +168,7 @@ client.on('message.received', (message) => { ### message.updated -• **message.updated**(`message`) +- **message.updated**(`message`) Emitted when the status of a message is updated. You can use this event to track the different stages that an outbound message goes through for delivery. Example: diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/pubsub/pubsub-client.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/pubsub/pubsub-client.mdx index eece0b0db..e70c7fcaf 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/pubsub/pubsub-client.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/pubsub/pubsub-client.mdx @@ -15,7 +15,7 @@ import MethodRemoveAllListeners from "../../_common/_method_removealllisteners.m ### constructor -• **new Client**(`pubSubOptions`) +- **new Client**(`pubSubOptions`) Creates a new PubSub client. @@ -44,7 +44,7 @@ const pubSubClient = new PubSub.Client({ ### disconnect -▸ **disconnect**(): `void` +- **disconnect**(): `void` Disconnects this client. The client will stop receiving events and you will need to create a new instance if you want to use it again. @@ -80,7 +80,7 @@ client.disconnect(); ### publish -▸ **publish**(`params`): `Promise` +- **publish**(`params`): `Promise` Publish a message into the specified channel. @@ -130,7 +130,7 @@ await pubSubClient.publish({ ### subscribe -▸ **subscribe**(`channels`): `Promise` +- **subscribe**(`channels`): `Promise` List of channels for which you want to receive messages. @@ -162,7 +162,7 @@ await pubSubClient.subscribe(["chan-2", "chan-3"]); ### unsubscribe -▸ **unsubscribe**(`channels`): `Promise` +- **unsubscribe**(`channels`): `Promise` List of channels from which you want to unsubscribe. @@ -187,7 +187,7 @@ await pubSubClient.unsubscribe(["chan-2", "chan-3"]); ### message -• **message**(`message`) +- **message**(`message`) A new message has been received. diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/realtime-client/index.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/realtime-client/index.mdx index d1c9f9e77..ae14bbc65 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/realtime-client/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/realtime-client/index.mdx @@ -45,7 +45,7 @@ await client.connect(); ### ~~connect~~ -▸ **connect**(): `Promise` +- **connect**(): `Promise` Connects this client to the SignalWire network. @@ -69,7 +69,7 @@ await client.connect(); ### ~~disconnect~~ -▸ **disconnect**(): `void` +- **disconnect**(): `void` Disconnects this client from the SignalWire network. diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/task/index.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/task/index.mdx index 3a2a95265..8eca9dd34 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/task/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/task/index.mdx @@ -49,7 +49,7 @@ await Task.send({ ### send -▸ `Const` **send**(`params`): `Promise` +- `Const` **send**(`params`): `Promise` Send a job to your Task Client in a specific topic. diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/task/task-client.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/task/task-client.mdx index 9b5583f51..a2327e39d 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/task/task-client.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/task/task-client.mdx @@ -33,7 +33,7 @@ client.on("task.received", (payload) => { ### constructor -• **new Client**(`opts`) +- **new Client**(`opts`) #### Parameters @@ -60,7 +60,7 @@ const client = new Task.Client({ ### disconnect -▸ **disconnect**(): `void` +- **disconnect**(): `void` Disconnects this client. The client will stop receiving events and you will need to create a new instance if you want to use it again. @@ -102,7 +102,7 @@ client.disconnect(); ### task.received -• **task.received**(`payload`) +- **task.received**(`payload`) Emitted whenever a task is received. Your event handler receives the payload. Example: diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/video/video-client.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/video/video-client.mdx index 73097c303..7dcccf235 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/video/video-client.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/video/video-client.mdx @@ -38,7 +38,7 @@ const { roomSessions } = await video.getRoomSessions(); ### constructor -• **new Client**(`opts`) +- **new Client**(`opts`) Create a new Client instance. @@ -65,7 +65,7 @@ const video = new Video.Client({ ### disconnect -▸ **disconnect**(): `void` +- **disconnect**(): `void` Disconnects this client. The client will stop receiving events and you will need to create a new instance if you want to use it again. @@ -83,7 +83,7 @@ client.disconnect(); ### getRoomSessions -▸ **getRoomSessions**(): `Promise<{roomSessions: RoomSession[] }>` - See [RoomSession][roomsession-2] for more details. +- **getRoomSessions**(): `Promise<{roomSessions: RoomSession[] }>` - See [RoomSession][roomsession-2] for more details. Returns the currently active room sessions. @@ -106,7 +106,7 @@ const { roomSessions } = await video.getRoomSessions(); ### getRoomSessionById -▸ **getRoomSessionById**(`id`): `Promise<{roomSessions: RoomSession[] }>` - See [RoomSession][roomsession-2] for more details. +- **getRoomSessionById**(`id`): `Promise<{roomSessions: RoomSession[] }>` - See [RoomSession][roomsession-2] for more details. Returns a room session given its id. Only in-progress room sessions are currently returned. @@ -153,7 +153,7 @@ const { roomSession } = await video.getRoomSessionById(); ### room.ended -• **room.ended**(`roomSession`) +- **room.ended**(`roomSession`) Emitted when a room session ends. Your event handler receives an object which is an instance of [Video.RoomSession][video-roomsession-1]. @@ -174,7 +174,7 @@ video.on('room.ended', async (roomSession) => { ### room.started -• **room.started**(`roomSession`) +- **room.started**(`roomSession`) Emitted when a room session is started. Your event handler receives an object which is an instance of [Video.RoomSession][video-roomsession-1]. Example: diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/video/video-roomsession.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/video/video-roomsession.mdx index c5887ae24..9a751d02b 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/video/video-roomsession.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/video/video-roomsession.mdx @@ -52,7 +52,7 @@ video.on("room.started", async (roomSession) => { ### displayName -• **displayName**: `string` +- **displayName**: `string` Display name for this room. Defaults to the value of `name` @@ -60,7 +60,7 @@ Display name for this room. Defaults to the value of `name` ### hideVideoMuted -• **hideVideoMuted**: `boolean` +- **hideVideoMuted**: `boolean` Whether muted videos are shown in the room layout. See [setHideVideoMuted][video-roomsession] @@ -68,7 +68,7 @@ Whether muted videos are shown in the room layout. See [setHideVideoMuted][video ### id -• **id**: `string` +- **id**: `string` Unique id for this room session @@ -76,7 +76,7 @@ Unique id for this room session ### layoutName -• **layoutName**: `string` +- **layoutName**: `string` Current layout name used in the room. @@ -84,7 +84,7 @@ Current layout name used in the room. ### meta -• **meta**: [`Record`][record-type]`` +- **meta**: [`Record`][record-type]`` Metadata associated to this room session. @@ -92,7 +92,7 @@ Metadata associated to this room session. ### name -• **name**: `string` +- **name**: `string` Name of this room @@ -100,7 +100,7 @@ Name of this room ### previewUrl -• `Optional` **previewUrl**: `string` +- `Optional` **previewUrl**: `string` URL to the room preview. @@ -108,7 +108,7 @@ URL to the room preview. ### layoutName -• `Optional` **layoutName**: `string` +- `Optional` **layoutName**: `string` Current layout name used in the room. @@ -116,7 +116,7 @@ Current layout name used in the room. ### recording -• **recording**: `boolean` +- **recording**: `boolean` Whether recording is active @@ -124,7 +124,7 @@ Whether recording is active ### recordings -• `Optional` **recordings**: `any[]` +- `Optional` **recordings**: `any[]` :::caution Deprecated @@ -138,7 +138,7 @@ List of active recordings in the room ### roomId -• **roomId**: `string` +- **roomId**: `string` Id of the room associated to this room session @@ -146,7 +146,7 @@ Id of the room associated to this room session ### audioMute -▸ **audioMute**(`params`): `Promise` +- **audioMute**(`params`): `Promise` Puts the microphone of a given member on mute. The other participants will not hear audio from the muted participant anymore. @@ -172,7 +172,7 @@ await roomSession.audioMute({ memberId: id }); ### audioUnmute -▸ **audioUnmute**(`params`): `Promise` +- **audioUnmute**(`params`): `Promise` Unmutes the microphone of a given member if it had been previously muted. @@ -198,7 +198,7 @@ await roomSession.audioUnmute({ memberId: id }); ### deaf -▸ **deaf**(`params`): `Promise` +- **deaf**(`params`): `Promise` Mutes the incoming audio for a given member. The affected participant will not hear audio from the other participants anymore. @@ -226,7 +226,7 @@ await roomSession.deaf({ memberId: id }); ### deleteMemberMeta -▸ **deleteMemberMeta**(`params`): `Promise` +- **deleteMemberMeta**(`params`): `Promise` Deletes the specified keys from the metadata for the specified member. @@ -264,7 +264,7 @@ await roomSession.deleteMemberMeta({ memberId: "...", keys: ["foo"] }); ### deleteMeta -▸ **deleteMeta**(`keys`): `Promise` +- **deleteMeta**(`keys`): `Promise` Deletes the specified keys from the metadata for this RoomSession. @@ -297,7 +297,7 @@ await roomSession.deleteMeta(["foo"]); ### demote -▸ **demote**(`params`): `Promise` +- **demote**(`params`): `Promise` Demotes a participant from "member" to "audience". See [promote][link-1]. @@ -326,7 +326,7 @@ await roomSession.demote({ ### getLayouts -▸ **getLayouts**(): `Promise<{ layouts: string[] }>` +- **getLayouts**(): `Promise<{ layouts: string[] }>` Returns a list of available layouts for the room. To set a room layout, use [setLayout][video-roomsession-2]. @@ -352,7 +352,7 @@ await roomSession.getLayouts() ### getMembers -▸ **getMembers**(): `Promise<{ members: VideoMemberEntity[] }>` +- **getMembers**(): `Promise<{ members: VideoMemberEntity[] }>` Returns a list of members currently in the room. @@ -405,7 +405,7 @@ await roomSession.getMembers() ### getMemberMeta -▸ **getMemberMeta**(): `Promise<{ meta: Object }>` +- **getMemberMeta**(): `Promise<{ meta: Object }>` Returns the metadata assigned to the specified member. @@ -431,7 +431,7 @@ console.log(meta); ### getMeta -▸ **getMeta**(): `Promise<{ meta: Object }>` +- **getMeta**(): `Promise<{ meta: Object }>` Returns the metadata assigned to this Room Session. @@ -450,7 +450,7 @@ console.log(meta); ### getPlaybacks -▸ **getPlaybacks**(): `Promise<{ playbacks: RoomSessionPlayback }>` - See [RoomSessionPlayback][roomsessionplayback-5] for more details. +- **getPlaybacks**(): `Promise<{ playbacks: RoomSessionPlayback }>` - See [RoomSessionPlayback][roomsessionplayback-5] for more details. Obtains a list of playbacks for the current room session. @@ -471,7 +471,7 @@ if (pl.playbacks.length > 0) { ### getRecordings -▸ **getRecordings**(): `Promise<{ recordings: RoomSessionRecording }>` - See [RoomSessionRecording][roomsessionrecording-5] for more details. +- **getRecordings**(): `Promise<{ recordings: RoomSessionRecording }>` - See [RoomSessionRecording][roomsessionrecording-5] for more details. Obtains a list of recordings for the current room session. @@ -492,7 +492,7 @@ if (recs.recordings.length > 0) { ### getStreams -▸ **getStreams**(): `Promise<{ streams: RoomSessionStream }>` - See [RoomSessionStream][roomsessionstream-4] for more details. +- **getStreams**(): `Promise<{ streams: RoomSessionStream }>` - See [RoomSessionStream][roomsessionstream-4] for more details. Obtains a list of active streams for this RoomSession. These are RTMP streams of the audio/video content of this room, which will be sent to an external party @@ -515,7 +515,7 @@ for (const stream of s.streams) { ### lock -▸ **lock**(`params`): `Promise` +- **lock**(`params`): `Promise` Locks the room. This prevents new participants from joining the room. @@ -551,7 +551,7 @@ await roomSession.lock(); ### play -▸ **play**(`params`): `Promise` - See [RoomSessionPlayback][roomsessionplayback-5] for more details. +- **play**(`params`): `Promise` - See [RoomSessionPlayback][roomsessionplayback-5] for more details. Starts a playback in the room. You can use the returned [RoomSessionPlayback][roomsessionplayback-5] object to control the playback (e.g., pause, resume, setVolume and stop). @@ -580,7 +580,7 @@ await playback.stop(); ### promote -▸ **promote**(`params`): `Promise` +- **promote**(`params`): `Promise` Promotes a participant from "audience" to "member". See [demote][link-2]. @@ -626,7 +626,7 @@ await roomSession.promote({ ### removeAllMembers -▸ **removeAllMembers**(): `Promise` +- **removeAllMembers**(): `Promise` Removes all the members from this room session. The room session will end. @@ -644,7 +644,7 @@ await roomSession.removeAllMembers(); ### removeMember -▸ **removeMember**(`params`): `Promise` +- **removeMember**(`params`): `Promise` Removes a specific participant from the room. @@ -670,7 +670,7 @@ await roomSession.removeMember({ memberId: id }); ### setHideVideoMuted -▸ **setHideVideoMuted**(`value`): `Promise` +- **setHideVideoMuted**(`value`): `Promise` Show or hide muted videos in the room layout. Members that have been muted via [videoMute][video-roomsession-3] not appear in the video stream, instead of appearing as a mute image, if this setting is enabled. @@ -696,7 +696,7 @@ await roomSession.setHideVideoMuted(false); ### setInputSensitivity -▸ **setInputSensitivity**(`params`): `Promise` +- **setInputSensitivity**(`params`): `Promise` Sets the input level at which the participant is identified as currently speaking. @@ -723,7 +723,7 @@ await roomSession.setInputSensitivity({ memberId: id, value: 80 }); ### setInputVolume -▸ **setInputVolume**(`params`): `Promise` +- **setInputVolume**(`params`): `Promise` Sets the input volume for a given member (e.g., the microphone input level). @@ -750,7 +750,7 @@ await roomSession.setInputVolume({ memberId: id, volume: -10 }); ### setLayout -▸ **setLayout**(`params`): `Promise` +- **setLayout**(`params`): `Promise` Sets a layout for the room. You can obtain a list of available layouts with [getLayouts][video-roomsession-4]. @@ -778,7 +778,7 @@ await roomSession.setLayout({ name: "6x6" }); ### setMemberMeta -▸ **setMemberMeta**(`params`): `Promise` +- **setMemberMeta**(`params`): `Promise` Assigns custom metadata to the specified RoomSession member. You can use this to store metadata whose meaning is entirely defined by your application. @@ -813,7 +813,7 @@ await roomSession.setMemberMeta({ ### setMemberPosition -▸ **setMemberPosition**(`params`): `Promise` +- **setMemberPosition**(`params`): `Promise` Assigns a position in the layout to the specified member. @@ -842,7 +842,7 @@ await roomSession.setMemberPosition({ ### setMeta -▸ **setMeta**(`meta`): `Promise` +- **setMeta**(`meta`): `Promise` Assigns custom metadata to the RoomSession. You can use this to store metadata whose meaning is entirely defined by your application. @@ -868,7 +868,7 @@ await roomSession.setMeta({ foo: "bar" }); ### setMicrophoneVolume -▸ **setMicrophoneVolume**(`params`): `Promise` +- **setMicrophoneVolume**(`params`): `Promise` > ⚠️ Deprecated. > Use [setInputVolume][video-roomsession-5] instead. @@ -890,7 +890,7 @@ await roomSession.setMeta({ foo: "bar" }); ### setOutputVolume -▸ **setOutputVolume**(`params`): `Promise` +- **setOutputVolume**(`params`): `Promise` Sets the output volume for the member (e.g., the speaker output level). @@ -917,7 +917,7 @@ await roomSession.setOutputVolume({ memberId: id, volume: -10 }); ### setPositions -▸ **setPositions**(`params`): `Promise` +- **setPositions**(`params`): `Promise` Assigns a position in the layout for multiple members. @@ -947,7 +947,7 @@ await roomSession.setPositions({ ### setPrioritizeHandraise -▸ **setPrioritizeHandraise**(`params`): `Promise` +- **setPrioritizeHandraise**(`params`): `Promise` Set whether to prioritize hand-raise or not. Users with raised hands will be shown in the main video area over other participants who don't have their hand raised. @@ -978,7 +978,7 @@ await room.setPrioritizeHandraise(false) ### setRaisedHand -▸ **setRaisedHand**(`params`): `Promise` +- **setRaisedHand**(`params`): `Promise` Sets the raised hand status for the current member. @@ -1014,7 +1014,7 @@ await room.setRaisedHand({ ### setSpeakerVolume -▸ **setSpeakerVolume**(`params`): `Promise` +- **setSpeakerVolume**(`params`): `Promise` > ⚠️ Deprecated. > Use [setOutputVolume][video-roomsession-6] instead. @@ -1036,7 +1036,7 @@ await room.setRaisedHand({ ### startRecording -▸ **startRecording**(): `Promise` - See [RoomSessionRecording][roomsessionrecording-5] for more details. +- **startRecording**(): `Promise` - See [RoomSessionRecording][roomsessionrecording-5] for more details. Starts the recording of the room. You can use the returned [RoomSessionRecording][roomsessionrecording-5] object to control the recording (e.g., pause, resume, stop). @@ -1055,7 +1055,7 @@ await rec.stop(); ### startStream -▸ **startStream**(): `Promise` - See [RoomSessionStream][roomsessionstream-4] for more details. +- **startStream**(): `Promise` - See [RoomSessionStream][roomsessionstream-4] for more details. Starts streaming the audio/video of this room to an external service. You can use the returned [RoomSessionStream][roomsessionstream-4] object to @@ -1085,7 +1085,7 @@ setTimeout(() => stream.stop(), 60000); ### subscribe -▸ **subscribe**(): `Promise` - See [RoomSessionFullState][roomsessionfullstate-2] for more details. +- **subscribe**(): `Promise` - See [RoomSessionFullState][roomsessionfullstate-2] for more details. Listens for the events for which you have provided event handlers and returns the [RoomSessionFullState][roomsessionfullstate-2] that contains the full state of the room session. @@ -1115,7 +1115,7 @@ client.video.on('room.started', async (roomSession) => { ### undeaf -▸ **undeaf**(`params`): `Promise` +- **undeaf**(`params`): `Promise` Unmutes the incoming audio for a given member. The affected participant will start hearing audio from the other participants again. @@ -1143,7 +1143,7 @@ await roomSession.undeaf({ memberId: id }); ### updateMemberMeta -▸ **updateMemberMeta**(`params`): `Promise` +- **updateMemberMeta**(`params`): `Promise` Updates a member's metadata in only the specified fields. This is different from [setMemberMeta][link-3], which replaces the whole metadata object. @@ -1185,7 +1185,7 @@ await roomSession.updateMemberMeta({ ### updateMeta -▸ **updateMeta**(`meta`): `Promise` +- **updateMeta**(`meta`): `Promise` Updates the RoomSession metadata by only setting the specified fields. This is different from [setMeta][link-4], which replaces the whole metadata object. @@ -1219,7 +1219,7 @@ await roomSession.updateMeta({ baz: false, t: 10 }); ### unlock -▸ **unlock**(`params`): `Promise` +- **unlock**(`params`): `Promise` Unlocks the room if it had been previously locked. This allows new participants to join the room. @@ -1237,7 +1237,7 @@ await roomSession.unlock(); ### videoMute -▸ **videoMute**(`params`): `Promise` +- **videoMute**(`params`): `Promise` Puts the video of a given member on mute. Participants will see a mute image instead of the video stream. @@ -1263,7 +1263,7 @@ await roomSession.videoMute({ memberId: id }); ### videoUnmute -▸ **videoUnmute**(`params`): `Promise` +- **videoUnmute**(`params`): `Promise` Unmutes the video of a given member if it had been previously muted. Participants will start seeing the video stream again. @@ -1362,7 +1362,7 @@ Each of the above events is emitted when the associated property changes. Your e ### room.audience_count -• **room.audience_count**(`e`) +- **room.audience_count**(`e`) This event is received periodically, and contains a total count of audience members. @@ -1381,7 +1381,7 @@ Audience members joining and leaving trigger this event. ### stream.ended -• **stream.ended**(`stream`) +- **stream.ended**(`stream`) A stream ended (e.g., it was stopped). @@ -1395,7 +1395,7 @@ A stream ended (e.g., it was stopped). ### stream.started -• **stream.started**(`stream`) +- **stream.started**(`stream`) A new stream started. diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/video/video-roomsessionstream.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/video/video-roomsessionstream.mdx index 4d4b01cfd..ef033268c 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/video/video-roomsessionstream.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/video/video-roomsessionstream.mdx @@ -15,7 +15,7 @@ You can start a stream with [RoomSession.startStream][video-roomsession]. ### duration -• `Optional` **duration**: `number` +- `Optional` **duration**: `number` Total seconds of time spent streaming, if available. This is equal to (`endedAt` - `startedAt`). @@ -23,7 +23,7 @@ Total seconds of time spent streaming, if available. This is equal to (`endedAt` ### endedAt -• `Optional` **endedAt**: `Date` +- `Optional` **endedAt**: `Date` End time, if available. @@ -31,7 +31,7 @@ End time, if available. ### id -• **id**: `string` +- **id**: `string` The unique id of this stream. @@ -39,7 +39,7 @@ The unique id of this stream. ### roomSessionId -• **roomSessionId**: `string` +- **roomSessionId**: `string` The id of the room session associated to this stream. @@ -47,7 +47,7 @@ The id of the room session associated to this stream. ### startedAt -• **startedAt**: `Date` +- **startedAt**: `Date` Start time, if available. @@ -55,7 +55,7 @@ Start time, if available. ### state -• **state**: `"streaming"` \| `"completed"` +- **state**: `"streaming"` \| `"completed"` Current state of the stream. @@ -63,7 +63,7 @@ Current state of the stream. ### url -• **url**: `string` +- **url**: `string` The RTMP URL of the stream. @@ -71,7 +71,7 @@ The RTMP URL of the stream. ### stop -▸ **stop**(): `Promise` +- **stop**(): `Promise` Stops the stream. diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callcollect.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callcollect.mdx index 8f2d1e093..99f1c05d1 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callcollect.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callcollect.mdx @@ -121,7 +121,7 @@ The type of this collect session. ### ended -▸ **ended**(): `Promise` - See [CallCollect][callcollect-5] for more details. +- **ended**(): `Promise` - See [CallCollect][callcollect-5] for more details. Returns a promise that is resolved only after this collect finishes (or is stopped). @@ -148,7 +148,7 @@ await collect.ended(); ### startInputTimers -▸ **startInputTimers**(): `Promise` - See [CallCollect][callcollect-5] for more details. +- **startInputTimers**(): `Promise` - See [CallCollect][callcollect-5] for more details. Start the `initialTimeout` timer on an active collect. @@ -177,7 +177,7 @@ await collect.startInputTimers(); ### stop -▸ **stop**(): `Promise` - See [CallCollect][callcollect-5] for more details. +- **stop**(): `Promise` - See [CallCollect][callcollect-5] for more details. Stops the collect session. diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/calldetect.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/calldetect.mdx index e59eef13b..086df9e43 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/calldetect.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/calldetect.mdx @@ -54,7 +54,7 @@ The result of the detecting session. ### ended -▸ **ended**(): `Promise` - See [CallDetectResult][calldetectresult-4] for more details. +- **ended**(): `Promise` - See [CallDetectResult][calldetectresult-4] for more details. Returns a promise which will get resolved only after the detecting session is completed. @@ -73,7 +73,7 @@ console.log("Detect result:", result.type); ### stop -▸ **stop**(): `Promise` - See [CallDetectResult][calldetectresult-4] for more details. +- **stop**(): `Promise` - See [CallDetectResult][calldetectresult-4] for more details. Stops the detect. @@ -90,7 +90,7 @@ await detect.stop(); ### ~~waitForResult~~ -▸ waitForResult(): `Promise` - See [CallDetectResult][calldetectresult-4] for more details. +- waitForResult(): `Promise` - See [CallDetectResult][calldetectresult-4] for more details. Returns a promise which will get resolved only after the detecting session is completed. diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callplayback.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callplayback.mdx index ec467bc97..be8b9f1f7 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callplayback.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callplayback.mdx @@ -56,7 +56,7 @@ The unique id for this playback. ### pause -▸ **pause**(): `Promise` - See [CallPlayback][callplayback-10] for more details. +- **pause**(): `Promise` - See [CallPlayback][callplayback-10] for more details. Pauses the playback. @@ -77,7 +77,7 @@ await playback.pause(); ### ended -▸ **ended**(): `Promise` - See [CallPlayback][callplayback-10] for more details. +- **ended**(): `Promise` - See [CallPlayback][callplayback-10] for more details. Returns a promise that is resolved only after this playback finishes playing (or is stopped). @@ -98,7 +98,7 @@ await playback.ended(); ### resume -▸ **resume**(): `Promise` - See [CallPlayback][callplayback-10] for more details. +- **resume**(): `Promise` - See [CallPlayback][callplayback-10] for more details. Resumes the playback if it was paused. @@ -119,7 +119,7 @@ await playback.resume(); ### setVolume -▸ **setVolume**(`volume`): `Promise` - See [CallPlayback][callplayback-10] for more details. +- **setVolume**(`volume`): `Promise` - See [CallPlayback][callplayback-10] for more details. Changes the volume of the playback. @@ -146,7 +146,7 @@ await playback.setVolume(-20); ### stop -▸ **stop**(): `Promise` - See [CallPlayback][callplayback-10] for more details. +- **stop**(): `Promise` - See [CallPlayback][callplayback-10] for more details. Stops the playback. @@ -167,7 +167,7 @@ await playback.stop(); ### ~~waitForEnded~~ -▸ **waitForEnded**(): `Promise` - See [CallPlayback][callplayback-10] for more details. +- **waitForEnded**(): `Promise` - See [CallPlayback][callplayback-10] for more details. Returns a promise that is resolved only after this playback finishes playing (or is stopped). diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callprompt.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callprompt.mdx index e33039fe3..9eeb37011 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callprompt.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callprompt.mdx @@ -125,7 +125,7 @@ The type of this prompt. ### ended -▸ **ended**(): `Promise` - See [CallPrompt][callprompt-6] for more details. +- **ended**(): `Promise` - See [CallPrompt][callprompt-6] for more details. Returns a promise that is resolved only after this prompt finishes (or is stopped). @@ -151,7 +151,7 @@ const { type, digits, terminator } = await prompt.ended(); ### setVolume -▸ **setVolume**(`volume`): `Promise` - See [CallPrompt][callprompt-6] for more details. +- **setVolume**(`volume`): `Promise` - See [CallPrompt][callprompt-6] for more details. Changes the volume of the audio. @@ -183,7 +183,7 @@ await prompt.setVolume(-20); ### stop -▸ **stop**(): `Promise` - See [CallPrompt][callprompt-6] for more details. +- **stop**(): `Promise` - See [CallPrompt][callprompt-6] for more details. Stops the prompt. @@ -209,7 +209,7 @@ await prompt.stop(); ### ~~waitForResult~~ -▸ **waitForResult**(): `Promise` - See [CallPrompt][callprompt-6] for more details. +- **waitForResult**(): `Promise` - See [CallPrompt][callprompt-6] for more details. Returns a promise that is resolved only after this prompt finishes (or is stopped). diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callrecording.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callrecording.mdx index d1e9f1925..da46f6098 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callrecording.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callrecording.mdx @@ -62,7 +62,7 @@ The unique id for this recording. ### pause -▸ **pause**(): `Promise` - See [CallRecording][callrecording-5] for more details. +- **pause**(): `Promise` - See [CallRecording][callrecording-5] for more details. Pauses the recording. @@ -84,7 +84,7 @@ await recording.pause(); ### resume -▸ **resume**(): `Promise` - See [CallRecording][callrecording-5] for more details. +- **resume**(): `Promise` - See [CallRecording][callrecording-5] for more details. Resumes the recording. @@ -102,7 +102,7 @@ await recording.resume(); ### stop -▸ **stop**(): `Promise` - See [CallRecording][callrecording-5] for more details. +- **stop**(): `Promise` - See [CallRecording][callrecording-5] for more details. Stops the recording. diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/calltap.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/calltap.mdx index 47c87ac1d..ed416ff16 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/calltap.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/calltap.mdx @@ -56,7 +56,7 @@ The unique id for this tapping. ### ended -▸ **ended**(): `Promise` - See [`CallTap`][calltap-3] for more details. +- **ended**(): `Promise` - See [`CallTap`][calltap-3] for more details. Returns a promise that is resolved only after this tap finishes (or is stopped). @@ -82,7 +82,7 @@ await tap.ended(); ### stop -▸ **stop**(): `Promise` - See [`CallTap`][calltap-3] for more details. +- **stop**(): `Promise` - See [`CallTap`][calltap-3] for more details. Stops the tapping. diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/voice-call.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/voice-call.mdx index 501c0ade4..ae72846b7 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/voice-call.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/voice-call.mdx @@ -121,13 +121,13 @@ client.on("call.received", async (call) => { ### device -• **device**: `any` +- **device**: `any` --- ### direction -• **direction**: `"inbound"` \| `"outbound"` +- **direction**: `"inbound"` \| `"outbound"` Whether you are making or receiving the call. @@ -135,7 +135,7 @@ Whether you are making or receiving the call. ### from -• **from**: `string` +- **from**: `string` The phone number that the call is coming from. @@ -143,13 +143,13 @@ The phone number that the call is coming from. ### headers -• `Optional` **headers**: [`SipHeader`][types][] +- `Optional` **headers**: [`SipHeader`][types][] --- ### id -• `Readonly` **id**: `string` +- `Readonly` **id**: `string` Unique id for this voice call @@ -157,7 +157,7 @@ Unique id for this voice call ### state -• **state**: `created` | `ringing` | `answered` | `ending` | `ended` +- **state**: `created` | `ringing` | `answered` | `ending` | `ended` The current state of the call. @@ -165,7 +165,7 @@ The current state of the call. ### to -• **to**: `string` +- **to**: `string` The phone number you are attempting to call. @@ -173,7 +173,7 @@ The phone number you are attempting to call. ### type -• **type**: `"phone"` \| `"sip"` +- **type**: `"phone"` \| `"sip"` The type of call. Only phone and sip are currently supported. @@ -181,7 +181,7 @@ The type of call. Only phone and sip are currently supported. ### amd -▸ **amd**(`params?`): `Promise` - See [CallDetect][calldetect-8] for more details. +- **amd**(`params?`): `Promise` - See [CallDetect][calldetect-8] for more details. Detects the presence of an answering machine. Alias for [detectAnsweringMachine][link]. @@ -189,7 +189,7 @@ Detects the presence of an answering machine. Alias for [detectAnsweringMachine] ### answer -▸ **answer**(): `Promise` - See [Call][call-19] for more details. +- **answer**(): `Promise` - See [Call][call-19] for more details. Answers the incoming call. @@ -298,7 +298,7 @@ const collect = await call.collect({ ### connect -▸ **connect**(`params`): `Promise` - See [Call][call-19] for more details. +- **connect**(`params`): `Promise` - See [Call][call-19] for more details. Attempt to connect an existing call to a new outbound call. The two devices will hear each other. You can wait until the new peer is disconnected by calling [disconnected][voice-call-3]. @@ -364,7 +364,7 @@ const peer = await call.connect({ ### connectPhone -▸ **connectPhone**(`params`): `Promise` - See [Call][call-19] for more details. +- **connectPhone**(`params`): `Promise` - See [Call][call-19] for more details. Attempt to connect an existing call to a new outbound phone call. The two devices will hear each other. You can wait until the new peer is disconnected by calling [disconnected][voice-call-3]. @@ -407,7 +407,7 @@ await call.playTTS({ text: "The peer disconnected" }); ### connectSip -▸ **connectSip**(`params`): `Promise` - See [Call][call-19] for more details. +- **connectSip**(`params`): `Promise` - See [Call][call-19] for more details. Attempt to connect an existing call to a new outbound SIP call. The two devices will hear each other. You can wait until the new peer is disconnected by calling [disconnected][voice-call-3]. @@ -458,7 +458,7 @@ await call.playTTS({ text: "The peer disconnected" }); ### detect -▸ **detect**(`params`): `Promise` - See [CallDetect][calldetect-8] for more details. +- **detect**(`params`): `Promise` - See [CallDetect][calldetect-8] for more details. Generic method. Please see [amd][link-2], [detectFax][link-3], [detectDigit][link-4]. @@ -477,7 +477,7 @@ Generic method. Please see [amd][link-2], [detectFax][link-3], [detectDigit][lin ### detectAnsweringMachine -▸ **detectAnsweringMachine**(`params?`): `Promise` - See [CallDetect][calldetect-8] for more details. +- **detectAnsweringMachine**(`params?`): `Promise` - See [CallDetect][calldetect-8] for more details. Detects the presence of an answering machine. @@ -511,7 +511,7 @@ console.log("Detect result:", result.type); ### detectDigit -▸ **detectDigit**(`params?`): `Promise` - See [CallDetect][calldetect-8] for more details. +- **detectDigit**(`params?`): `Promise` - See [CallDetect][calldetect-8] for more details. Detects when a digit is pressed in an audio stream. To gather digit input from a caller, please see [prompt][link-5]. @@ -541,7 +541,7 @@ console.log("Detect result:", result.type); ### detectFax -▸ **detectFax**(`params?`): `Promise` - See [CallDetect][calldetect-8] for more details. +- **detectFax**(`params?`): `Promise` - See [CallDetect][calldetect-8] for more details. Detects the presence of a fax machine. @@ -571,7 +571,7 @@ console.log("Detect result:", result.type); ### dial -▸ **dial**(`params`): `Promise` - See [Call][call-19] for more details. +- **dial**(`params`): `Promise` - See [Call][call-19] for more details. Create a new outbound call. @@ -591,7 +591,7 @@ This is a generic method that allows you to dial multiple devices in series, par ### disconnect -▸ **disconnect**(): `Promise` +- **disconnect**(): `Promise` #### Returns @@ -601,7 +601,7 @@ This is a generic method that allows you to dial multiple devices in series, par ### disconnected -▸ **disconnected**(): `Promise` - See [Call][call-19] for more details. +- **disconnected**(): `Promise` - See [Call][call-19] for more details. Call this method after connecting a peer (e.g., using [connect][link-6], [connectPhone][voice-call-4], or [connectSip][voice-call-5]) to wait until the @@ -635,7 +635,7 @@ await call.playTTS({ text: "The peer disconnected" }); ### hangup -▸ **hangup**(`reason?`): `Promise` +- **hangup**(`reason?`): `Promise` Hangs up the call. @@ -679,7 +679,7 @@ call.hangup(); ### pass -▸ **pass**(`params`): `Promise` - See [Call][call-19] for more details. +- **pass**(`params`): `Promise` - See [Call][call-19] for more details. This will allow a client to decline incoming calls without ending the call and redirect the call to another [Voice client][voice-client-1] @@ -701,7 +701,7 @@ client.on("call.received", async (call) => { ### play -▸ **play**(`params`): `Promise` - See [CallPlayback][callplayback-9] for more details. +- **play**(`params`): `Promise` - See [CallPlayback][callplayback-9] for more details. Play one or multiple media in a Call and waits until the playing has ended. @@ -733,7 +733,7 @@ await call.play( ### playAudio -▸ **playAudio**(`params`): `Promise` - See [CallPlayback][callplayback-9] for more details. +- **playAudio**(`params`): `Promise` - See [CallPlayback][callplayback-9] for more details. Plays an audio file. @@ -762,7 +762,7 @@ await playback.ended(); ### playRingtone -▸ **playRingtone**(`params`): `Promise` - See [CallPlayback][callplayback-9] for more details. +- **playRingtone**(`params`): `Promise` - See [CallPlayback][callplayback-9] for more details. Plays a ringtone. @@ -790,7 +790,7 @@ await playback.ended(); ### playSilence -▸ **playSilence**(`params`): `Promise` - See [CallPlayback][callplayback-9] for more details. +- **playSilence**(`params`): `Promise` - See [CallPlayback][callplayback-9] for more details. Plays some silence. @@ -816,7 +816,7 @@ await playback.ended(); ### playTTS -▸ **playTTS**(`params`): `Promise` - See [CallPlayback][callplayback-9] for more details. +- **playTTS**(`params`): `Promise` - See [CallPlayback][callplayback-9] for more details. Plays text-to-speech. @@ -866,7 +866,7 @@ await playback.ended(); ### prompt -▸ **prompt**(`params`): `Promise` - See [CallPrompt][callprompt-7] for more details. +- **prompt**(`params`): `Promise` - See [CallPrompt][callprompt-7] for more details. Generic method to prompt the user for input. Please see [promptAudio][voice-call], [promptRingtone][voice-call-1], [promptTTS][voice-call-2] for the more specific methods. @@ -950,7 +950,7 @@ const prompt = await call.prompt({ ### promptAudio -▸ **promptAudio**(`params`): `Promise` - See [CallPrompt][callprompt-7] for more details. +- **promptAudio**(`params`): `Promise` - See [CallPrompt][callprompt-7] for more details. Play an audio while collecting user input from the call, such as `digits` or `speech`. @@ -1026,7 +1026,7 @@ const prompt = await call.promptAudio({ ### promptRingtone -▸ **promptRingtone**(`params`): `Promise` - See [CallPrompt][callprompt-7] for more details. +- **promptRingtone**(`params`): `Promise` - See [CallPrompt][callprompt-7] for more details. Play a ringtone while collecting user input from the call, such as `digits` or `speech`. @@ -1106,7 +1106,7 @@ const prompt = await call.promptRingtone({ ### promptTTS -▸ **promptTTS**(`params`): `Promise` - See [CallPrompt][callprompt-7] for more details. +- **promptTTS**(`params`): `Promise` - See [CallPrompt][callprompt-7] for more details. Play text-to-speech while collecting user input from the call, such as `digits` or `speech`. @@ -1203,7 +1203,7 @@ const { type, speech, terminator } = await prompt.ended(); ### record -▸ **record**(`params`): `Promise` - See [CallRecording][callrecording-3] for more details. +- **record**(`params`): `Promise` - See [CallRecording][callrecording-3] for more details. Generic method to record a call. Please prefer using [recordAudio][link-7]. @@ -1222,7 +1222,7 @@ Generic method to record a call. Please prefer using [recordAudio][link-7]. ### recordAudio -▸ **recordAudio**(`params?`): `Promise` - See [CallRecording][callrecording-3] for more details. +- **recordAudio**(`params?`): `Promise` - See [CallRecording][callrecording-3] for more details. Records the audio from the call. @@ -1261,7 +1261,7 @@ await recording.stop(); ### sendDigits -▸ **sendDigits**(`digits`): `Promise` - See [Call][call-19] for more details. +- **sendDigits**(`digits`): `Promise` - See [Call][call-19] for more details. Play DTMF digits to the other party on the call. @@ -1285,7 +1285,7 @@ await call.sendDigits("123"); ### tap -▸ **tap**(`params`): `Promise` - See [CallTap][calltap-3] for more details. +- **tap**(`params`): `Promise` - See [CallTap][calltap-3] for more details. Intercept call media and stream it to the specified WebSocket endpoint. Prefer using [tapAudio][voice-call-10] if you only need to tap audio. @@ -1336,7 +1336,7 @@ await tap.stop(); ### tapAudio -▸ **tapAudio**(`params`): `Promise` - See [CallTap][calltap-3] for more details. +- **tapAudio**(`params`): `Promise` - See [CallTap][calltap-3] for more details. Intercept call audio and stream it to the specified WebSocket endpoint. @@ -1378,7 +1378,7 @@ await tap.stop(); ### waitFor -▸ **waitFor**(`params`): `Promise` +- **waitFor**(`params`): `Promise` Returns a promise that is resolved only after the current call is in one of the specified states. @@ -1404,7 +1404,7 @@ await call.waitFor("ended"); ### ~~waitForDisconnected~~ -▸ **waitForDisconnected**(): `Promise` - See [Call][call-19] for more details. +- **waitForDisconnected**(): `Promise` - See [Call][call-19] for more details. :::caution @@ -1416,7 +1416,7 @@ This method is deprecated. See [disconnected][link-8] instead. ### call.created -• **call.created**(`call`) +- **call.created**(`call`) A call was created. @@ -1428,7 +1428,7 @@ A call was created. ### call.ringing -• **call.ringing**(`call`) +- **call.ringing**(`call`) A call is ringing. @@ -1440,7 +1440,7 @@ A call is ringing. ### call.answered -• **call.answered**(`call`) +- **call.answered**(`call`) A call was answered. @@ -1452,7 +1452,7 @@ A call was answered. ### call.ending -• **call.ending**(`call`) +- **call.ending**(`call`) A call is ending. @@ -1464,7 +1464,7 @@ A call is ending. ### call.ended -• **call.ended**(`call`) +- **call.ended**(`call`) A call ended. @@ -1476,7 +1476,7 @@ A call ended. ### collect.ended -• **collect.ended**(`collect`) +- **collect.ended**(`collect`) A collect ended. @@ -1488,7 +1488,7 @@ A collect ended. ### collect.failed -• **collect.failed**(`collect`) +- **collect.failed**(`collect`) A collect failed. @@ -1500,7 +1500,7 @@ A collect failed. ### collect.startOfInput -• **collect.startOfInput**(`collect`) +- **collect.startOfInput**(`collect`) User input began in a collect. @@ -1512,7 +1512,7 @@ User input began in a collect. ### collect.started -• **collect.started**(`collect`) +- **collect.started**(`collect`) A collect started. @@ -1524,7 +1524,7 @@ A collect started. ### collect.updated -• **collect.updated**(`collect`) +- **collect.updated**(`collect`) The state of a collect changed. @@ -1536,7 +1536,7 @@ The state of a collect changed. ### playback.ended -• **playback.ended**(`playback`) +- **playback.ended**(`playback`) A playback ended. @@ -1550,7 +1550,7 @@ A playback ended. ### playback.started -• **playback.started**(`playback`) +- **playback.started**(`playback`) A playback has started. @@ -1564,7 +1564,7 @@ A playback has started. ### playback.updated -• **playback.updated**(`playback`) +- **playback.updated**(`playback`) The state of a playback changed. @@ -1578,7 +1578,7 @@ The state of a playback changed. ### prompt.ended -• **prompt.ended**(`prompt`) +- **prompt.ended**(`prompt`) A prompt has ended. @@ -1592,7 +1592,7 @@ A prompt has ended. ### prompt.failed -• **prompt.failed**(`prompt`) +- **prompt.failed**(`prompt`) A prompt has failed. @@ -1606,7 +1606,7 @@ A prompt has failed. ### prompt.started -• **prompt.started**(`prompt`) +- **prompt.started**(`prompt`) A prompt started. @@ -1620,7 +1620,7 @@ A prompt started. ### prompt.updated -• **prompt.updated**(`prompt`) +- **prompt.updated**(`prompt`) The state of a prompt changed. @@ -1634,7 +1634,7 @@ The state of a prompt changed. ### recording.ended -• **recording.ended**(`recording`) +- **recording.ended**(`recording`) A recording ended. @@ -1648,7 +1648,7 @@ A recording ended. ### recording.failed -• **recording.failed**(`recording`) +- **recording.failed**(`recording`) A recording failed. @@ -1662,7 +1662,7 @@ A recording failed. ### recording.started -• **recording.started**(`recording`) +- **recording.started**(`recording`) A recording started. @@ -1676,7 +1676,7 @@ A recording started. ### recording.updated -• **recording.updated**(`recording`) +- **recording.updated**(`recording`) The state of a recording changed. @@ -1690,7 +1690,7 @@ The state of a recording changed. ### tap.ended -• **tap.ended**(`tap`) +- **tap.ended**(`tap`) A tap ended. @@ -1704,7 +1704,7 @@ A tap ended. ### tap.started -• **tap.started**(`tap`) +- **tap.started**(`tap`) A tap started. diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/voice-client.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/voice-client.mdx index d7a115a5a..0bc5d3e06 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/voice-client.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/voice-client.mdx @@ -70,7 +70,7 @@ try { ### constructor -• **new Client**(`opts`) +- **new Client**(`opts`) #### Parameters @@ -87,7 +87,7 @@ try { ### dial -▸ **dial**(`dialer`): `Promise` - See [Call][call-5] for more details. +- **dial**(`dialer`): `Promise` - See [Call][call-5] for more details. Makes an outbound Call and waits until it has been answered or hung up. This is an advanced method that lets you call multiple devices in parallel or series: for simpler use cases, see [dialPhone][link-1] and [dialSip][link-2]. @@ -129,7 +129,7 @@ try { ### dialPhone -▸ **dialPhone**(`params`): `Promise` - See [Call][call-5] for more details. +- **dialPhone**(`params`): `Promise` - See [Call][call-5] for more details. Makes an outbound call to a PSTN number. @@ -167,7 +167,7 @@ try { ### dialSip -▸ **dialSip**(`params`): `Promise` - See [Call][call-5] for more details. +- **dialSip**(`params`): `Promise` - See [Call][call-5] for more details. Makes an outbound call to a SIP endpoint. @@ -213,7 +213,7 @@ try { ### disconnect -▸ **disconnect**(): `void` +- **disconnect**(): `void` Disconnects this client. The client will stop receiving events and you will need to create a new instance if you want to use it again. @@ -255,7 +255,7 @@ client.disconnect(); ### call.received -• **call.received**(`call`) +- **call.received**(`call`) A call has been received. You can use the provided Call object to answer.