OpenVidu Browser - v2.32.2
    Preparing search index...

    Interface SignalOptions

    See Session.signal

    interface SignalOptions {
        data?: string;
        to?: Connection[];
        type?: string;
    }
    Index

    Properties

    data? to? type?

    Properties

    data?: string

    The actual message of the signal.

    to?: Connection[]

    The participants to whom to send the signal. They will only receive it if they are subscribed to event Session.on('signal'). If empty or undefined, the signal will be send to all participants.

    type?: string

    The type of the signal. Participants subscribed to event Session.on('signal:type') will receive it. Participants subscribed to Session.on('signal') will receive all signals.

    Settings

    Member Visibility

    On This Page

    Properties