Type alias ScopeV3

ScopeV3: objectInputType<{
    analytics: ZodOptional<ZodObject<{
        enabled: ZodOptional<ZodBoolean>;
    }, "strip", ZodTypeAny, {
        enabled?: boolean;
    }, {
        enabled?: boolean;
    }>>;
    appId: ZodString;
    rooms: ZodArray<ZodIntersection<ZodEffects<ZodObject<{
        id: ZodOptional<ZodString>;
        name: ZodOptional<ZodString>;
    }, "strip", ZodTypeAny, {
        id?: string;
        name?: string;
    }, {
        id?: string;
        name?: string;
    }>, {
        id?: string;
        name?: string;
    }, {
        id?: string;
        name?: string;
    }>, ZodObject<{
        member: ZodOptional<ZodIntersection<ZodEffects<ZodObject<{
            id: ...;
            name: ...;
        }, "strip", ZodTypeAny, {
            id?: ...;
            name?: ...;
        }, {
            id?: ...;
            name?: ...;
        }>, {
            id?: (...) | (...);
            name?: (...) | (...);
        }, {
            id?: (...) | (...);
            name?: (...) | (...);
        }>, ZodObject<{
            methods: ZodArray<(...), (...)>;
        }, "passthrough", ZodTypeAny, objectOutputType<{
            methods: ...;
        }, ZodTypeAny, "passthrough">, objectInputType<{
            methods: ...;
        }, ZodTypeAny, "passthrough">>>>;
        methods: ZodArray<ZodEffects<ZodEnum<["create", "close", "updateMetadata"]>, "create" | "updateMetadata" | "close", "create" | "updateMetadata" | "close">, "many">;
        sfu: ZodOptional<ZodObject<{
            enabled: ZodOptional<ZodBoolean>;
            maxSubscribersLimit: ZodOptional<ZodNumber>;
        }, "strip", ZodTypeAny, {
            enabled?: boolean;
            maxSubscribersLimit?: number;
        }, {
            enabled?: boolean;
            maxSubscribersLimit?: number;
        }>>;
    }, "passthrough", ZodTypeAny, objectOutputType<{
        member: ZodOptional<ZodIntersection<ZodEffects<ZodObject<(...), (...), (...), (...), (...)>, {
            id?: ...;
            name?: ...;
        }, {
            id?: ...;
            name?: ...;
        }>, ZodObject<{
            methods: ...;
        }, "passthrough", ZodTypeAny, objectOutputType<(...), (...), (...)>, objectInputType<(...), (...), (...)>>>>;
        methods: ZodArray<ZodEffects<ZodEnum<[(...), (...), (...)]>, "create" | "updateMetadata" | "close", "create" | "updateMetadata" | "close">, "many">;
        sfu: ZodOptional<ZodObject<{
            enabled: ZodOptional<(...)>;
            maxSubscribersLimit: ZodOptional<(...)>;
        }, "strip", ZodTypeAny, {
            enabled?: (...) | (...) | (...);
            maxSubscribersLimit?: (...) | (...);
        }, {
            enabled?: (...) | (...) | (...);
            maxSubscribersLimit?: (...) | (...);
        }>>;
    }, ZodTypeAny, "passthrough">, objectInputType<{
        member: ZodOptional<ZodIntersection<ZodEffects<ZodObject<(...), (...), (...), (...), (...)>, {
            id?: ...;
            name?: ...;
        }, {
            id?: ...;
            name?: ...;
        }>, ZodObject<{
            methods: ...;
        }, "passthrough", ZodTypeAny, objectOutputType<(...), (...), (...)>, objectInputType<(...), (...), (...)>>>>;
        methods: ZodArray<ZodEffects<ZodEnum<[(...), (...), (...)]>, "create" | "updateMetadata" | "close", "create" | "updateMetadata" | "close">, "many">;
        sfu: ZodOptional<ZodObject<{
            enabled: ZodOptional<(...)>;
            maxSubscribersLimit: ZodOptional<(...)>;
        }, "strip", ZodTypeAny, {
            enabled?: (...) | (...) | (...);
            maxSubscribersLimit?: (...) | (...);
        }, {
            enabled?: (...) | (...) | (...);
            maxSubscribersLimit?: (...) | (...);
        }>>;
    }, ZodTypeAny, "passthrough">>>, "many">;
    turn: ZodOptional<ZodObject<{
        enabled: ZodOptional<ZodBoolean>;
    }, "strip", ZodTypeAny, {
        enabled?: boolean;
    }, {
        enabled?: boolean;
    }>>;
}, ZodTypeAny, "passthrough">

