Type alias CustomSfuEvent

CustomSfuEvent: {
    attachments?: string;
    message?: string;
    name: string;
    sfuSinkId?: string;
    sfuStreamId?: string;
    timestamp?: number;
    transportId?: string;
    value?: string;
}

User provided custom call events

Type declaration

  • Optional attachments?: string

    Additional attachment relevant for the event

  • Optional message?: string

    the human readable message of the event

  • name: string

    the name of the event used as identifier. (e.g.: CLIENT_REJOINED, etc..)

  • Optional sfuSinkId?: string

    The identifier of the sfu sink the event is related to

  • Optional sfuStreamId?: string

    The identifier of the sfu stream the event is related to

  • Optional timestamp?: number

    The EPOCH timestamp the event is generated

  • Optional transportId?: string

    The unique identifier of the sfu transport the event is related to

  • Optional value?: string

    the value of the event

Settings

Member Visibility

Theme

Generated using TypeDoc