Function join

join(options: JoinParams): boolean
Joins a Zoom RTMS session using the global client

This function is part of the singleton API, which provides a simplified interface for connecting to a single Zoom meeting. It handles initialization and starts background polling for events.
Parameters
- options: JoinParams
  An object containing join parameters
Returns boolean
true if the join operation succeeds
Example
```
// Join with parameters object
rtms.join({
  meeting_uuid: "meeting_uuid_here",
  rtms_stream_id: "stream_id_here",
  server_urls: "wss://rtms.zoom.us",
  pollInterval: 10
});
```
- Defined in rtms.d.ts:912
join(
    meetingUuid: string,
    rtmsStreamId: string,
    signature: string,
    serverUrls: string,
    timeout?: number,
): boolean
Joins a Zoom RTMS session using the global client

This function is part of the singleton API. It establishes a connection to a Zoom RTMS stream using the global client.
Parameters
- meetingUuid: string
  The UUID of the Zoom meeting
- rtmsStreamId: string
  The RTMS stream ID for this connection
- signature: string
  The authentication signature
- serverUrls: string
  The server URL(s) to connect to
- Optionaltimeout: number
  The timeout for the join operation in milliseconds
Returns boolean
true if the join operation succeeds
Example
```
// Generate signature
const signature = rtms.generateSignature({
  client: "client_id",
  secret: "client_secret",
  uuid: "meeting_uuid",
  streamId: "stream_id"
});

// Join with explicit parameters
rtms.join(
  "meeting_uuid",
  "stream_id",
  signature,
  "wss://rtms.zoom.us"
);
```
- Defined in rtms.d.ts:948

Function join

Parameters

Returns boolean

Example

Parameters

Returns boolean

Example

Settings