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

    Type Alias WhepClientViewRef

    A type that represents the ref to the WhepClientView component. It contains methods to control the WHEP client and Picture-in-Picture mode.

    type WhepClientViewRef = {
        cleanup: () => Promise<void>;
        connect: (ConnectOptions: any) => Promise<void>;
        createWhepClient: (
            configurationOptions: WhepConfigurationOptions,
            preferredVideoCodecs?: ReceiverVideoCodecName[],
            preferredAudioCodecs?: ReceiverAudioCodecName[],
        ) => Promise<void>;
        disconnect: () => Promise<void>;
        getSupportedReceiverAudioCodecsNames: () => Promise<
            ReceiverAudioCodecName[],
        >;
        getSupportedReceiverVideoCodecsNames: () => Promise<
            ReceiverVideoCodecName[],
        >;
        pause: () => Promise<void>;
        setPreferredReceiverAudioCodecs: (
            preferredCodecs: ReceiverAudioCodecName[],
        ) => Promise<void>;
        setPreferredReceiverVideoCodecs: (
            preferredCodecs: ReceiverVideoCodecName[],
        ) => Promise<void>;
        startPip: () => Promise<void>;
        stopPip: () => Promise<void>;
        togglePip: () => Promise<void>;
        unpause: () => Promise<void>;
    }
    Index

    Properties

    cleanup connect createWhepClient disconnect getSupportedReceiverAudioCodecsNames getSupportedReceiverVideoCodecsNames pause setPreferredReceiverAudioCodecs setPreferredReceiverVideoCodecs startPip stopPip togglePip unpause

    Properties

    cleanup: () => Promise<void>

    Cleanups WHEP client

    connect: (ConnectOptions: any) => Promise<void>

    Connects to the WHEP server.

    createWhepClient: (
        configurationOptions: WhepConfigurationOptions,
        preferredVideoCodecs?: ReceiverVideoCodecName[],
        preferredAudioCodecs?: ReceiverAudioCodecName[],
    ) => Promise<void>

    Creates a WHEP client with the given configuration.

    disconnect: () => Promise<void>

    Disconnects from the WHEP server.

    getSupportedReceiverAudioCodecsNames: () => Promise<ReceiverAudioCodecName[]>

    Gets supported receiver audio codec names.

    getSupportedReceiverVideoCodecsNames: () => Promise<ReceiverVideoCodecName[]>

    Gets supported receiver video codec names.

    pause: () => Promise<void>

    Pauses the WHEP client stream.

    setPreferredReceiverAudioCodecs: (
        preferredCodecs: ReceiverAudioCodecName[],
    ) => Promise<void>

    Sets preferred receiver audio codecs.

    setPreferredReceiverVideoCodecs: (
        preferredCodecs: ReceiverVideoCodecName[],
    ) => Promise<void>

    Sets preferred receiver video codecs.

    startPip: () => Promise<void>

    Starts the Picture-in-Picture mode. On android enters the Picture-in-Picture mode and background the app.

    stopPip: () => Promise<void>

    Stops the Picture-in-Picture mode. Does nothing on Android as PiP is not supported in foreground.

    togglePip: () => Promise<void>

    Toggles the Picture-in-Picture mode. On android enters the Picture-in-Picture mode and background the app.

    unpause: () => Promise<void>

    Unpauses the WHEP client stream.

    Settings

    Member Visibility

    On This Page

    Properties