react-native-whip-whep - v0.7.1
    Preparing search index...

    Type Alias WhipClientViewRef

    type WhipClientViewRef = {
        connect: (
            options: { authToken?: string; serverUrl: string },
        ) => Promise<void>;
        currentCameraDeviceId: () => Promise<string>;
        disconnect: () => Promise<void>;
        flipCamera: () => Promise<void>;
        getSupportedSenderAudioCodecsNames: () => Promise<SenderAudioCodecName[]>;
        getSupportedSenderVideoCodecsNames: () => Promise<SenderVideoCodecName[]>;
        initializeCamera: (
            options: WhipConfigurationOptions,
            videoDeviceId: CameraId,
        ) => Promise<void>;
        initializeScreenShare: (options: WhipConfigurationOptions) => Promise<void>;
        setPreferredSenderAudioCodecs: (
            preferredCodecs?: SenderAudioCodecName[],
        ) => Promise<void>;
        setPreferredSenderVideoCodecs: (
            preferredCodecs?: SenderVideoCodecName[],
        ) => Promise<void>;
        switchCamera: (deviceId: string) => Promise<void>;
    }
    Index

    Properties

    connect currentCameraDeviceId disconnect flipCamera getSupportedSenderAudioCodecsNames getSupportedSenderVideoCodecsNames initializeCamera initializeScreenShare setPreferredSenderAudioCodecs setPreferredSenderVideoCodecs switchCamera

    Properties

    connect: (options: { authToken?: string; serverUrl: string }) => Promise<void>
    currentCameraDeviceId: () => Promise<string>
    disconnect: () => Promise<void>
    flipCamera: () => Promise<void>
    getSupportedSenderAudioCodecsNames: () => Promise<SenderAudioCodecName[]>
    getSupportedSenderVideoCodecsNames: () => Promise<SenderVideoCodecName[]>
    initializeCamera: (
        options: WhipConfigurationOptions,
        videoDeviceId: CameraId,
    ) => Promise<void>

    Initializes the WHIP client with camera as the video source. This should be called before connecting to the server.

    initializeScreenShare: (options: WhipConfigurationOptions) => Promise<void>

    Initializes the WHIP client with screen sharing as the video source.

    iOS: Starts the IPC server and shows the broadcast picker to the user. The user must select the broadcast extension to start screen recording.

    Android: Creates the WHIP client, requests MediaProjection permission, and starts the foreground service. The user must grant permission via system dialog.

    setPreferredSenderAudioCodecs: (
        preferredCodecs?: SenderAudioCodecName[],
    ) => Promise<void>
    setPreferredSenderVideoCodecs: (
        preferredCodecs?: SenderVideoCodecName[],
    ) => Promise<void>
    switchCamera: (deviceId: string) => Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties