Class SFUBotMember

Hierarchy

  • MemberImpl
    • SFUBotMember

Implements

  • RemoteMemberImplInterface

Properties

channel context id name? onForwardingListChanged onForwardingStarted onForwardingStopped onLeft onMetadataUpdated options side subtype type subtype

Accessors

forwardings metadata publications state subscriptions

Methods

leave startForwarding stopForwarding updateMetadata

Properties

Readonlychannel

channel: SkyWayChannelImpl

Readonlycontext

context: SkyWayContext

Readonlyid

id: string

Optional Readonlyname

name?: string

ReadonlyonForwardingListChanged

onForwardingListChanged: Event<void> = ...

Description

[japanese] forwardingの数が変化した時に発火するイベント

ReadonlyonForwardingStarted

onForwardingStarted: Event<{
    forwarding: Forwarding;
}> = ...

Description

[japanese] forwardingを開始した時に発火するイベント

ReadonlyonForwardingStopped

onForwardingStopped: Event<{
    forwarding: Forwarding;
}> = ...

Description

[japanese] forwardingを終了した時に発火するイベント

ReadonlyonLeft

onLeft: Event<void>

Description

[japanese] Channelから離脱したときに発火するイベント

ReadonlyonMetadataUpdated

onMetadataUpdated: Event<string>

Description

[japanese] Metadataが変化したときに発火するイベント

Readonlyoptions

options: SFUBotPluginOptions

Readonlyside

side: "remote" = 'remote'

Readonlysubtype

subtype: "sfu" = SFUBotMember.subtype

Readonlytype

type: MemberType = 'bot'

Static Readonlysubtype

subtype: "sfu" = 'sfu'

Accessors

forwardings

metadata

  • get metadata(): undefined | string

  • Returns undefined | string

publications

  • get publications(): Publication<LocalStream>[]

  • Returns Publication<LocalStream>[]

    Description

    [japanese] このMemberのPublicationのリスト

state

  • get state(): MemberState

  • Returns MemberState

subscriptions

  • get subscriptions(): Subscription<RemoteStream>[]

  • Returns Subscription<RemoteStream>[]

    Description

    [japanese] このMemberのSubscriptionのリスト

Methods

leave

  • leave(): Promise<void>

  • Returns Promise<void>

    Throws

    SkyWayError

startForwarding

  • startForwarding(publication, configure?): Promise<Forwarding>

  • Parameters

    • publication: Publication<LocalAudioStream | LocalVideoStream | LocalCustomVideoStream>
    • configure: Partial<ForwardingConfigure> = {}

    Returns Promise<Forwarding>

    Description

    [japanese] StreamのPublicationをForwardingする

    Throws

    Example

    const forwarding = await bot.startForwarding(publication, { maxSubscribers: 99 });

stopForwarding

  • stopForwarding(target): Promise<void>

  • Parameters

    Returns Promise<void>

    Description

    [japanese] Forwardingを停止する

updateMetadata

  • updateMetadata(metadata): Promise<void>

  • Parameters

    • metadata: string

    Returns Promise<void>

    Description

    [japanese] metadataを更新する

Settings

Member Visibility

On This Page

Properties
Accessors
Methods