ZoomRtmsInputConfig
Configuration options for the ZoomRtmsInput provider.
Defined in: src/providers/io/zoom/ZoomRtmsInput.ts:170
Configuration options for the ZoomRtmsInput provider.
Remarks
clientId and clientSecret are the credentials of the Zoom app that has RTMS enabled. They are used to compute the handshake HMAC signature, so this provider must only run server-side — never expose the client secret to a browser.
Session parameters (meetingUuid, rtmsStreamId, serverUrl) may be provided here when known ahead of time, or per-call via connect() — the usual pattern, since they arrive with each meeting.rtms_started webhook.
Example
const config: ZoomRtmsInputConfig = {
clientId: process.env.ZOOM_CLIENT_ID!,
clientSecret: process.env.ZOOM_CLIENT_SECRET!,
sampleRate: 16000,
dataOpt: 'mixed',
};
See
ZoomRtmsInput for the provider class
Properties
| Property | Type | Default value | Description | Defined in |
|---|---|---|---|---|
clientId | string | undefined | Zoom app client ID (used in the HMAC signature message). | src/providers/io/zoom/ZoomRtmsInput.ts:172 |
clientSecret | string | undefined | Zoom app client secret (HMAC signing key). Remarks Server-side only. The signature is hex(HMAC-SHA256("clientId,meetingUuid,rtmsStreamId", clientSecret)). | src/providers/io/zoom/ZoomRtmsInput.ts:180 |
connectionTimeout? | number | 10000 | Timeout in milliseconds for each connection/handshake step. | src/providers/io/zoom/ZoomRtmsInput.ts:204 |
dataOpt? | ZoomRtmsDataOption | 'mixed' | Stream layout: one mixed stream or one stream per participant. | src/providers/io/zoom/ZoomRtmsInput.ts:198 |
debug? | boolean | false | Enable diagnostic logging. | src/providers/io/zoom/ZoomRtmsInput.ts:210 |
meetingUuid? | string | undefined | Meeting UUID, if known up-front. Usually supplied via connect(). | src/providers/io/zoom/ZoomRtmsInput.ts:182 |
rtmsStreamId? | string | undefined | RTMS stream ID, if known up-front. Usually supplied via connect(). | src/providers/io/zoom/ZoomRtmsInput.ts:184 |
sampleRate? | ZoomRtmsSampleRate | 16000 | Audio sample rate to request from RTMS. | src/providers/io/zoom/ZoomRtmsInput.ts:192 |
serverUrl? | string | undefined | Signaling server URL, if known up-front. Usually supplied via connect(). | src/providers/io/zoom/ZoomRtmsInput.ts:186 |