@skyway-sdk/sfu-bot
Version:
The official Next Generation JavaScript SDK for SkyWay
28 lines • 1.42 kB
TypeScript
import { Channel, SkyWayChannelImpl, SkyWayPlugin } from '@skyway-sdk/core';
import model from '@skyway-sdk/model';
import { SfuApiOptions } from '@skyway-sdk/sfu-api-client';
import { TransportRepository } from './connection/transport/transportRepository';
import { SfuBotMember } from './member';
import { SfuBotPluginOptions as SfuBotPluginOptions } from './option';
export type { SfuApiOptions };
export declare class SfuBotPlugin extends SkyWayPlugin {
static readonly subtype = "sfu";
readonly subtype = "sfu";
readonly options: SfuBotPluginOptions;
private _api;
/**@private */
_transportRepository: TransportRepository;
constructor(_options?: Partial<SfuBotPluginOptions>);
/**@private */
_createRemoteMember: (channel: SkyWayChannelImpl, sfuBot: model.Member) => SfuBotMember;
/**
* @description [japanese] SFU BotをChannelに呼び出す
*/
createBot: (channel: Channel) => Promise<SfuBotMember>;
/**
* @description [japanese] SFU BotをChannelから削除する。
* @remarks SkyWayAuthToken v3 を利用した場合はこのメソッドを使うことができません。代替手段として Channel.leave メソッドまたは Member.leave メソッドを使用して SFU Bot を Channel から退出させてください。
*/
deleteBot: (channel: Channel, botId: string) => Promise<void>;
}
//# sourceMappingURL=plugin.d.ts.map