Type declaration

  • analytics: ZodOptional<ZodObject<{
        enabled: ZodOptional<ZodBoolean>;
    }, "strip", ZodTypeAny, {
        enabled?: boolean;
    }, {
        enabled?: boolean;
    }>>

    AnalyticsDashboardへのデータ送信をするかどうかの設定。指定しない場合は enabled: true として扱われる。

  • appId: ZodString

    アプリケーションIDを指定

  • rooms: ZodArray<ZodIntersection<ZodEffects<ZodObject<{
        id: ZodOptional<ZodString>;
        name: ZodOptional<ZodString>;
    }, "strip", ZodTypeAny, {
        id?: string;
        name?: string;
    }, {
        id?: string;
        name?: string;
    }>, {
        id?: string;
        name?: string;
    }, {
        id?: string;
        name?: string;
    }>, ZodObject<{
        member: ZodOptional<ZodIntersection<ZodEffects<ZodObject<{
            id: ...;
            name: ...;
        }, "strip", ZodTypeAny, {
            id?: ...;
            name?: ...;
        }, {
            id?: ...;
            name?: ...;
        }>, {
            id?: (...) | (...);
            name?: (...) | (...);
        }, {
            id?: (...) | (...);
            name?: (...) | (...);
        }>, ZodObject<{
            methods: ZodArray<(...), (...)>;
        }, "passthrough", ZodTypeAny, objectOutputType<{
            methods: ...;
        }, ZodTypeAny, "passthrough">, objectInputType<{
            methods: ...;
        }, ZodTypeAny, "passthrough">>>>;
        methods: ZodArray<ZodEffects<ZodEnum<["create", "close", "updateMetadata"]>, "create" | "updateMetadata" | "close", "create" | "updateMetadata" | "close">, "many">;
        sfu: ZodOptional<ZodObject<{
            enabled: ZodOptional<ZodBoolean>;
            maxSubscribersLimit: ZodOptional<ZodNumber>;
        }, "strip", ZodTypeAny, {
            enabled?: boolean;
            maxSubscribersLimit?: number;
        }, {
            enabled?: boolean;
            maxSubscribersLimit?: number;
        }>>;
    }, "passthrough", ZodTypeAny, objectOutputType<{
        member: ZodOptional<ZodIntersection<ZodEffects<ZodObject<(...), (...), (...), (...), (...)>, {
            id?: ...;
            name?: ...;
        }, {
            id?: ...;
            name?: ...;
        }>, ZodObject<{
            methods: ...;
        }, "passthrough", ZodTypeAny, objectOutputType<(...), (...), (...)>, objectInputType<(...), (...), (...)>>>>;
        methods: ZodArray<ZodEffects<ZodEnum<[(...), (...), (...)]>, "create" | "updateMetadata" | "close", "create" | "updateMetadata" | "close">, "many">;
        sfu: ZodOptional<ZodObject<{
            enabled: ZodOptional<(...)>;
            maxSubscribersLimit: ZodOptional<(...)>;
        }, "strip", ZodTypeAny, {
            enabled?: (...) | (...) | (...);
            maxSubscribersLimit?: (...) | (...);
        }, {
            enabled?: (...) | (...) | (...);
            maxSubscribersLimit?: (...) | (...);
        }>>;
    }, ZodTypeAny, "passthrough">, objectInputType<{
        member: ZodOptional<ZodIntersection<ZodEffects<ZodObject<(...), (...), (...), (...), (...)>, {
            id?: ...;
            name?: ...;
        }, {
            id?: ...;
            name?: ...;
        }>, ZodObject<{
            methods: ...;
        }, "passthrough", ZodTypeAny, objectOutputType<(...), (...), (...)>, objectInputType<(...), (...), (...)>>>>;
        methods: ZodArray<ZodEffects<ZodEnum<[(...), (...), (...)]>, "create" | "updateMetadata" | "close", "create" | "updateMetadata" | "close">, "many">;
        sfu: ZodOptional<ZodObject<{
            enabled: ZodOptional<(...)>;
            maxSubscribersLimit: ZodOptional<(...)>;
        }, "strip", ZodTypeAny, {
            enabled?: (...) | (...) | (...);
            maxSubscribersLimit?: (...) | (...);
        }, {
            enabled?: (...) | (...) | (...);
            maxSubscribersLimit?: (...) | (...);
        }>>;
    }, ZodTypeAny, "passthrough">>>, "many">

    roomリソースに関するオブジェクトを配列で指定

  • turn: ZodOptional<ZodObject<{
        enabled: ZodOptional<ZodBoolean>;
    }, "strip", ZodTypeAny, {
        enabled?: boolean;
    }, {
        enabled?: boolean;
    }>>

    TURNサーバー利用の設定。enabledがfalseの場合はTURNサーバーを経由してメディア通信を行わない。指定しない場合は enabled: true として扱われる。