Type alias RoomScopeV3

RoomScopeV3: {
    id?: string;
    name?: string;
} & {
    member?: {
        id?: string;
        name?: string;
    } & {
        methods: ("updateMetadata" | "publish" | "subscribe")[];
    } & {
        [k: string]: unknown;
    };
    methods: ("create" | "updateMetadata" | "close")[];
    sfu?: {
        enabled?: boolean;
        maxSubscribersLimit?: number;
    };
} & {
    [k: string]: unknown;
}

Type declaration

  • Optional id?: string
    • id または name のどちらかが必須。
    • id で対象の room を指定。
    • '*' を指定することで、すべての room を指定。
  • Optional name?: string
    • id または name のどちらかが必須。
    • name で対象の room を指定。
    • '*' を指定することで、すべての room を指定。

Type declaration

  • Optional member?: {
        id?: string;
        name?: string;
    } & {
        methods: ("updateMetadata" | "publish" | "subscribe")[];
    } & {
        [k: string]: unknown;
    }

    memberリソースに関するオブジェクトを指定

  • methods: ("create" | "updateMetadata" | "close")[]

    以下を複数指定可能

    • create: 作成
    • close: 削除
    • updateMetadata: metadata の編集
  • Optional sfu?: {
        enabled?: boolean;
        maxSubscribersLimit?: number;
    }
    • Optional enabled?: boolean

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

    • Optional maxSubscribersLimit?: number

      maxSubscribersの上限値の設定。指定しない場合はSFUサーバー側において設定可能な上限値になる。

Type declaration

  • [k: string]: unknown

Settings

Member Visibility

Theme