@zoom/videosdk/dist/types/preview.d.ts

Zoom Web Video SDK

import { MobileVideoFacingMode, VideoPlayer } from './common';

/**
 * Interface for test speaker options.
 */
interface TestSpeakerOption {
  /**
   * The speaker ID. If not specified, the SDK uses the default speaker.
   */
  speakerId?: string;
  /**
   * The sample audio file to play, usually an mp3 file. If not specified, the SDK uses the ring audio.
   */
  sampleAudioUrl?: string;
  /**
   * The average frequency of the stream, usually used to create audio visualization.
   */
  onAnalyseFrequency?: (averageFrequency: number) => void;
}
/**
 * Interface for the test speaker return.
 */
interface TestSpeakerReturn {
  /**
   * Stops the tester.
   */
  stop: () => void;
  /**
   *  Destroys the tester.
   */
  destroy: () => void;
}
/**
 * Interface for test microphone options.
 */
interface TestMicrophoneOption {
  /**
   * The microphone ID. If not specified, the SDK uses the default microphone.
   */
  microphoneId?: string;
  /**
   *  The speaker ID. The Speaker to play the recording.
   */
  speakerId?: string;
  /**
   * Whether the user needs to record and play an audio fragment to test the microphone.
   */
  recordAndPlay?: boolean;
  /**
   * The maximum seconds to record, the user needs to record. Default is 10 seconds.
   */
  maxRecordDuration?: number;
  /**
   * The average frequency of the stream, usually used to create audio visualization.
   */
  onAnalyseFrequency?: (averageFrequency: number) => void;
  /**
   * When to start recording.
   */
  onStartRecording?: () => void;
  /**
   * When to stop recording.
   */
  onStopRecording?: () => void;
  /**
   * When to start playing the recording.
   */
  onStartPlayRecording?: () => void;
  /**
   * When to stop playing the recording.
   */
  onStopPlayRecording?: () => void;
}
/**
 * Interface for the test microphone return.
 */
interface TestMicrophoneReturn {
  /**
   * Stops the tester.
   */
  stop: () => void;
  /**
   * Stops recording audio.
   */
  stopRecording: () => void;
  /**
   *  Destroys the tester.
   */
  destroy: () => void;
}
/**
 * Interface for starting or stopping local video capture.
 */
export interface LocalVideoTrack {
  /**
   * Starts local video capture and plays it back.
   *
   * @param previewDOMElement Video DOM element that will contain the video playback. Canvas and VideoPlayer Element will contain the video with virtual background. We recommend you use the VideoPlayer Element.
   * @param virtualBackground virtual background setting
   */
  start(
    previewDOMElement: VideoPlayer | HTMLVideoElement | HTMLCanvasElement,
    virtualBackground?: {
      /**
       * Image URL for the virtual background.
       * - If set to a specific image, the URL can be a regular HTTP or HTTPS URL, base64 format, or ObjectURL.
       * - 'blur' : Blurs the background.
       * - undefined : no virtual background.
       */
      imageUrl: string;
      /**
       * Determines whether to crop the background image to an appropriate aspect ratio (16/9), default is false.
       */
      cropped?: boolean;
    },
  ): Promise<void | Error>;
  /**
   * Stops local video capture.
   */
  stop(): Promise<void | Error>;
  /**
   * Switch camera.
   * @param deviceId The ID of the camera to switch to or on mobile platform, using facingMode instead.
   */
  switchCamera(deviceId: string | MobileVideoFacingMode): Promise<void | Error>;
  /**
   * Update the preview virtual background image.
   * @param imageUrl Image URL for the virtual background.
   * @param cropped Determines whether to crop the background image to an appropriate aspect ratio (16/9), default is false.
   */
  updateVirtualBackground(
    imageUrl?: string,
    cropped?: boolean,
  ): Promise<void | Error>;
}
/**
 * Interface for managing local audio capture.
 */
export interface LocalAudioTrack {
  /**
   * Starts local audio capture with microphone muted.
   */
  start(): Promise<void | Error>;
  /**
   * Unmutes microphone if audio was started, and microphone is not already unmuted.
   */
  unmute(): Promise<void | Error>;
  /**
   * Mutes microphone if audio was started, and microphone is not already muted.
   */
  mute(): Promise<void | Error>;
  /**
   * Returns the current volume of the local input device.
   */
  getCurrentVolume(): number;
  /**
   * Stops local audio capture.
   */
  stop(): Promise<void | Error>;
  /**
   * Tests the speaker, usually used to test the speaker before a meeting.
   * @param options The test speaker option.
   */
  testSpeaker(options?: TestSpeakerOption): TestSpeakerReturn | undefined;
  /**
     Tests the microphone, usually used to test the microphone before a meeting. 
     * @param options the test microphone option.
     */
  testMicrophone(options?: TestMicrophoneOption): TestMicrophoneReturn | undefined;
}