Open Play SDK API başvurusu
    Preparing search index...

    Interface PluginMessageDescriptor<Payload, TPluginId, TModuleId, TMessageType>

    Realtime payload descriptor'ı; connection join/input/on API'si bunu kullanır.

    interface PluginMessageDescriptor<
        Payload = unknown,
        TPluginId extends string = string,
        TModuleId extends string = string,
        TMessageType extends string = string,
    > {
        burst?: number;
        codec?: PluginCodec;
        delivery: "strict_input" | "latest_state" | "best_effort_signal";
        maxBytes?: number;
        messageType: TMessageType;
        moduleId: TModuleId;
        payloadType?: Payload;
        pluginId: TPluginId;
        ratePerSecond?: number;
        schema: string;
        schemaVersion: number;
    }

    Type Parameters

    • Payload = unknown
    • TPluginId extends string = string
    • TModuleId extends string = string
    • TMessageType extends string = string
    Index

    Properties

    burst? codec? delivery maxBytes? messageType moduleId payloadType? pluginId ratePerSecond? schema schemaVersion

    Properties

    burst?: number

    Host burst metadata'sı.

    codec?: PluginCodec

    Aynı plugin binding'in schema-aware codec'i; realtime decoder bunu kullanır.

    delivery: "strict_input" | "latest_state" | "best_effort_signal"

    Delivery sınıfı.

    maxBytes?: number

    Host payload üst sınırı; descriptor verilmezse host default'u uygulanır.

    messageType: TMessageType

    Wire message type.

    moduleId: TModuleId

    Module kimliği.

    payloadType?: Payload

    Compile-time payload markası; runtime'da veri tutmaz.

    pluginId: TPluginId

    Plugin namespace.

    ratePerSecond?: number

    Host steady-state rate metadata'sı.

    schema: string

    Payload schema bileşen adı.

    schemaVersion: number

    Schema version.

    Settings

    Member Visibility

    On This Page

    Properties