Zoom Video SDK for React - v0.0.2
    Preparing search index...

    Function useSession

    • Hook to join a Zoom Video SDK session

      This hook handles the complete lifecycle of a Zoom video session including:

      • Session initialization and connection
      • Audio/video stream initialization
      • Connection state monitoring
      • Automatic cleanup on unmount

      Parameters

      • topic: string

        The session topic to join

      • token: string

        JWT token for authentication

      • userName: string

        Display name for the user in the session

      • OptionalsessionPassword: string

        Optional password for the session

      • OptionalsessionIdleTimeoutMins: number

        Optional timeout for idle sessions

      • OptionalsessionOptions: SessionOptions

        Optional configuration for session behavior

      Returns {
          error: ExecutedFailure | null;
          isError: boolean;
          isInSession: boolean;
          isLoading: boolean;
      }

      Object containing session state and error information

      const { isInSession, isLoading, isError, error } = useSession(
      "session123",
      "jwt_token_here",
      "John Doe",
      undefined,
      30,
      {
      disableVideo: false,
      disableAudio: false,
      language: "en-US"
      }
      );